RTI Connext Java API  Version 5.3.1
 All Classes Namespaces Functions Variables Groups Pages
QueryCondition Interface Reference

<<interface>> These are specialised com.rti.dds.subscription.ReadCondition objects that allow the application to also specify a filter on the locally available data. More...

Inheritance diagram for QueryCondition:
ReadCondition Condition

Public Member Functions

String get_query_expression ()
 Retrieves the query expression.
 
void get_query_parameters (StringSeq query_parameters)
 Retrieves the query parameters.
 
void set_query_parameters (StringSeq query_parameters)
 Sets the query parameters.
 
- Public Member Functions inherited from ReadCondition
int get_sample_state_mask ()
 Retrieves the set of sample_states for the condition.
 
int get_view_state_mask ()
 Retrieves the set of view_states for the condition.
 
int get_instance_state_mask ()
 Retrieves the set of instance_states for the condition.
 
int get_stream_kind_mask ()
 Retrieves the set of stream kind mask for the condition.
 
DataReader get_datareader ()
 Returns the com.rti.dds.subscription.DataReader associated with the com.rti.dds.subscription.ReadCondition.
 
- Public Member Functions inherited from Condition
boolean get_trigger_value ()
 Retrieve the trigger_value.
 

Detailed Description

<<interface>> These are specialised com.rti.dds.subscription.ReadCondition objects that allow the application to also specify a filter on the locally available data.

Each query condition filter is composed of a com.rti.dds.subscription.ReadCondition state filter and a content filter expressed as a query_expression and query_parameters.

The query (query_expression) is similar to an SQL WHERE clause and can be parameterised by arguments that are dynamically changeable by the set_query_parameters() operation.

Two query conditions that have the same query_expression will require unique query condition content filters if their query_paramters differ. Query conditions that differ only in their state masks will share the same query condition content filter.

Queries and Filters Syntax describes the syntax of query_expression and query_parameters.

Member Function Documentation

String get_query_expression ( )

Retrieves the query expression.

void get_query_parameters ( StringSeq  query_parameters)

Retrieves the query parameters.

Parameters
query_parameters<<inout>> the query parameters are returned here.
void set_query_parameters ( StringSeq  query_parameters)

Sets the query parameters.

Parameters
query_parameters<<in>> the new query parameters

RTI Connext Java API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc