com.prosysopc.ua

Class EventData

java.lang.Object

com.prosysopc.ua.EventData

public class EventData
extends Object

State of an event object, when an event is triggered. Instances should be constructed using the static factory methods, that may return a subtype.

EventData supports the Value Attribute for all paths except for the RelativeNamePath.EMPTY. For the RelativeNamePath.EMPTY EventData stores the NodeId Attribute. No other Attribute/Path combinations are supported.

Field Summary

Fields

Modifier and Type	Field and Description
static RelativeNamePath	EVENT_ID_PATH The browse path to the EventId field.
static RelativeNamePath	EVENT_TYPE_PATH The browse path to the EventType field.
static RelativeNamePath	NODE_ID_PATH The browse path to the Event instance root node.
static RelativeNamePath	TIME_PATH The browse path to the Time field.

Constructor Summary

Constructors

Modifier	Constructor and Description
	EventData(NodeId nodeId, ByteString eventId) Deprecated. use raw(NodeId, ByteString) instead.
protected	EventData(NodeId nodeId, ByteString eventId, Set<NodeId> typeHierarchy) Internal method, signature may change in future versions, creates new EventData.
	EventData(UaNode node, ByteString eventId) Deprecated. use #fromNodeHierarchy(UaNode, ByteString) instead.
protected	EventData(UaNode node, ByteString eventId, Set<NodeClass> excludeNodeClasses, boolean calculateTypeHierarchy) Internal method, signature may change in future versions, creates new EventData.

Method Summary

Modifier and Type	Method and Description
void	addComment(LocalizedText comment) Adds a comment to the event.
static EventData	fromNodeHierarchy(UaNode node, ByteString eventId, Iterable<NodeClass> excludeNodeClasses) Creates a new EventData structure using the current field values of an event node and it's subnodes.
static EventData	fromNodeHierarchy(UaNode node, ByteString eventId, NodeClass... excludeNodeClasses) Creates a new EventData structure using the current field values of an event node and it's subnodes.
LocalizedText[]	getComments() Returns the current comments.
ByteString	getEventId() The unique EventId of the event.
UaType	getEventType() The EventType as a reference to a UaType node.
NodeId	getEventTypeId() The EventType as a NodeId.
Set<RelativeNamePath>	getFieldNames() Return unmodifiable Set of all event fields i.e.
Variant	getFieldValue(List<QualifiedName> fieldPath) Read the value of an event field.
Variant	getFieldValue(QualifiedName[] fieldPath) Read the value of an event field.
Variant	getFieldValue(RelativeNamePath fieldPath) Read the value of an event field.
Variant	getFieldValue(SimpleAttributeOperand field) Returns field values for the given field.
Variant[]	getFieldValues(List<List<QualifiedName>> fieldPaths) Get the field values corresponding to the provided fieldPaths.
Variant[]	getFieldValues(SimpleAttributeOperand[] fields) Returns field values for the given fields (in the relative indexes).
NodeId	getNodeId() The ID of the node that generated the event.
DateTime	getTime() Returns the value of TIME_PATH BrowsePath, or DateTime.MIN_VALUE if none exist.
Set<NodeId>	getTypeHierarchy() Returns event type and all supertypes of it as an unmodifiable Set (iteration order is not defined).
static EventData	raw(NodeId nodeId, ByteString eventId) Create a new (blank) EventData structure.
static EventData	raw(NodeId nodeId, ByteString eventId, Set<NodeId> typeHierarchy) Create a new (blank) EventData structure.
void	setEventType(UaType eventType) Allows setting an event type UaNode to be used for EVENT_TYPE_PATH BrowsePath.
void	setFieldValue(List<QualifiedName> browsePath, Variant value) Set the value of an event field in the EventData structure.
void	setFieldValue(QualifiedName[] browsePath, Variant value) Set the value of an event field in the EventData structure.
void	setFieldValue(RelativeNamePath browsePath, Variant value) Set the value of an event field in the EventData structure.
void	setTypeHierarchy(Set<NodeId> typeHierarchy) Sets the type hierarchy.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NODE_ID_PATH

public static final RelativeNamePath NODE_ID_PATH

The browse path to the Event instance root node. Used in getNodeId(). This path is special since it is an empty (empty QualifiedNames array, in practice), which instead of a selecting a sub-node selects the main (root) node of the Event instance. Same as RelativeNamePath.EMPTY.

EVENT_TYPE_PATH

public static final RelativeNamePath EVENT_TYPE_PATH

The browse path to the EventType field. Used in getEventTypeId().

EVENT_ID_PATH

public static final RelativeNamePath EVENT_ID_PATH

The browse path to the EventId field. Used in getEventId().

TIME_PATH

