com.prosysopc.ua.stack.builtintypes

Interface Structure

All Superinterfaces:

Cloneable, IEncodeable, UaNamespaceTranslateable<Structure>

All Known Subinterfaces:

OptionSetStructure, ServiceRequest<T>, ServiceResponse

All Known Implementing Classes:

AbstractStructure, ActionMethodDataType, ActionTargetDataType, ActivateSessionRequest, ActivateSessionResponse, AdditionalParametersType, AddNodesItem, AddNodesRequest, AddNodesResponse, AddNodesResult, AddReferencesItem, AddReferencesRequest, AddReferencesResponse, AggregateConfiguration, AggregateFilter, AggregateFilterResult, AliasNameDataType, Annotation, AnnotationDataType, AnonymousIdentityToken, ApplicationConfigurationDataType, ApplicationDescription, ApplicationIdentityDataType, ApplicationRecordDataType, Argument, AttributeOperand, AuthorizationServiceConfigurationDataType, AxisInformation, BaseConfigurationDataType, BaseConfigurationRecordDataType, BitFieldDefinition, BrokerConnectionTransportDataType, BrokerDataSetReaderTransportDataType, BrokerDataSetWriterTransportDataType, BrokerWriterGroupTransportDataType, BrowseDescription, BrowseNextRequest, BrowseNextResponse, BrowsePath, BrowsePathResult, BrowsePathTarget, BrowseRequest, BrowseResponse, BrowseResult, BuildInfo, CallMethodRequest, CallMethodResult, CallRequest, CallResponse, CancelRequest, CancelResponse, CartesianCoordinates, CertificateGroupDataType, ChannelSecurityToken, CloseSecureChannelRequest, CloseSecureChannelResponse, CloseSessionRequest, CloseSessionResponse, ComplexNumberType, ConfigurationUpdateTargetType, ConfigurationVersionDataType, ConnectionTransportDataType, ContentFilter, ContentFilterElement, ContentFilterElementResult, ContentFilterResult, CreateMonitoredItemsRequest, CreateMonitoredItemsResponse, CreateSessionRequest, CreateSessionResponse, CreateSubscriptionRequest, CreateSubscriptionResponse, CurrencyUnitType, DataChangeFilter, DataChangeNotification, DatagramConnectionTransport2DataType, DatagramConnectionTransportDataType, DatagramDataSetReaderTransportDataType, DatagramWriterGroupTransport2DataType, DatagramWriterGroupTransportDataType, DataSetMetaDataType, DataSetReaderDataType, DataSetReaderMessageDataType, DataSetReaderTransportDataType, DataSetWriterDataType, DataSetWriterMessageDataType, DataSetWriterTransportDataType, DataTypeAttributes, DataTypeDefinition, DataTypeDescription, DataTypeSchemaHeader, DeleteAtTimeDetails, DeleteEventDetails, DeleteMonitoredItemsRequest, DeleteMonitoredItemsResponse, DeleteNodesItem, DeleteNodesRequest, DeleteNodesResponse, DeleteRawModifiedDetails, DeleteReferencesItem, DeleteReferencesRequest, DeleteReferencesResponse, DeleteSubscriptionsRequest, DeleteSubscriptionsResponse, DiscoveryConfiguration, DoubleComplexNumberType, DtlsPubSubConnectionDataType, DynamicStructure, ElementOperand, EndpointConfiguration, EndpointDataType, EndpointDescription, EndpointType, EndpointUrlListDataType, EnumDefinition, EnumDescription, EnumField, EnumValueType, EphemeralKeyType, EUInformation, EventFieldList, EventFilter, EventFilterResult, EventNotificationList, FieldMetaData, FieldTargetDataType, FilterOperand, FindServersOnNetworkRequest, FindServersOnNetworkResponse, FindServersRequest, FindServersResponse, Frame, GenericAttributes, GenericAttributeValue, GetEndpointsRequest, GetEndpointsResponse, HistoryData, HistoryEvent, HistoryEventFieldList, HistoryModifiedData, HistoryModifiedEvent, HistoryReadDetails, HistoryReadRequest, HistoryReadResponse, HistoryReadResult, HistoryReadValueId, HistoryUpdateDetails, HistoryUpdateRequest, HistoryUpdateResponse, HistoryUpdateResult, IdentityMappingRuleType, InternalClientSideDecodingServiceFault, IssuedIdentityToken, JsonDataSetReaderMessageDataType, JsonDataSetWriterMessageDataType, JsonWriterGroupMessageDataType, KeyValuePair, LinearConversionDataType, LiteralOperand, LldpManagementAddressTxPortType, LldpManagementAddressType, LldpTlvType, LogRecord, LogRecordsDataType, MdnsDiscoveryConfiguration, MethodAttributes, ModelChangeStructureDataType, ModificationInfo, ModifyMonitoredItemsRequest, ModifyMonitoredItemsResponse, ModifySubscriptionRequest, ModifySubscriptionResponse, MonitoredItemCreateRequest, MonitoredItemCreateResult, MonitoredItemModifyRequest, MonitoredItemModifyResult, MonitoredItemNotification, MonitoringFilter, MonitoringFilterResult, MonitoringParameters, NameValuePair, NetworkAddressDataType, NetworkAddressUrlDataType, NetworkGroupDataType, NodeAttributes, NodeReference, NodeTypeDescription, NotificationData, NotificationMessage, ObjectAttributes, ObjectTypeAttributes, OpenSecureChannelRequest, OpenSecureChannelResponse, OptionSet, Orientation, ParsingResult, PortableNodeId, PortableQualifiedName, PriorityMappingEntryType, ProgramDiagnostic2DataType, ProgramDiagnosticDataType, PublishedActionDataType, PublishedActionMethodDataType, PublishedDataItemsDataType, PublishedDataSetCustomSourceDataType, PublishedDataSetDataType, PublishedDataSetSourceDataType, PublishedEventsDataType, PublishedVariableDataType, PublishRequest, PublishResponse, PubSubConfiguration2DataType, PubSubConfigurationDataType, PubSubConfigurationRefDataType, PubSubConfigurationValueDataType, PubSubConnectionDataType, PubSubGroupDataType, PubSubKeyPushTargetDataType, QosDataType, QuantityDimension, QueryDataDescription, QueryDataSet, QueryFirstRequest, QueryFirstResponse, QueryNextRequest, QueryNextResponse, Range, RationalNumber, ReadAnnotationDataDetails, ReadAtTimeDetails, ReaderGroupDataType, ReaderGroupMessageDataType, ReaderGroupTransportDataType, ReadEventDetails, ReadEventDetails2, ReadEventDetailsSorted, ReadProcessedDetails, ReadRawModifiedDetails, ReadRequest, ReadResponse, ReadValueId, ReceiveQosDataType, ReceiveQosPriorityDataType, RedundantServerDataType, ReferenceDescription, ReferenceDescriptionDataType, ReferenceListEntryDataType, ReferenceTypeAttributes, RegisteredServer, RegisterNodesRequest, RegisterNodesResponse, RegisterServer2Request, RegisterServer2Response, RegisterServerRequest, RegisterServerResponse, RelativePath, RelativePathElement, RepublishRequest, RepublishResponse, RequestHeader, ResponseHeader, RolePermissionType, SamplingIntervalDiagnosticsDataType, SecurityGroupDataType, SecuritySettingsDataType, SemanticChangeStructureDataType, ServerDiagnosticsSummaryDataType, ServerEndpointDataType, ServerOnNetwork, ServerStatusDataType, ServiceCertificateDataType, ServiceCounterDataType, ServiceFault, SessionDiagnosticsDataType, SessionlessInvokeRequestType, SessionlessInvokeResponseType, SessionSecurityDiagnosticsDataType, SetMonitoringModeRequest, SetMonitoringModeResponse, SetPublishingModeRequest, SetPublishingModeResponse, SetTriggeringRequest, SetTriggeringResponse, SignatureData, SignedSoftwareCertificate, SimpleAttributeOperand, SimpleTypeDescription, SortRuleElement, SpanContextDataType, StandaloneSubscribedDataSetDataType, StandaloneSubscribedDataSetRefDataType, StatusChangeNotification, StatusResult, StructureDefinition, StructureDescription, StructureField, SubscribedDataSetDataType, SubscribedDataSetMirrorDataType, SubscriptionAcknowledgement, SubscriptionDiagnosticsDataType, TargetVariablesDataType, ThreeDCartesianCoordinates, ThreeDFrame, ThreeDOrientation, ThreeDVector, TimeZoneDataType, TraceContextDataType, TransactionErrorType, TransferResult, TransferSubscriptionsRequest, TransferSubscriptionsResponse, TranslateBrowsePathsToNodeIdsRequest, TranslateBrowsePathsToNodeIdsResponse, TransmitQosDataType, TransmitQosPriorityDataType, TrustListDataType, UABinaryFileDataType, UadpDataSetReaderMessageDataType, UadpDataSetWriterMessageDataType, UadpWriterGroupMessageDataType, Union, UnregisterNodesRequest, UnregisterNodesResponse, UnsignedRationalNumber, UpdateDataDetails, UpdateEventDetails, UpdateStructureDataDetails, UserIdentityToken, UserManagementDataType, UserNameIdentityToken, UserTokenPolicy, UserTokenSettingsDataType, VariableAttributes, VariableTypeAttributes, Vector, ViewAttributes, ViewDescription, WriteRequest, WriteResponse, WriterGroupDataType, WriterGroupMessageDataType, WriterGroupTransportDataType, WriteValue, X509IdentityToken, XVType

