ContentFilteredTopic is a specialization of TopicDescription that allows for content-based subscriptions. More...

Inheritance diagram for org.omg.dds.topic.ContentFilteredTopic< TYPE >:

Collaboration diagram for org.omg.dds.topic.ContentFilteredTopic< TYPE >:

Public Member Functions
public< OTHER > TopicDescription< OTHER >	cast ()
	Cast this topic description to the given type, or throw an exception if the cast fails. More...

void	close ()
	Dispose the resources held by this object. More...

ServiceEnvironment	getEnvironment ()

List< String >	getExpressionParameters ()
	This operation returns the expression parameters associated with the ContentFilteredTopic, that is, the parameters specified on the last successful call to setExpressionParameters(List), or if setExpressionParameters(List) was never called, the parameters specified when the ContentFilteredTopic was created. More...

String	getFilterExpression ()
	The filter expression associated with the ContentFilteredTopic, that is, the expression specified when the ContentFilteredTopic was created. More...

String	getName ()
	Returns the name used to create the TopicDescription. More...

DomainParticipant	getParent ()
	Returns the org.omg.dds.domain.DomainParticipant to which the TopicDescription belongs. More...

Topic<? extends TYPE >	getRelatedTopic ()
	The org.omg.dds.topic.Topic associated with the ContentFilteredTopic, that is, the Topic specified when the ContentFilteredTopic was created. More...

String	getTypeName ()
	Returns the type name used to create the TopicDescription. More...

TypeSupport< TYPE >	getTypeSupport ()
	Returns the org.omg.dds.type.TypeSupport used to create this TopicDescription. More...

void	setExpressionParameters (List< String > expressionParameters)
	This operation changes the expression parameters associated with the ContentFilteredTopic. More...

void	setExpressionParameters (String... expressionParameters)
	This operation changes the expression parameters associated with the ContentFilteredTopic. More...

Detailed Description

ContentFilteredTopic is a specialization of TopicDescription that allows for content-based subscriptions.

ContentFilteredTopic describes a more sophisticated subscription that indicates the subscriber does not want to necessarily see all values of each instance published under the org.omg.dds.topic.Topic. Rather, it wants to see only the values whose contents satisfy certain criteria. This class therefore can be used to request content-based subscriptions.

The selection of the content is done using the filterExpression with parameters expressionParameters.

The filterExpression attribute is a string that specifies the criteria to select the data samples of interest. It is similar to the WHERE part of an SQL clause.
The expressionParameters attribute is a sequence of strings that give values to the "parameters" (i.e., "%n" tokens) in the filterExpression. The number of supplied parameters must fit with the requested values in the filterExpression (i.e., the number of "%n" tokens).

The selection of the content is done using the SQL based filter with parameters to adapt the filter clause.

Parameters

<TYPE>

The concrete type of the data that will be published and/ or subscribed by the readers and writers that use this topic description.

Example

// Default creation of a Topic
Topic<Foo> topic = participant.createTopic("TopicName", Foo.class);

// Creation of a ContentFilteredTopic (assume Foo contains a x and y element). List<String> params = new ArrayList<String>(); params.add("200"); params.add("1000"); String filter = "x > %0 AND y < %1"; // Create the contentFilteredTopic. ContentFilteredTopic<Foo> cfTopic = participant.createContentFilteredTopic("FilteredTopicName", topic,filter,params);

// create Filtered DataReader
DataReader<Foo> reader = sub.createDataReader(cfTopic,drQos);

Definition at line 71 of file ContentFilteredTopic.java.

Member Function Documentation

◆ cast()

public<OTHER> TopicDescription<OTHER> org.omg.dds.topic.TopicDescription< TYPE >.cast ( )

inherited

Cast this topic description to the given type, or throw an exception if the cast fails.

Parameters

<OTHER> The type of the data exchanged on this topic, according to the caller.

Returns: this topic description

Exceptions

ClassCastException if the cast fails

◆ close()

void org.omg.dds.topic.TopicDescription< TYPE >.close ( )

inherited

Dispose the resources held by this object.

A TopicDescription cannot be closed if it is in use by any org.omg.dds.pub.DataWriters or org.omg.dds.sub.DataReaders. With respect to org.omg.dds.topic.Topics specifically: a Topic cannot be closed if it has any remaining org.omg.dds.topic.ContentFilteredTopics or org.omg.dds.topic.MultiTopics related to it.

