org.omg.dds.sub

Interface QueryCondition<TYPE>

Type Parameters:

TYPE - The concrete type of the data that can be read using the the DataReader that created this QueryCondition.

All Superinterfaces:

AutoCloseable, Closeable, Condition, DDSObject, ReadCondition<TYPE>

public interface QueryCondition<TYPE>
extends ReadCondition<TYPE>

QueryCondition objects are specialized ReadCondition objects that allow the application to also specify a filter on the locally available data. The query (queryExpression) is similar to an SQL WHERE clause can be parameterized by arguments that are dynamically changeable by the setQueryParameters(List) operation. This feature is optional. In the cases where it is not supported, the DataReader.createQueryCondition(String, List) will return null. The triggerValue of a QueryCondition is like that of a ReadCondition with the additional condition that the data associated with at least one sample must be such that the queryExpression evaluates to true.

Method Summary

Methods

Modifier and Type	Method and Description
String	getQueryExpression() This operation returns the queryExpression associated with the QueryCondition.
List<String>	getQueryParameters() This operation returns the queryParameters associated with the QueryCondition.
void	setQueryParameters(List<String> queryParameters) This operation changes the queryParameters associated with the QueryCondition.

Methods inherited from interface org.omg.dds.sub.ReadCondition

close, getInstanceStates, getParent, getSampleStates, getViewStates

Methods inherited from interface org.omg.dds.core.Condition

getTriggerValue

Methods inherited from interface org.omg.dds.core.DDSObject

getEnvironment

Method Detail

getQueryExpression

String getQueryExpression()

This operation returns the queryExpression associated with the QueryCondition. That is, the expression specified when the QueryCondition was created.

See Also:

getQueryParameters()

getQueryParameters

List<String> getQueryParameters()

This operation returns the queryParameters associated with the QueryCondition. That is, the parameters specified on the last successful call to setQueryParameters(List), or if setQueryParameters(List) was never called, the arguments specified when the QueryCondition was created.

Returns:

an unmodifiable list of the current query parameters.

See Also:

setQueryParameters(List), getQueryExpression()

setQueryParameters

void setQueryParameters(List<String> queryParameters)

This operation changes the queryParameters associated with the QueryCondition.

Parameters:

queryParameters - a container, into which this method will place its result.

See Also:

getQueryParameters()