|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Container for specifying role information and metadata for news objects.
A news component is a branch in the NewsML content tree. A news
component may contain zero or more members, and the members may
function as complements or equivalents (see the isEquivalentsList()
method).
A member of a NewsComponent may be a NewsItem
, a reference to a NewsItem, another
NewsComponent
, or a ContentItem
. If a news
component has more than one member and they are flagged as
equivalents, then the getBasisForChoice(int)
method specifies
the criteria for choosing among the alternatives. It is also
possible to have a NewsComponent with no members (say, to transmit
NewsLines
alone).
Fields inherited from interface org.newsml.toolkit.PrimaryNode |
CONTENT_ITEM, NEWS_COMPONENT, NEWS_ITEM, NEWS_ITEM_REF, NEWSML |
Method Summary | |
AdministrativeMetadata |
getAdministrativeMetadata()
Get administrative information for the news component. |
BasisForChoice[] |
getBasisForChoice()
Get all BasisForChoice children in an array. |
BasisForChoice |
getBasisForChoice(int index)
Get the basis for choosing among equivalent members. |
int |
getBasisForChoiceCount()
Get the number of bases for choice. |
DescriptiveMetadata |
getDescriptiveMetadata()
Get descriptive information about the news component. |
PrimaryNode[] |
getMember()
Get all Member children in an array. |
PrimaryNode |
getMember(int index)
Return one of the members of this news component. |
int |
getMemberCount()
Get the number of members in this news component. |
Metadata[] |
getMetadata()
Get all Metadata children in an array. |
Metadata |
getMetadata(int index)
Get generic metadata about the news component. |
int |
getMetadataCount()
Get the number of generic metadata objects present. |
NewsLines |
getNewsLines()
Get a news component's headline, byline, etc. |
RightsMetadata |
getRightsMetadata()
Get rights information for the news component. |
FormalName |
getRole()
Get the role of this component in a parent component. |
TopicSet[] |
getTopicSet()
Get all TopicSet children in an array. |
TopicSet |
getTopicSet(int index)
Get a topic set attached to this component. |
int |
getTopicSetCount()
Get the number of topic sets. |
boolean |
isEquivalentsList()
Test whether the members of this component are equivalents. |
boolean |
isEssential()
Test whether the provider has flagged this component as essential. |
Methods inherited from interface org.newsml.toolkit.BaseNode |
getSession, getXMLName |
Methods inherited from interface org.newsml.toolkit.CatalogNode |
getCatalog |
Methods inherited from interface org.newsml.toolkit.CommentNode |
getComment, getComment, getCommentCount |
Methods inherited from interface org.newsml.toolkit.IdNode |
getDuid, getEuid |
Methods inherited from interface org.newsml.toolkit.LanguageNode |
getLang |
Methods inherited from interface org.newsml.toolkit.PrimaryNode |
asContentItem, asNewsComponent, asNewsItem, asNewsItemRef, asNewsML, getChild, getChild, getChildCount, getNodePath, getParent, getType |
Method Detail |
public boolean isEssential()
public boolean isEquivalentsList()
getBasisForChoice(int)
.getMember(int)
,
getBasisForChoice(int)
public int getTopicSetCount()
public TopicSet getTopicSet(int index)
index
- The index of the topic set, zero-based, numbered
sequentially in document order.public TopicSet[] getTopicSet()
public FormalName getRole()
isEquivalentsList()
public int getBasisForChoiceCount()
public BasisForChoice getBasisForChoice(int index)
index
- The index of the basis for choice, zero-based,
in sequential order.isEquivalentsList()
,
getMember(int)
public BasisForChoice[] getBasisForChoice()
public NewsLines getNewsLines()
public AdministrativeMetadata getAdministrativeMetadata()
getRightsMetadata()
,
getDescriptiveMetadata()
,
getMetadata(int)
public RightsMetadata getRightsMetadata()
getAdministrativeMetadata()
,
getDescriptiveMetadata()
,
getMetadata(int)
public DescriptiveMetadata getDescriptiveMetadata()
getAdministrativeMetadata()
,
getRightsMetadata()
,
getMetadata(int)
public int getMetadataCount()
public Metadata getMetadata(int index)
index
- The index of the generic metadata, zero-based,
numbered sequentially.public Metadata[] getMetadata()
public int getMemberCount()
public PrimaryNode getMember(int index)
index
- The index of the member, zero-based, numbered
sequentially.public PrimaryNode[] getMember()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |