org.newsml.toolkit
Interface NewsItemId

All Superinterfaces:
BaseNode, FormalNameNode

public interface NewsItemId
extends BaseNode, FormalNameNode

A news item identifier.

A news item identifier is similar to a regular FormalName, but it does not contain the local Duid or Euid identifiers. It is also similar to a ProviderId, except that it can have a locally-specified scheme. See FormalName for details on vocabulary resolution.

Version:
2.0
Author:
Reuters PLC

Method Summary
 Text getScheme()
          Get an explicitly-specified scheme for the formal name.
 
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.FormalNameNode
findTopic, getDefaultScheme, getDefaultVocabulary, getName, getTopicSet, getVocabulary, toString, toString
 

Method Detail

getScheme

public Text getScheme()
Get an explicitly-specified scheme for the formal name.

This method returns only a scheme that has been provided explicitly in the XML.

A scheme is a section of a vocabulary; this property is useful for partitioning large vocabularies into several parts.

Returns:
Text containing the vocabulary scheme, or null if none was provided.