org.newsml.toolkit
Interface TopicNode

All Known Subinterfaces:

Party, TopicOccurrence, TopicUse

public interface TopicNode

Interface for objects pointing to topics.

Version:

2.0

Author:

Reuters PLC

Method Summary

Topic	getReferencedTopic(boolean useExternal) Look up the referenced topic.
Text	getTopicRef() Get the reference.

Method Detail

getTopicRef

public Text getTopicRef()

Get the reference.

Returns:

Text containing a pointer to a topic.

getReferencedTopic

public Topic getReferencedTopic(boolean useExternal)
                         throws IOException

Look up the referenced topic.

Parameters:

useExternal - Look outside the current document for absolute references. This parameter should be 'true' only for Party, since TopicOccurrence and TopicUse allow only internal topic references.

Returns:

The referenced topic, or null if not found.

Throws:

IOException - if there is an error looking up the topic in an external document.

NewsMLException - if the referenced node is not a Topic.

See Also:

getTopicRef()