org.apache.ws.notification.topics
Interface Topic

All Superinterfaces:

TopicSiblingSet

public interface Topic

extends TopicSiblingSet

Interface for representing a topic. A topic is either a child of a parent topic or in the case of root topics a member of a topic list. Non-root topics have names without a namespace component.

See Also:

TopicNamespace

Method Summary

java.lang.String	getName() Get the name of this topic.
TopicNamespace	getTopicNamespace() Gets the TopicSpace this Topic is part of
java.util.List	getTopicPath() Get the topic path.
TopicExpression	getTopicReference() Get the topic expression for the topic(s) that this topic references.
boolean	isReference() Is this a topic reference?
void	setTopicNamespace(TopicNamespace topicNs) Set the TopicSpace this Topic is part of
void	setTopicPath(java.util.List topicPath) Set the topic path.
void	setTopicReference(TopicExpression topicPath) Set the topic expression that resolves to a set of topics that this topic references.

Methods inherited from interface org.apache.ws.notification.topics.TopicSiblingSet

addTopic, containsTopic, getTopic, removeTopic, topicIterator

Method Detail

getName

public java.lang.String getName()

Get the name of this topic.

Returns:

the name of this topic

isReference

public boolean isReference()

Is this a topic reference?

Returns:

true if this topic is a reference to another topic, false if not

setTopicNamespace

public void setTopicNamespace(TopicNamespace topicNs)

Set the TopicSpace this Topic is part of

Parameters:

topicNs - The TopicSpace this Topic is part of

getTopicNamespace

public TopicNamespace getTopicNamespace()

Gets the TopicSpace this Topic is part of

Returns:

the TopicSpace this Topic is part of

setTopicPath

public void setTopicPath(java.util.List topicPath)

Set the topic path. The topic path is represented as a ordered list of topic names

Parameters:

topicPath - The topic path to associate with this topic

getTopicPath

public java.util.List getTopicPath()

Get the topic path. The topic path is represented as an ordered list of topic names

Returns:

The topic path of this topic

setTopicReference

public void setTopicReference(TopicExpression topicPath)

Set the topic expression that resolves to a set of topics that this topic references. Only used for reference topics.

Parameters:

topicPath - The topic expression to set.

getTopicReference

public TopicExpression getTopicReference()

Get the topic expression for the topic(s) that this topic references.

Returns:

The topic expression that this topic reference or null if this topic is not a reference.