org.newsml.toolkit
Interface NewsItem

All Superinterfaces:
BaseNode, CatalogNode, CommentNode, IdNode, LanguageNode, PrimaryNode

public interface NewsItem
extends BaseNode, CatalogNode, CommentNode, IdNode, LanguageNode, PrimaryNode

A managed set of news information.

A news item is a branch in the NewsML content tree that attaches identification and management information to news objects; much of the interesting information (such as headlines and subheadlines, metadata, and the actual content) is available in or through the root news component (see getRootNewsComponent()).

This interface currently omits the following information:

Version:
1.0
Author:
Reuters PLC

Fields inherited from interface org.newsml.toolkit.PrimaryNode
CONTENT_ITEM, NEWS_COMPONENT, NEWS_ITEM, NEWS_ITEM_REF, NEWSML
 
Method Summary
 Identification getIdentification()
          Get the identification labels.
 NewsManagement getNewsManagement()
          Get the management information for the news item.
 NewsComponent getRootNewsComponent()
          Get the root component of the news item.
 TopicSet getRootTopicSet()
          Get the root topic set of the news item.
 
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

getIdentification

public Identification getIdentification()
Get the identification labels.
Returns:
An object containing the identification labels for this news item (not null).

getNewsManagement

public NewsManagement getNewsManagement()
Get the management information for the news item. The management information includes the type of the news item, its status (including whether it's embargoed), when it was created, and similar information.
Returns:
An object containing the management information for the news item (not null).

getRootNewsComponent

public NewsComponent getRootNewsComponent()
Get the root component of the news item. Return the root component of the news item. The component contains newslines, metadata, and other similar information, and is the beginning of the path down the NewsML tree to the actual content. If this method returns a non-null value, getRootTopicSet() must return null, and vice-versa.
Returns:
The root news component, or null if none was specified.

getRootTopicSet

public TopicSet getRootTopicSet()
Get the root topic set of the news item. If the topic set is present, it is actually the payload of this newsitem, rather than simply metadata describing the payload. If this method returns a non-null value, getRootNewsComponent() must return null, and vice-versa.
Returns:
The root topic set, or null if none was specified.