com.prosysopc.ua.server

Class ContentFilterDefinition

java.lang.Object

com.prosysopc.ua.server.ContentFilterDefinition

public class ContentFilterDefinition
extends Object

Constructor Summary

Constructors

Constructor and Description
ContentFilterDefinition() Creates new empty ContentFilterDefinition.

Method Summary

Modifier and Type	Method and Description
Boolean	evaluate(EventData eventData, Boolean defaultResult) Evaluates the filter against an EventData.
DiagnosticInfo[]	getElementDiagnosticInfos() Returns ElementDiagnosticInfos based on the parse(ContentFilter, NodeManagerRoot).
ContentFilterElementResult[]	getElementResults() Returns ElementResults based on the parse(ContentFilter, NodeManagerRoot).
void	parse(ContentFilter contentFilter, NodeManagerRoot nodeManagerRoot) Parses the given ContentFilter (any previous is lost), after parsing evaluate(EventData, Boolean) can be used to evaluate events vs.
static void	parseEventFilter(NodeManagerRoot nodeManagerRoot, EventFilter eventFilter, List<List<QualifiedName>> fieldPaths, ContentFilterDefinition filterDefinition, EventFilterResult eventFilterResult) Parse an EventFilter to fieldPaths and filterDefinition.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentFilterDefinition

public ContentFilterDefinition()

Creates new empty ContentFilterDefinition.

Method Detail

parseEventFilter

public static void parseEventFilter(NodeManagerRoot nodeManagerRoot,
                                    EventFilter eventFilter,
                                    List<List<QualifiedName>> fieldPaths,
                                    ContentFilterDefinition filterDefinition,
                                    EventFilterResult eventFilterResult)

Parse an EventFilter to fieldPaths and filterDefinition.

Parameters:

nodeManagerRoot - Node Manager used to find necessary nodes for the filter

eventFilter - the filter definition received from the client application

fieldPaths - the fieldPaths to fill in

filterDefinition - the content filter definition to fill in

eventFilterResult - the results of the filter evaluation

evaluate

public Boolean evaluate(EventData eventData,
                        Boolean defaultResult)

Evaluates the filter against an EventData.

Parameters:

eventData - The event data structure that is being checked. Only the fields that are defined in the EventData are checked.

defaultResult - the result in case the filter evaluates to null, due to missing fields or fields that have value null.

Returns:

true if the event passes the filter, i.e. it would be sent to the client of this monitored item.

getElementDiagnosticInfos

public DiagnosticInfo[] getElementDiagnosticInfos()

Returns ElementDiagnosticInfos based on the parse(ContentFilter, NodeManagerRoot).

getElementResults

public ContentFilterElementResult[] getElementResults()

Returns ElementResults based on the parse(ContentFilter, NodeManagerRoot).

parse

public void parse(ContentFilter contentFilter,
                  NodeManagerRoot nodeManagerRoot)

Parses the given ContentFilter (any previous is lost), after parsing evaluate(EventData, Boolean) can be used to evaluate events vs. the filter. Results of the parsing can be obtained from getElementResults() and getElementDiagnosticInfos().