org.newsml.toolkit
Interface AdministrativeMetadata

All Superinterfaces:

BaseNode, CatalogNode, IdNode, PropertyNode

public interface AdministrativeMetadata

extends BaseNode, CatalogNode, IdNode, PropertyNode

Information about the provenance of a NewsComponent or NewsItem.

The administrative information includes the provider, creator, and contributors to the component, among other information.

The NewsML specification is not always clear about the applicability of this information: it states that the information applies either to the parent news component or to an ancestor news item, with no clear rules for distinguishing the two except what can be inferred from documentation for the individual properties; users are advised to use great care with the information in this interface, until the IPTC clarifies the rules.

Version:

2.0

Author:

Reuters PLC

Method Summary

PartyList[]	getContributor() Get an array of contributor party lists in this object.
PartyList	getContributor(int index) Get a list of contributors to a news object.
int	getContributorCount() Get the number of contributor lists.
PartyList	getCreator() Get a list of creators of a news object.
IdText	getFileName() Get the suggested file name for the news item.
PartyList	getProvider() Get a list of providers of a news object.
SourceList[]	getSource() Get an array of source party lists in this object.
SourceList	getSource(int index) Get a list of parties providing source material for a news object.
int	getSourceCount() Get the number of source lists provided.
IdText	getSystemIdentifier() Get the system identifier of the news item.

Methods inherited from interface org.newsml.toolkit.BaseNode

getAttr, getChild, getChild, getChild, getChild, getChildCount, getChildCount, getParent, getPath, getSession, getXMLName, getXPath, insertAfter, insertAfter, insertAfter, insertAfter, insertAfterDuid, insertAfterDuid, insertBefore, insertBefore, insertBefore, insertBefore, insertBeforeDuid, insertBeforeDuid, insertChild, insertChild, insertFirst, insertFirst, insertLast, insertLast, removeChild, removeChild, removeSelf, replaceChild, replaceChild, replaceChild, replaceChild, replaceChild, replaceChild, setAttr, setAttr, toXML, toXML, unsetAttr, unsetAttr, writeXML, writeXML

Methods inherited from interface org.newsml.toolkit.CatalogNode

getCatalog

Methods inherited from interface org.newsml.toolkit.IdNode

getDuid, getEuid

Methods inherited from interface org.newsml.toolkit.PropertyNode

getProperty, getProperty, getPropertyCount

Method Detail

getFileName

public IdText getFileName()

Get the suggested file name for the news item.

The NewsML documentation implies that this property applies the ancestor news item rather than to the parent news component.

Returns:

The suggested file name as a text node.

getSystemIdentifier

public IdText getSystemIdentifier()

Get the system identifier of the news item.

The NewsML documentation implies that this property applies to the ancestor news item rather than to the parent news component.

A system identifier is simply a relative or absolute URI without a '#' part. The NewsML specification does not state the purpose of this identifier: it may be intended to provide a URL where a normative version of the news item may be found for comparison to the one transmitted in the NewsML package.

Returns:

The system identifier as a text node.

getProvider

public PartyList getProvider()

Get a list of providers of a news object.

The NewsML documentation does not state whether this property applies to the parent news component or to the ancestor news item.

Returns:

A list of parties representing the providers, or null if the NewsML document did not list any.

getCreator

public PartyList getCreator()

Get a list of creators of a news object.

The NewsML documentation does not state whether this property applies to the parent news component or to the ancestor news item.

Returns:

A list of parties representing the creators, or null if the NewsML document did not provide any.

getSourceCount

public int getSourceCount()

Get the number of source lists provided.

Returns:

The number of source lists.

getSource

public SourceList getSource(int index)

Get a list of parties providing source material for a news object.

The NewsML documentation does not state whether this property applies to the parent news component or to the ancestor news item.

Parameters:

index - The index of the source list, zero-based, numbered sequentially.

Returns:

A list of parties, or if the NewsML document did not include any at the specified index.

See Also:

getSourceCount()

getSource

public SourceList[] getSource()

Get an array of source party lists in this object.

Returns:

A (possibly-empty) array of source party lists.

getContributorCount

public int getContributorCount()

Get the number of contributor lists.

Returns:

The number of contributor lists.

getContributor

public PartyList getContributor(int index)

Get a list of contributors to a news object.

The NewsML documentation does not state whether this property applies to the parent news component or to the ancestor news item.

Parameters:

index - The index of the contributors list, zero-based, in document order.

Returns:

A list of parties, or null if the NewsML document did not include any at the specified index.

See Also:

getContributorCount()

getContributor

public PartyList[] getContributor()

Get an array of contributor party lists in this object.

Returns:

A (possibly-empty) array of contributor party lists.