This QosPolicy is used to set the key list of a DataReaderView. More...

Inheritance diagram for org.opensplice.dds.core.policy.ViewKeys:

Collaboration diagram for org.opensplice.dds.core.policy.ViewKeys:

Public Member Functions
ServiceEnvironment	getEnvironment ()

Set< String >	getKey ()

ViewKeys	withKey (Collection< String > keyList)
	Copy this policy and override the value of the property. More...

ViewKeys	withKey (String keyList)
	Copy this policy and override the value of the property. More...

ViewKeys	withKey (String... keyList)
	Copy this policy and override the value of the property. More...

Detailed Description

This QosPolicy is used to set the key list of a DataReaderView.

A DataReaderView allows a different view, defined by this key list, on the data set of the DataReader from which it is created.

Operations that operate on instances or instance handles, such as lookupInstance or getKeyValue, respect the alternative key-list and work as expected. However, since the mapping of writer instances to reader instances is no longer trivial (one writer instance may now map to more than one matching reader instance and vice versa), a writer instance will no longer be able to fully determine the lifecycle of its matching reader instance, nor the value its view_state and instance_state.

In fact, the view sample will always copy the view_state and instance_state values from the reader sample to which it is slaved. If both samples preserve a 1 - 1 correspondence with respect to their originating instances (this may sometimes be the case even when an alternative keylist is provided, i.e. when one reader instance never maps to more than one view instance and vice versa) then the resulting InstanceState and ViewState still have a valid semantical meaning. If this 1 - 1 correspondence cannot be guaranteed, the resulting InstanceState and ViewState are semantically meaningless and should not be used to derive any conclusion regarding the lifecycle of a view instance.

By default, the ViewKeyQosPolicy is disabled.

This QosPolicy is applicable to a DataReaderView only, and cannot be changed after the DataReaderView is created.

Definition at line 54 of file ViewKeys.java.

Member Function Documentation

◆ 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.

◆ getKey()

Set<String> org.opensplice.dds.core.policy.ViewKeys.getKey ( )

Returns: an unmodifiable collection of view keys.

Implemented in org.opensplice.dds.core.policy.ViewKeysImpl.

◆ withKey() [1/3]

ViewKeys org.opensplice.dds.core.policy.ViewKeys.withKey ( Collection< String > keyList )

Copy this policy and override the value of the property.

Parameters

keyList A collection of strings with one or more names of the data set of the DataReader acting as alternative keys.

Returns: a new ViewKeys policy

Implemented in org.opensplice.dds.core.policy.ViewKeysImpl.

◆ withKey() [2/3]

ViewKeys org.opensplice.dds.core.policy.ViewKeys.withKey ( String keyList )

Copy this policy and override the value of the property.

Parameters

keyList A strings with one name of the data set of the DataReader acting as alternative keys.

Returns: a new ViewKeys policy

Implemented in org.opensplice.dds.core.policy.ViewKeysImpl.

◆ withKey() [3/3]

ViewKeys org.opensplice.dds.core.policy.ViewKeys.withKey ( String... keyList )

Copy this policy and override the value of the property.

Parameters

keyList An arbitrary number of strings with one or more names of the data set of the DataReader acting as alternative keys.

Returns: a new ViewKeys policy

Implemented in org.opensplice.dds.core.policy.ViewKeysImpl.

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

java5/common/java/code/org/opensplice/dds/core/policy/ViewKeys.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ getEnvironment()

◆ getKey()

◆ withKey() [1/3]

◆ withKey() [2/3]

◆ withKey() [3/3]