See also: org.omg.dds.core.Entity::close()

Implemented in org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, and org.opensplice.dds.topic.TopicDescriptionExt< TYPE >.

◆ getEnvironment()

ServiceEnvironment org.omg.dds.core.DDSObject.getEnvironment ( )

inherited

Returns: the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

◆ getExpressionParameters()

List<String> org.omg.dds.topic.ContentFilteredTopic< TYPE >.getExpressionParameters ( )

This operation returns the expression parameters associated with the ContentFilteredTopic, that is, the parameters specified on the last successful call to setExpressionParameters(List), or if setExpressionParameters(List) was never called, the parameters specified when the ContentFilteredTopic was created.

Returns: an unmodifiable list.

See also: #setExpressionParameters(List)

Implemented in org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.

◆ getFilterExpression()

String org.omg.dds.topic.ContentFilteredTopic< TYPE >.getFilterExpression ( )

The filter expression associated with the ContentFilteredTopic, that is, the expression specified when the ContentFilteredTopic was created.

Returns: the filter expression

Implemented in org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.

◆ getName()

String org.omg.dds.topic.TopicDescription< TYPE >.getName ( )

inherited

Returns the name used to create the TopicDescription.

Returns: the name.

Implemented in org.opensplice.dds.topic.TopicImpl< TYPE >, and org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.

◆ getParent()

DomainParticipant org.omg.dds.topic.TopicDescription< TYPE >.getParent ( )

inherited

Returns the org.omg.dds.domain.DomainParticipant to which the TopicDescription belongs.

Returns: the org.omg.dds.domain.DomainParticipant

Implemented in org.opensplice.dds.topic.TopicImpl< TYPE >, org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, and org.omg.dds.topic.Topic< TYPE >.

◆ getRelatedTopic()

Topic<? extends TYPE> org.omg.dds.topic.ContentFilteredTopic< TYPE >.getRelatedTopic ( )

The org.omg.dds.topic.Topic associated with the ContentFilteredTopic, that is, the Topic specified when the ContentFilteredTopic was created.

Returns: the org.omg.dds.topic.Topic associated with the ContentFilteredTopic

Implemented in org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.

◆ getTypeName()

String org.omg.dds.topic.TopicDescription< TYPE >.getTypeName ( )

inherited

Returns the type name used to create the TopicDescription.

Returns: the type name

Implemented in org.opensplice.dds.topic.TopicImpl< TYPE >, and org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.

◆ getTypeSupport()

TypeSupport<TYPE> org.omg.dds.topic.TopicDescription< TYPE >.getTypeSupport ( )

inherited

Returns the org.omg.dds.type.TypeSupport used to create this TopicDescription.

Returns: the org.omg.dds.type.TypeSupport.

Implemented in org.opensplice.dds.topic.TopicImpl< TYPE >, and org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.

◆ setExpressionParameters() [1/2]

void org.omg.dds.topic.ContentFilteredTopic< TYPE >.setExpressionParameters ( List< String > expressionParameters )

This operation changes the expression parameters associated with the ContentFilteredTopic.

Parameters

expressionParameters The expressionParameters attribute is a collection of strings that give values to the "parameters" (i.e., "%n" tokens) in the queryExpression. The number of supplied parameters must fit with the requested values in the queryExpression (i.e., the number of "%n" tokens).

See also: getExpressionParameters()

Implemented in org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.

◆ setExpressionParameters() [2/2]

void org.omg.dds.topic.ContentFilteredTopic< TYPE >.setExpressionParameters ( String... expressionParameters )

This operation changes the expression parameters associated with the ContentFilteredTopic.

Parameters

expressionParameters The expressionParameters attribute is a sequence of strings that give values to the "parameters" (i.e., "%n" tokens) in the queryExpression. The number of supplied parameters must fit with the requested values in the queryExpression (i.e., the number of "%n" tokens).

See also: getExpressionParameters() NOTE: This operation is not yet implemented. It is scheduled for a future release.

Implemented in org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >.

The documentation for this interface was generated from the following file:

java5/common/java/code/org/omg/dds/topic/ContentFilteredTopic.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ cast()

◆ close()

◆ getEnvironment()

◆ getExpressionParameters()

◆ getFilterExpression()

◆ getName()

◆ getParent()

◆ getRelatedTopic()

◆ getTypeName()

◆ getTypeSupport()

◆ setExpressionParameters() [1/2]

◆ setExpressionParameters() [2/2]