public interface Structure
extends IEncodeable, Cloneable, UaNamespaceTranslateable<Structure>

Interface for all Complex DataTypes of OPC UA, i.e. Structure DataTypes. Instances handled either by generated code, such as ServerStatusDataType or handled by DynamicStructure. In either case, metadata regarding the Structure is held in a StructureSpecification obtainable from an EncoderContext. In general only the SDK or Codegen should implement this interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Structure.Builder Base interface for all Builders of all Structures.
static class	Structure.MapKind<T> Marker for different kinds of maps for toMap(MapKind).

Nested classes/interfaces inherited from interface com.prosysopc.ua.UaNamespaceTranslateable

UaNamespaceTranslateable.Context

Method Summary

Modifier and Type	Method and Description
void	clear() Sets all fields to their default values (i.e.
Structure	clone() As every Structure is Cloneable, this method provides convinience method for calling .clone for an unknown Structure.
default <E extends Exception> void	forEachField(CheckedBiConsumer<FieldSpecification,Object,E> operation) Calls the given CheckedBiConsumer for each of the specification() fields with the value of the field.
default <E extends Exception> void	forEachField(StructureSpecification other, CheckedBiConsumer<FieldSpecification,Object,E> operation) Calls the given CheckedBiConsumer for each of the given specification (see toFieldNamesMap(StructureSpecification) on the restrictions of the given StructureSpecification) fields with the value of the field.
Object	get(FieldSpecification field) Get the value of the given field.
Object	get(String fieldName) Get the value of the given field.
default <T,E extends Exception> T	reduceFields(StructureSpecification other, T initialState, CheckedTriFunction<T,FieldSpecification,Object,T,E> reducer) Similar to reduceFields(Object, CheckedTriFunction), but considers only fields of the given StructureSpecification, similar to forEachField(StructureSpecification, CheckedBiConsumer).
default <T,E extends Exception> T	reduceFields(T initialState, CheckedTriFunction<T,FieldSpecification,Object,T,E> reducer) Calls the given CheckedTriFunction in fields order.
void	set(FieldSpecification field, Object value) Sets a new value for a field.
void	set(String fieldName, Object value) Sets a new value for a field.
StructureSpecification	specification() Returns the specification of the given Structure.
Structure.Builder	toBuilder() Returns a builder with the data of this Structure pre-set.
Map<String,Object>	toFieldNamesMap() Same as toFieldsMap(), but uses FieldSpecification.getName() as the key.
Map<String,Object>	toFieldNamesMap(StructureSpecification other) Same as toFieldsMap(StructureSpecification), but uses FieldSpecification.getName() as the key.
Map<FieldSpecification,Object>	toFieldsMap() Splits this Structure to a Map where keys are the FieldSpecification (from specification()) and values as-if get(FieldSpecification) would have been called per each field.
Map<FieldSpecification,Object>	toFieldsMap(StructureSpecification other) "Casts" this Structure based on the given StructureSpecification and then split it to it's fields similar to toFieldsMap().
default <T> T	toMap(Structure.MapKind<T> kind) Converts this Structure to a Map.
default Structure	withTranslatedNamespaces(UaNamespaceTranslateable.Context context) Returns a deep copy of itself where all where every namespace index and uri plus server index and uri (see ExpandedNodeId, UaExpandedNodeId) has been swapped based on the given UaNamespaceTranslateable.Context.

Method Detail

get

Object get(String fieldName)

Get the value of the given field. Note that the fieldName must be the name of one of the FieldSpecifications in the specification given by specification().

Parameters:

fieldName - name of the field

Returns:

the value of the field (can be null)

Throws:

IllegalArgumentException - if the given field does not exist.

clear

void clear()

Sets all fields to their default values (i.e. null). After the call the state of this Structure shall the same as a newly created instance where no fields have been set.

clone

Structure clone()

As every Structure is Cloneable, this method provides convinience method for calling .clone for an unknown Structure. Classes implementing Structure should change the signature to return the type of the implementing class. Returns a deep clone of this Structure object.

forEachField

default <E extends Exception> void forEachField(CheckedBiConsumer<FieldSpecification,Object,E> operation)
                                         throws E extends Exception

Calls the given CheckedBiConsumer for each of the specification() fields with the value of the field. Note that for Unions this will also happen for each field (but only at most one of them has a non-null value). This gives similar results as doing Map.forEach(BiConsumer) for toFieldsMap(), but may perform better.

Throws:

E extends Exception

forEachField

default <E extends Exception> void forEachField(StructureSpecification other,
                                                CheckedBiConsumer<FieldSpecification,Object,E> operation)
                                         throws E extends Exception

Calls the given CheckedBiConsumer for each of the given specification (see toFieldNamesMap(StructureSpecification) on the restrictions of the given StructureSpecification) fields with the value of the field. Note that for Unions this will also happen for each field (but only at most one of them has a non-null value). This gives similar results as doing Map.forEach(BiConsumer) for toFieldsMap(StructureSpecification), but may perform better.

Throws:

E extends Exception

get

Object get(FieldSpecification field)

Get the value of the given field.

Parameters:

field - specification of a field, must be one of the fields in the specification given by specification().

Returns:

the value of the field (can be null)

Throws:

IllegalArgumentException - if the given field is not one of the fields of the specification().

reduceFields

default <T,E extends Exception> T reduceFields(StructureSpecification other,
                                               T initialState,
                                               CheckedTriFunction<T,FieldSpecification,Object,T,E> reducer)
                                        throws E extends Exception

Similar to reduceFields(Object, CheckedTriFunction), but considers only fields of the given StructureSpecification, similar to forEachField(StructureSpecification, CheckedBiConsumer).

Throws:

E extends Exception

reduceFields

default <T,E extends Exception> T reduceFields(T initialState,
                                               CheckedTriFunction<T,FieldSpecification,Object,T,E> reducer)
                                        throws E extends Exception

Calls the given CheckedTriFunction in fields order. For the first field the first input is the given initialState, for the second field it is the output of the first invocation and so on. Returns the final output, or the initial state if this type contains 0 fields.

Throws:

E extends Exception

set

void set(FieldSpecification field,
         Object value)

Sets a new value for a field. Note that the field must be an existing one i.e. one of the fields of specification(). Setting an Optional Field to null will make it not present for encoding. Setting a Field in an Union will unset other fields.

Parameters:

field - specification of a field, must be one of the fields in the specification given by specification().

value - the value of the field (can be null)

Throws:

IllegalArgumentException - if the given field is not one of the fields of the specification().

set

void set(String fieldName,
         Object value)

Sets a new value for a field. Note that the fieldName must be the name of one of the FieldSpecifications in the specification given by specification(). Setting an Optional Field to null will make it not present for encoding. Setting a Field in an Union will unset other fields.

Parameters:

fieldName - the field, must be the name of one of the FieldSpecifications in the specification given by specification().

value - new value for the given field, can be null.

Throws:

IllegalArgumentException - if the given field is not one of #getFields()

specification

StructureSpecification specification()

Returns the specification of the given Structure. Can be used to dynamically display the fields of the Structure.

toBuilder

Structure.Builder toBuilder()

Returns a builder with the data of this Structure pre-set. The returned builder shall return instances of the same #getClass() as this one.

toFieldNamesMap

Map<String,Object> toFieldNamesMap()

Same as toFieldsMap(), but uses FieldSpecification.getName() as the key.

toFieldNamesMap

Map<String,Object> toFieldNamesMap(StructureSpecification other)

Same as toFieldsMap(StructureSpecification), but uses FieldSpecification.getName() as the key.

toFieldsMap

Map<FieldSpecification,Object> toFieldsMap()

Splits this Structure to a Map where keys are the FieldSpecification (from specification()) and values as-if get(FieldSpecification) would have been called per each field. The iteration order of the Map is the order of the fields. The returned Map is unmodifiable.

toFieldsMap

Map<FieldSpecification,Object> toFieldsMap(StructureSpecification other)

"Casts" this Structure based on the given StructureSpecification and then split it to it's fields similar to toFieldsMap().

Throws IllegalArgumentException if the casting cannot be made, which happens if the given StructureSpecification is not part of the inheritance hierarchy of this Structure, i.e. the given StructureSpecification must be one of 1. the same as specification() or 2. a supertype of this specification() or 3. a subtype of this specification(). This method only uses UaDataTypeSpecification.getTypeId(), StructureSpecification.getSuperTypeIds() and FieldSpecification.getName() i.e. it is assumed that the given specification is from the same context (client, server, pubsub) as this specification().

The return is a Map where keys are the FieldSpecification (from the given specification) and values as-if get(FieldSpecification) would have been called per each field (for the casted Structure). The iteration order of the Map is the order of the fields. The returned Map is unmodifiable.

This method mainly exist for encoding purposes , where Structure fields that are Structures themselves must be encoded as the specified type (unless FieldSpecification.isAllowSubTypes() is true.

toMap

default <T> T toMap(Structure.MapKind<T> kind)

Converts this Structure to a Map.

withTranslatedNamespaces

default Structure withTranslatedNamespaces(UaNamespaceTranslateable.Context context)

Description copied from interface: UaNamespaceTranslateable

Returns a deep copy of itself where all where every namespace index and uri plus server index and uri (see ExpandedNodeId, UaExpandedNodeId) has been swapped based on the given UaNamespaceTranslateable.Context. Returning the same object is allowed if the type is immutable and the result is equal to this. Note that for Structure types if the UaDataTypeSpecification translation is active the returned type can be of different java class.

Specified by:

withTranslatedNamespaces in interface UaNamespaceTranslateable<Structure>