org.newsml.toolkit
Interface FormalName

All Superinterfaces:

BaseNode, FormalNameNode, IdNode

All Known Subinterfaces:

AssignedFormalName, Instruction, OfInterestTo, Party, TopicSet

public interface FormalName

extends BaseNode, FormalNameNode, IdNode

A three-part NewsML name element.

For information on formal names, see the FormalNameNode base interface.

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

Methods inherited from interface org.newsml.toolkit.IdNode

getDuid, getEuid

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.

This method is not declared present in the FormalNameNode base interface because an explicitly-specified scheme is not available for the ProviderId interface.

Returns:

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

See Also:

FormalNameNode.getDefaultScheme(boolean), FormalNameNode.getName(), FormalNameNode.getVocabulary()