OpenSplice Java 5 DCPS  v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
org.opensplice.dds.sub.QueryConditionImpl< TYPE > Class Template Reference
Inheritance diagram for org.opensplice.dds.sub.QueryConditionImpl< TYPE >:
Inheritance graph
Collaboration diagram for org.opensplice.dds.sub.QueryConditionImpl< TYPE >:
Collaboration graph

Public Member Functions

 QueryConditionImpl (OsplServiceEnvironment environment, AbstractDataReader< TYPE > parent, DataStateImpl state, String queryExpression, List< String > queryParameters)
 
 QueryConditionImpl (OsplServiceEnvironment environment, AbstractDataReader< TYPE > parent, String queryExpression, List< String > queryParameters)
 
void close ()
 Reclaim any resources associated with this condition. More...
 
ServiceEnvironment getEnvironment ()
 
Set< InstanceStategetInstanceStates ()
 This operation returns the set of instance states that are taken into account to determine the triggerValue of the ReadCondition. More...
 
DDS.ReadCondition getOld ()
 
DDS.ReadCondition getOldCondition ()
 
DataReader< TYPE > getParent ()
 
String getQueryExpression ()
 This operation returns the queryExpression associated with the QueryCondition. More...
 
List< String > getQueryParameters ()
 This operation returns the queryParameters associated with the QueryCondition. More...
 
Set< SampleStategetSampleStates ()
 This operation returns the set of sample states that are taken into account to determine the triggerValue of the ReadCondition. More...
 
DataStateImpl getState ()
 
boolean getTriggerValue ()
 
Set< ViewStategetViewStates ()
 This operation returns the set of view states that are taken into account to determine the triggerValue of the ReadCondition. More...
 
void setQueryParameters (List< String > queryParameters)
 This operation changes the queryParameters associated with the QueryCondition. More...
 
void setQueryParameters (String... queryParameters)
 This operation changes the queryParameters associated with the QueryCondition. More...
 

Protected Attributes

final OsplServiceEnvironment environment
 
DDS.ReadCondition old
 
final AbstractDataReader< TYPE > parent
 
final DataStateImpl state
 

Detailed Description

Definition at line 33 of file QueryConditionImpl.java.

Constructor & Destructor Documentation

◆ QueryConditionImpl() [1/2]

org.opensplice.dds.sub.QueryConditionImpl< TYPE >.QueryConditionImpl ( OsplServiceEnvironment  environment,
AbstractDataReader< TYPE >  parent,
DataStateImpl  state,
String  queryExpression,
List< String >  queryParameters 
)

Definition at line 35 of file QueryConditionImpl.java.

◆ QueryConditionImpl() [2/2]

org.opensplice.dds.sub.QueryConditionImpl< TYPE >.QueryConditionImpl ( OsplServiceEnvironment  environment,
AbstractDataReader< TYPE >  parent,
String  queryExpression,
List< String >  queryParameters 
)

Definition at line 43 of file QueryConditionImpl.java.

Member Function Documentation

◆ close()

void org.opensplice.dds.sub.ReadConditionImpl< TYPE >.close ( )
inherited

Reclaim any resources associated with this condition.

Implements org.omg.dds.sub.ReadCondition< TYPE >.

Definition at line 128 of file ReadConditionImpl.java.

◆ getEnvironment()

ServiceEnvironment org.opensplice.dds.sub.ReadConditionImpl< TYPE >.getEnvironment ( )
inherited
Returns
the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

Implements org.omg.dds.core.DDSObject.

Definition at line 99 of file ReadConditionImpl.java.

◆ getInstanceStates()

Set<InstanceState> org.opensplice.dds.sub.ReadConditionImpl< TYPE >.getInstanceStates ( )
inherited

This operation returns the set of instance states that are taken into account to determine the triggerValue of the ReadCondition.

These are the instance states specified when the ReadCondition was created.

Returns
an unmodifiable set.

Implements org.omg.dds.sub.ReadCondition< TYPE >.

Definition at line 114 of file ReadConditionImpl.java.

◆ getOld()

DDS.ReadCondition org.opensplice.dds.sub.ReadConditionImpl< TYPE >.getOld ( )
inherited

Definition at line 123 of file ReadConditionImpl.java.

◆ getOldCondition()

DDS.ReadCondition org.opensplice.dds.sub.QueryConditionImpl< TYPE >.getOldCondition ( )

◆ getParent()

