org.apache.ws.notification.topics
Interface TopicSpaceSet

public interface TopicSpaceSet

The set of topics that a particular NotificationProducer supports.

Method Summary

TopicSpace	addTopicSpace(TopicSpace topicSpace) Adds the TopicSpace to the TopicSpaceSet.
Topic[]	evaluateTopicExpression(TopicExpression topicExpr) Evaluates a TopicExpression against the TopicSpaceSet and returns an array of matching Topics.
TopicSpace	getTopicSpace(java.lang.String namespaceURI) Returns a TopicSpace for a given namespace uri.
TopicSpace[]	getTopicSpaces() Resturns the TopicSpaces maintained by this TopicSpaceSet
boolean	isFixed() Returns a boolean that indicates if this topic set is fixed as defined by the WS-BaseNotification specification.
void	removeTopicSpace(java.lang.String namespaceURI) Removes a TopicSpace from the TopicSpaceSet for a given namespace uri.
void	setFixed(boolean fixed) Sets the boolean that indicates if this topic set is fixed as defined by the WS-BaseNotification specification.

Method Detail

setFixed

public void setFixed(boolean fixed)

Sets the boolean that indicates if this topic set is fixed as defined by the WS-BaseNotification specification.

Parameters:

fixed -

isFixed

public boolean isFixed()

Returns a boolean that indicates if this topic set is fixed as defined by the WS-BaseNotification specification.

getTopicSpace

public TopicSpace getTopicSpace(java.lang.String namespaceURI)

Returns a TopicSpace for a given namespace uri.

Parameters:

namespaceURI -

Returns:

the TopicSpace for the given uri, or null if there is no TopicSpace found.

getTopicSpaces

public TopicSpace[] getTopicSpaces()

Resturns the TopicSpaces maintained by this TopicSpaceSet

Returns:

An array of TopicSpace objects.

addTopicSpace

public TopicSpace addTopicSpace(TopicSpace topicSpace)

Adds the TopicSpace to the TopicSpaceSet. Note. If the TopiSpace already exists, this method will add all the known Topics to the passed-in TopicSpace and set it as the current TopicSpace in the TopicSpaceSet. This will ensure there is only 1 TopicSpace in the set and it is complete...

Parameters:

topicSpace -

evaluateTopicExpression

public Topic[] evaluateTopicExpression(TopicExpression topicExpr)
                                throws TopicExpressionException

Evaluates a TopicExpression against the TopicSpaceSet and returns an array of matching Topics.

Parameters:

topicExpr - The topicexpression (query) to be used to search againt the TopicSpaceSet.

Returns:

An array of Topics which were found based on the topicexpression

Throws:

TopicExpressionException

removeTopicSpace

public void removeTopicSpace(java.lang.String namespaceURI)

Removes a TopicSpace from the TopicSpaceSet for a given namespace uri.

Parameters:

namespaceURI -