CoreDX DDS Java Reference Manual
Public Member Functions | List of all members
ContentFilteredTopic Class Reference

ContentFilteredTopic provides a topic that may include data filtered from a related Topic. More...

Inheritance diagram for ContentFilteredTopic:
TopicDescription

Public Member Functions

DomainParticipant get_participant ()
 This operation returns the parent DomainParticipant of the ContentFilteredTopic.
 
String get_type_name ()
 This operation returns type_name of the ContentFilteredTopic.
 
String get_name ()
 This operation returns topic name of the ContentFilteredTopic.
 
Topic get_related_topic ()
 This returns the real Topic associated with the ContentFilteredTopic. More...
 
Vector get_expression_parameters ()
 This accesses the current set of parameters used by the ContentFilteredTopic. More...
 
ReturnCode_t set_expression_parameters (Vector filter_parameters)
 This specifies a new set of parameters for use with the filter_expression. More...
 

Detailed Description

ContentFilteredTopic provides a topic that may include data filtered from a related Topic.

Member Function Documentation

Vector get_expression_parameters ( )

This accesses the current set of parameters used by the ContentFilteredTopic.

The parameters String Sequence is populated with the current set of parameters.

Topic get_related_topic ( )

This returns the real Topic associated with the ContentFilteredTopic.

That is, the Topic provided when the ContentFilteredTopic was created.

ReturnCode_t set_expression_parameters ( Vector  filter_parameters)

This specifies a new set of parameters for use with the filter_expression.

The filter_expression is an SQL like condition expression, and the parameters argument provides optional parameters that are referenced by the filter_expression. The syntax for refering to paramters in a filter_expression is the percent sign '' followed by a number. The number is the index of the paramter in the filter_paramters sequence. Parameters are counted starting at zero. So, "%0" refers to the first parameter, and "%4" refers to the fifth paramter. Using this syntax, the expression "x<%0" would test the value of 'x' against the first parameter in the sequence.


© 2009-2017 Twin Oaks Computing, Inc
Castle Rock, CO 80108
All rights reserved.