DataReader<TYPE> org.opensplice.dds.sub.ReadConditionImpl< TYPE >.getParent ( )
inherited
Returns
the DataReader associated with the ReadCondition. Note that there is exactly one DataReader associated with each ReadCondition.

Implements org.omg.dds.sub.ReadCondition< TYPE >.

Definition at line 119 of file ReadConditionImpl.java.

◆ getQueryExpression()

String org.opensplice.dds.sub.QueryConditionImpl< TYPE >.getQueryExpression ( )

This operation returns the queryExpression associated with the QueryCondition.

That is, the expression specified when the QueryCondition was created.

See also
getQueryParameters()

Implements org.omg.dds.sub.QueryCondition< TYPE >.

Definition at line 77 of file QueryConditionImpl.java.

◆ getQueryParameters()

List<String> org.opensplice.dds.sub.QueryConditionImpl< TYPE >.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()

Implements org.omg.dds.sub.QueryCondition< TYPE >.

Definition at line 82 of file QueryConditionImpl.java.

◆ getSampleStates()

Set<SampleState> org.opensplice.dds.sub.ReadConditionImpl< TYPE >.getSampleStates ( )
inherited

This operation returns the set of sample states that are taken into account to determine the triggerValue of the ReadCondition.

These are the sample states specified when the ReadCondition was created.

Returns
an unmodifiable set.

Implements org.omg.dds.sub.ReadCondition< TYPE >.

Definition at line 104 of file ReadConditionImpl.java.

◆ getState()

Definition at line 132 of file ReadConditionImpl.java.

◆ getTriggerValue()

boolean org.opensplice.dds.sub.ReadConditionImpl< TYPE >.getTriggerValue ( )
inherited
Returns
the triggerValue of the Condition.

Implements org.omg.dds.core.Condition.

Definition at line 94 of file ReadConditionImpl.java.

◆ getViewStates()

Set<ViewState> org.opensplice.dds.sub.ReadConditionImpl< TYPE >.getViewStates ( )
inherited

This operation returns the set of view states that are taken into account to determine the triggerValue of the ReadCondition.

These are the view states specified when the ReadCondition was created.

Returns
an unmodifiable set.

Implements org.omg.dds.sub.ReadCondition< TYPE >.

Definition at line 109 of file ReadConditionImpl.java.

◆ setQueryParameters() [1/2]

void org.opensplice.dds.sub.QueryConditionImpl< TYPE >.setQueryParameters ( List< String >  queryParameters)

This operation changes the queryParameters associated with the QueryCondition.

Parameters
queryParametersa container, into which this method will place its result.
Exceptions
org.omg.dds.core.DDSExceptionAn internal error has occurred.
org.omg.dds.core.OutOfResourcesExceptionThe Data Distribution Service ran out of resources to complete this operation.
See also
getQueryParameters()

Implements org.omg.dds.sub.QueryCondition< TYPE >.

Definition at line 97 of file QueryConditionImpl.java.

◆ setQueryParameters() [2/2]

void org.opensplice.dds.sub.QueryConditionImpl< TYPE >.setQueryParameters ( String...  queryParameters)

This operation changes the queryParameters associated with the QueryCondition.

Parameters
queryParametersa container, into which this method will place its result.
Exceptions
org.omg.dds.core.DDSExceptionAn internal error has occurred.
org.omg.dds.core.OutOfResourcesExceptionThe Data Distribution Service ran out of resources to complete this operation.
See also
getQueryParameters()

Implements org.omg.dds.sub.QueryCondition< TYPE >.

Definition at line 113 of file QueryConditionImpl.java.

Member Data Documentation

◆ environment

final OsplServiceEnvironment org.opensplice.dds.sub.ReadConditionImpl< TYPE >.environment
protectedinherited

Definition at line 39 of file ReadConditionImpl.java.

◆ old

DDS.ReadCondition org.opensplice.dds.sub.ReadConditionImpl< TYPE >.old
protectedinherited

Definition at line 40 of file ReadConditionImpl.java.

◆ parent

final AbstractDataReader<TYPE> org.opensplice.dds.sub.ReadConditionImpl< TYPE >.parent
protectedinherited

Definition at line 41 of file ReadConditionImpl.java.

◆ state

final DataStateImpl org.opensplice.dds.sub.ReadConditionImpl< TYPE >.state
protectedinherited

Definition at line 42 of file ReadConditionImpl.java.


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