public static final RelativeNamePath TIME_PATH

The browse path to the Time field. Used in getTime().

Constructor Detail

EventData

@Deprecated
public EventData(NodeId nodeId,
                              ByteString eventId)

Deprecated. use raw(NodeId, ByteString) instead.

Create a new EventData structure. Use setFieldValue(java.util.List<com.prosysopc.ua.stack.builtintypes.QualifiedName>, com.prosysopc.ua.stack.builtintypes.Variant) to define the values of the event fields.

Parameters:

nodeId - the event or condition node that generated the event

eventId - the ID of the event occurrence

EventData

@Deprecated
public EventData(UaNode node,
                              ByteString eventId)

Deprecated. use #fromNodeHierarchy(UaNode, ByteString) instead.

Create a new EventData structure using the current field values of an event node.

Parameters:

node - the event or condition node that generated the event

eventId - the ID of the event occurrence

EventData

protected EventData(NodeId nodeId,
                    ByteString eventId,
                    Set<NodeId> typeHierarchy)

Internal method, signature may change in future versions, creates new EventData.

EventData

protected EventData(UaNode node,
                    ByteString eventId,
                    Set<NodeClass> excludeNodeClasses,
                    boolean calculateTypeHierarchy)

Internal method, signature may change in future versions, creates new EventData.

Method Detail

fromNodeHierarchy

public static EventData fromNodeHierarchy(UaNode node,
                                          ByteString eventId,
                                          Iterable<NodeClass> excludeNodeClasses)

Creates a new EventData structure using the current field values of an event node and it's subnodes.

Parameters:

node - the event or condition node that generated the event

eventId - the ID of the event occurrence

excludeNodeClasses - 0 or more NodeClasses to exclude during calculating the node hierarchy. Also excludes any subnodes under the excluded nodes, recursively.

fromNodeHierarchy

public static EventData fromNodeHierarchy(UaNode node,
                                          ByteString eventId,
                                          NodeClass... excludeNodeClasses)

Creates a new EventData structure using the current field values of an event node and it's subnodes.

Parameters:

node - the event or condition node that generated the event

eventId - the ID of the event occurrence

excludeNodeClasses - 0 or more NodeClasses to exclude during calculating the node hierarchy. Also excludes any subnodes under the excluded nodes, recursively.

raw

public static EventData raw(NodeId nodeId,
                            ByteString eventId)

Create a new (blank) EventData structure. Use setFieldValue(java.util.List<com.prosysopc.ua.stack.builtintypes.QualifiedName>, com.prosysopc.ua.stack.builtintypes.Variant) to define the values of the event fields. It is recommended when possible to use raw(NodeId, ByteString, Set) and give the TypeDefinition hierarchy of the event type. Without hierarchy getFieldValue(SimpleAttributeOperand) and getFieldValues(SimpleAttributeOperand[]) wont use SimpleAttributeOperand.getTypeDefinitionId() as part of the filtering process, which can lead into ambiguous situations if a client used more than one SimpleAttributeOperand.getBrowsePath() with different SimpleAttributeOperand.getTypeDefinitionId().

Parameters:

nodeId - the event or condition node that generated the event

eventId - the ID of the event occurrence

raw

public static EventData raw(NodeId nodeId,
                            ByteString eventId,
                            Set<NodeId> typeHierarchy)

Create a new (blank) EventData structure. Use setFieldValue(java.util.List<com.prosysopc.ua.stack.builtintypes.QualifiedName>, com.prosysopc.ua.stack.builtintypes.Variant) to define the values of the event fields. The given type hierarchy Set should contain the TypeDefinition and all supertypes of the given NodeId (the Set can be empty, but then this method behaves the same as raw(NodeId, ByteString)). Assuming type hierarchy is given, it is used in getFieldValue(SimpleAttributeOperand) and getFieldValues(SimpleAttributeOperand[]) to resolve SimpleAttributeOperand.getTypeDefinitionId(). If type hierarchy is not given (the set is empty), then SimpleAttributeOperand.getTypeDefinitionId() is not used as part of the filtering process.

Parameters:

nodeId - the event or condition node that generated the event

eventId - the ID of the event occurrence

typeHierarchy - a Set containing the TypeDefinition NodeId of the #nodeId parameter and all supertypes of it.

addComment

public void addComment(LocalizedText comment)

Adds a comment to the event.

Parameters:

comment - text for the comment.

getComments

public LocalizedText[] getComments()

Returns the current comments.

getEventId

public ByteString getEventId()

The unique EventId of the event. EventIds are used to identify event occurrences. Whenever the state of the condition changes, for example, a new event with a new ID is generated.

Returns:

the unique EventId.

getEventType

public UaType getEventType()

