org.newsml.toolkit
Interface FormalNameDecl

All Superinterfaces:
BaseNode, IdNode

public interface FormalNameDecl
extends BaseNode, IdNode

The declaration of a local name and scheme for a topic.

When a TopicSet represents a vocabulary, this element can declare a local name and optional scheme for a topic. Note that in the NewsML XML markup, the element is named simply "FormalName". The combination of local name and scheme will be unique among all topics in the topic set.

Note that a single topic may have zero or more formal names declared.

Version:
1.0
Author:
Reuters PLC
See Also:
FormalName

Method Summary
 java.lang.String getName()
          Get a topic's declared local name.
 java.lang.String getScheme()
          Get a topic's declared scheme.
 
Methods inherited from interface org.newsml.toolkit.BaseNode
getSession, getXMLName
 
Methods inherited from interface org.newsml.toolkit.IdNode
getDuid, getEuid
 

Method Detail

getName

public java.lang.String getName()
Get a topic's declared local name.
Returns:
A string representing the local part of the name (not null).
See Also:
FormalNameNode.getName()

getScheme

public java.lang.String getScheme()
Get a topic's declared scheme.
Returns:
A string representing the vocabulary scheme, or null if none was provided.
See Also:
FormalName.getScheme()