com.prosysopc.ua.typedictionary

Interface FieldSpecification

All Superinterfaces:

UaNamespaceTranslateable<FieldSpecification>

All Known Implementing Classes:

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

public interface FieldSpecification
extends UaNamespaceTranslateable<FieldSpecification>

This interface defines a Specification for a Field of a Structure to allow dynamic handling. Only SDK (and Codegen) should make implementations of this interface. All implementations shall be immutable. For custom Structures types defined in code use builder() to create a FieldSpecification.Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FieldSpecification.Builder Builder for FieldSpecification.

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

UaNamespaceTranslateable.Context

Method Summary

Modifier and Type	Method and Description
static FieldSpecification.Builder	builder() Creates new FieldSpecification.Builder.
UaArrayDimensions	getArrayDimensions() Returns ArrayDimensions of the field (or null if not known).
default Class<?>	getCompositeClass() Returns the "non-array" version of type (the Class) of the field.
UaNodeId	getDataTypeId() Returns the DataType node's NodeId of the UA type of this field.
String	getDescription() Returns Description of the field.
default UaNodeId	getEncodeTypeId() Mostly for internal use.
int	getFieldIndex() Returns a "field index" position of this field.
Class<?>	getJavaClass() Returns the java Class of the field.
int	getJavaClassDimensions() Returns the dimensions this field has.
int	getMaxStringLength() Maximum length of a String this field can have (or 0 if not known or the field is not a String type).
String	getName() Returns the name of the field.
int	getValueRank() Returns the ValueRank defining the number of dimensions of the field.
default String	getXmlName() Internal.
boolean	isAllowSubTypes() Returns true if the field allows sub types to be set.
boolean	isArray() Returns true if this field is an (potentially multidimensional) array.
boolean	isOptional() Returns true if the field is optional.
default FieldSpecification.Builder	toBuilder() Return a new FieldSpecification.Builder with the data of this FieldSpecification preset.
default FieldSpecification	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

builder

static FieldSpecification.Builder builder()

Creates new FieldSpecification.Builder.

getArrayDimensions

UaArrayDimensions getArrayDimensions()

Returns ArrayDimensions of the field (or null if not known).

getCompositeClass

default Class<?> getCompositeClass()

Returns the "non-array" version of type (the Class) of the field. For scalar values this is the same as getJavaClass(), for array fields this is the element type of the array.

getDataTypeId

UaNodeId getDataTypeId()

Returns the DataType node's NodeId of the UA type of this field. For types read from a TypeDictionary this is a best-effort guess and might be null.

Returns:

DataTypeId of the field, can be null if unknown.

getDescription

String getDescription()

Returns Description of the field. Can be null if not known.

getEncodeTypeId

default UaNodeId getEncodeTypeId()

Mostly for internal use. For non-isAllowSubTypes() returns the same as getDataTypeId(). For AllowSubTypes fields returns UaDataTypeIds.Structure for Structure fields and UaDataTypeIds.BaseDataType for others (AllowSubTypes fields are binary-encoded as ExtensionObject or Variant, depending on the type).

getFieldIndex

int getFieldIndex()

Returns a "field index" position of this field. Mostly intended for SDK internal use. The fields of a Structure can be thought as an Object[], this gives a suitable index (first field is 0, second is 1 and so on).

getJavaClass

Class<?> getJavaClass()

Returns the java Class of the field. If the field is array type, then this Class object also is an array version, e.g. for a scalar Double field this returns Double.class, for 1-dim Double field Double[].class and for 2-dim Double[][].class and so on.

getJavaClassDimensions

int getJavaClassDimensions()

Returns the dimensions this field has. The return is the same as MultiDimensionArrayUtils.getClassDimensions(getJavaClass()). For non-scalar fields this return is equal to the getValueRank(), for scalar this returns 0.

getMaxStringLength

int getMaxStringLength()

Maximum length of a String this field can have (or 0 if not known or the field is not a String type). If an array applies to each element.

getName

String getName()

Returns the name of the field.

getValueRank

int getValueRank()

Returns the ValueRank defining the number of dimensions of the field. Either -1 (scalar) or a fixed number of dimensions (1+).

getXmlName

default String getXmlName()

Internal. Application code shouldn't use this, but SDK may use this instead of getName() if more context is available, such as symbolic names in NodeSet documents. Returns same as getName() if there no such context.

isAllowSubTypes

boolean isAllowSubTypes()

Returns true if the field allows sub types to be set.

isArray

boolean isArray()

Returns true if this field is an (potentially multidimensional) array. Returns false if it is a scalar.

isOptional

boolean isOptional()

Returns true if the field is optional.

toBuilder

default FieldSpecification.Builder toBuilder()

Return a new FieldSpecification.Builder with the data of this FieldSpecification preset.

withTranslatedNamespaces

default FieldSpecification 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<FieldSpecification>