The EventType as a reference to a UaType node. The node is not defined by default, but may be provided using the setEventType(UaType) method. In case the node is not be available, use getEventTypeId() and define the node for further use, if possible.

Returns:

the eventType or null if not defined

getEventTypeId

public NodeId getEventTypeId()

The EventType as a NodeId. The event type is defined by the "EventType" field.

Returns:

the value of "EventType" field. The NodeId of the event type.

See Also:

getEventType()

getFieldNames

public Set<RelativeNamePath> getFieldNames()

Return unmodifiable Set of all event fields i.e. paths that could be selected by an EventFilter. Note that only paths that do have a value exist in the Set, a client can also select paths that do not exist here (those will get a null value in the event notification).

getFieldValue

public Variant getFieldValue(List<QualifiedName> fieldPath)

Read the value of an event field.

Parameters:

fieldPath - the browse path to the field of the event to read

Returns:

the value of field

getFieldValue

public Variant getFieldValue(QualifiedName[] fieldPath)

Read the value of an event field.

Parameters:

fieldPath - the browse path to the field of the event to read

Returns:

the value of field

getFieldValue

public Variant getFieldValue(RelativeNamePath fieldPath)

Read the value of an event field.

getFieldValue

public Variant getFieldValue(SimpleAttributeOperand field)

Returns field values for the given field. If This EventData was constructed in a way that the type hierarchy of the EventType was resolvable, then assuming SimpleAttributeOperand.getTypeDefinitionId() is found from the hierarchy the returned value (per index) is same as calling getFieldValue(QualifiedName[]) with SimpleAttributeOperand.getBrowsePath(), otherwise Variant.NULL is returned. If this EventData was not constructed as EventType hierarchy aware, then the SimpleAttributeOperand.getTypeDefinitionId() is skipped and getFieldValue(QualifiedName[]) is returned always in the index. Returns Variant.NULL if given null.

getFieldValues

public Variant[] getFieldValues(List<List<QualifiedName>> fieldPaths)

Get the field values corresponding to the provided fieldPaths.

Parameters:

fieldPaths - BrowsePaths to collect as values.

Returns:

the Values matching each requested BrowsePath.

getFieldValues

public Variant[] getFieldValues(SimpleAttributeOperand[] fields)

Returns field values for the given fields (in the relative indexes). Returns null if given null. Null SimpleAttributeOperand results in a null in the return array. If This EventData was constructed in a way that the type hierarchy of the EventType was resolvable, then assuming SimpleAttributeOperand.getTypeDefinitionId() is found from the hierarchy the returned value (per index) is same as calling getFieldValue(QualifiedName[]) with SimpleAttributeOperand.getBrowsePath(), otherwise Variant.NULL is returned. If this EventData was not constructed as EventType hierarchy aware, then the SimpleAttributeOperand.getTypeDefinitionId() is skipped and getFieldValue(QualifiedName[]) is returned always in the index.

getNodeId

public NodeId getNodeId()

The ID of the node that generated the event.

Returns:

the NodeId "field"

getTime

public DateTime getTime()

Returns the value of TIME_PATH BrowsePath, or DateTime.MIN_VALUE if none exist.

getTypeHierarchy

public Set<NodeId> getTypeHierarchy()

Returns event type and all supertypes of it as an unmodifiable Set (iteration order is not defined). Note that this Set is empty if this EventData was not created with the hierarchy.

setEventType

public void setEventType(UaType eventType)

Allows setting an event type UaNode to be used for EVENT_TYPE_PATH BrowsePath.

setFieldValue

public void setFieldValue(List<QualifiedName> browsePath,
                          Variant value)

Set the value of an event field in the EventData structure.

You typically only need to use this method, if you do not provide the UaNode to the EventData in the constructor. If you do provide it, the field values are added to the EventData automatically.

Parameters:

browsePath - The browse path to the field (e.g. property) of the event.

value - the value of the field

setFieldValue

public void setFieldValue(QualifiedName[] browsePath,
                          Variant value)

Set the value of an event field in the EventData structure.

Parameters:

browsePath - The browse path to the field (e.g. property) of the event.

value - the value of the field

setFieldValue

public void setFieldValue(RelativeNamePath browsePath,
                          Variant value)

Set the value of an event field in the EventData structure.

Parameters:

browsePath - The browse path to the field (e.g. property) of the event.

value - the value of the field

setTypeHierarchy

public void setTypeHierarchy(Set<NodeId> typeHierarchy)

Sets the type hierarchy. Shall contain the TypeDefinitionId of the Event type and all super types, or be empty. In general only an aggregation server needing to rewrite NamespaceIndexes should need to call this.

toString

public String toString()

Overrides:

toString in class Object