org.eclipse.milo.opcua.sdk.core

Class Reference

java.lang.Object

org.eclipse.milo.opcua.sdk.core.Reference

public class Reference
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Reference.Direction

Field Summary

Fields

Modifier and Type	Field and Description
static Predicate<Reference>	ALWAYS_GENERATES_EVENT_PREDICATE
static Predicate<Reference>	COMPONENT_OF_PREDICATE
static Predicate<Reference>	HAS_COMPONENT_PREDICATE
static Predicate<Reference>	HAS_DESCRIPTION_PREDICATE
static Predicate<Reference>	HAS_ENCODING_PREDICATE
static Predicate<Reference>	HAS_EVENT_SOURCE_PREDICATE
static Predicate<Reference>	HAS_MODELLING_RULE_PREDICATE
static Predicate<Reference>	HAS_NOTIFIER_PREDICATE
static Predicate<Reference>	HAS_ORDERED_COMPONENT_PREDICATE
static Predicate<Reference>	HAS_PROPERTY_PREDICATE
static Predicate<Reference>	HAS_SUBTYPE
static Predicate<Reference>	HAS_TYPE_DEFINITION_PREDICATE
static Predicate<Reference>	ORDERED_COMPONENT_OF_PREDICATE
static Predicate<Reference>	ORGANIZES_PREDICATE
static Predicate<Reference>	SUBTYPE_OF

Constructor Summary

Constructors

Constructor and Description
Reference(NodeId sourceNodeId, NodeId referenceTypeId, ExpandedNodeId targetNodeId, boolean forward)
Reference(NodeId sourceNodeId, NodeId referenceTypeId, ExpandedNodeId targetNodeId, Reference.Direction direction)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Reference.Direction	getDirection()
NodeId	getReferenceTypeId()
NodeId	getSourceNodeId()
ExpandedNodeId	getTargetNodeId()
int	hashCode()
Optional<Reference>	invert(NamespaceTable namespaceTable) Return an inverted instance of this Reference so long as the target NodeId resides within this server.
boolean	isForward()
boolean	isInverse()
Reference	reindex(NamespaceTable namespaceTable, String sourceNamespaceUri, String referenceNamespaceUri, String targetNamespaceUri) Re-index the source, target, and reference type NodeIds in this Reference from their current namespace index to the index for namespaceUri.
boolean	subtypeOf(NodeId superTypeId) Check if this reference is a subtype of the built-in reference identified by superTypeId.
boolean	subtypeOf(NodeId superTypeId, Map<NodeId,ReferenceType> referenceTypes)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HAS_COMPONENT_PREDICATE

public static final Predicate<Reference> HAS_COMPONENT_PREDICATE

HAS_ORDERED_COMPONENT_PREDICATE

public static final Predicate<Reference> HAS_ORDERED_COMPONENT_PREDICATE

COMPONENT_OF_PREDICATE

public static final Predicate<Reference> COMPONENT_OF_PREDICATE

ORDERED_COMPONENT_OF_PREDICATE

public static final Predicate<Reference> ORDERED_COMPONENT_OF_PREDICATE

HAS_PROPERTY_PREDICATE

public static final Predicate<Reference> HAS_PROPERTY_PREDICATE

HAS_TYPE_DEFINITION_PREDICATE

public static final Predicate<Reference> HAS_TYPE_DEFINITION_PREDICATE

HAS_EVENT_SOURCE_PREDICATE

public static final Predicate<Reference> HAS_EVENT_SOURCE_PREDICATE

HAS_NOTIFIER_PREDICATE

public static final Predicate<Reference> HAS_NOTIFIER_PREDICATE

ORGANIZES_PREDICATE

public static final Predicate<Reference> ORGANIZES_PREDICATE

HAS_ENCODING_PREDICATE

public static final Predicate<Reference> HAS_ENCODING_PREDICATE

HAS_DESCRIPTION_PREDICATE

public static final Predicate<Reference> HAS_DESCRIPTION_PREDICATE

HAS_MODELLING_RULE_PREDICATE

public static final Predicate<Reference> HAS_MODELLING_RULE_PREDICATE

ALWAYS_GENERATES_EVENT_PREDICATE

public static final Predicate<Reference> ALWAYS_GENERATES_EVENT_PREDICATE

HAS_SUBTYPE

public static final Predicate<Reference> HAS_SUBTYPE

SUBTYPE_OF

public static final Predicate<Reference> SUBTYPE_OF

Constructor Detail

Reference

public Reference(NodeId sourceNodeId,
                 NodeId referenceTypeId,
                 ExpandedNodeId targetNodeId,
                 boolean forward)

Reference

public Reference(NodeId sourceNodeId,
                 NodeId referenceTypeId,
                 ExpandedNodeId targetNodeId,
                 Reference.Direction direction)

Method Detail

getSourceNodeId

public NodeId getSourceNodeId()

getReferenceTypeId

public NodeId getReferenceTypeId()

getTargetNodeId

public ExpandedNodeId getTargetNodeId()

getDirection

public Reference.Direction getDirection()

isForward

public boolean isForward()

isInverse

public boolean isInverse()

invert

public Optional<Reference> invert(NamespaceTable namespaceTable)

Return an inverted instance of this Reference so long as the target NodeId resides within this server.

Returns:

an inverted instance of this Reference so long as the target NodeId resides within this server.

reindex

public Reference reindex(NamespaceTable namespaceTable,
                         String sourceNamespaceUri,
                         String referenceNamespaceUri,
                         String targetNamespaceUri)

Re-index the source, target, and reference type NodeIds in this Reference from their current namespace index to the index for namespaceUri.

If the target namespace URI is not present in the namespace table this Reference is returned.

Parameters:

namespaceTable - the NamespaceTable.

sourceNamespaceUri - the target namespace URI for the source NodeId.

referenceNamespaceUri - the target namespace URI for the reference type NodeId.

targetNamespaceUri - the target namespace URI for the target NodeId.

Returns:

a new NodeId in the namespace index indicated by namespaceUri.

subtypeOf

public boolean subtypeOf(NodeId superTypeId)

Check if this reference is a subtype of the built-in reference identified by superTypeId.

Parameters:

superTypeId - the NodeId of the supertype.

Returns:

true if this reference is a subtype of the built-in reference type identified by superTypeId.

See Also:

BuiltinReferenceType

subtypeOf

public boolean subtypeOf(NodeId superTypeId,
                         Map<NodeId,ReferenceType> referenceTypes)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object