Package com.inductiveautomation.ignition.common.alarming

Class AlarmFilter

java.lang.Object

com.inductiveautomation.ignition.common.alarming.query.AbstractFilter<AlarmEvent>

com.inductiveautomation.ignition.common.alarming.AlarmFilter

All Implemented Interfaces:

Condition<AlarmEvent>, Filter<AlarmEvent>, Serializable

public class AlarmFilter
extends AbstractFilter<AlarmEvent>

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Field<AlarmEvent,StringPath,PathCondition<StringPath>>	DISPPATH
static final Field<AlarmEvent,Path[],DisplayThenSourceCondition>	DISPPATH_THEN_SOURCE	Filters on display path then falls back to the source path if the display path has not been set.
static final Field<AlarmEvent,Date,DateTimeCondition>	EVENTTIME
static final Field<AlarmEvent,String,StringCondition>	EVENTUUID
static final int	FILTER_SYS	If system events are included, setting this flag will also ensure that they are included in filtering, instead of the all or nothing approach.
protected Flags	filterFlags
static final int	FLAG_EXCLUDE_SYS	If set, system events will not be allowed.
static final int	FLAG_FORCE_STATE_STRATEGY
static final int	FLAG_FORCE_TREE_STRATEGY	These are not-commonly-used flags for forcing how we query alarm status.
static final int	FLAG_INCLUDE_DATA	Used for historical querying, indicates that the results should include associated data.
static final int	FLAG_INCLUDE_SHELVED	If set, shelved events will be included in the result.
static final int	FLAG_ONLY_SYS	If set, only system events will be allowed.
static final int	FLAG_ORDER_BY_EVENT_TIME_ASC	Flag for determining whether to sort by event time
static final int	HIGHEST_PRIO_ONLY	For a particular source, only return the highest priority alarm.
static final Field<AlarmEvent,AlarmStateTransition,EnumCondition<AlarmStateTransition>>	LAST_STATE
static final Field<AlarmEvent,AlarmPriority,EnumCondition<AlarmPriority>>	PRIORITY
static final Field<AlarmEvent,PropertySet,PropertyCondition>	PROPS
static final Field<AlarmEvent,String,StringEnumCondition>	PROVIDER
static final Field<AlarmEvent,QualifiedPath,PathCondition<QualifiedPath>>	SOURCE
static final Field<AlarmEvent,Path[],SourceOrDisplayCondition>	SOURCE_OR_DISPPATH	Filters on either path OR display path.
static final Field<AlarmEvent,AlarmState,EnumCondition<AlarmState>>	STATE

Constructor Summary

Constructors

Constructor	Description
AlarmFilter()

Method Summary

Modifier and Type	Method	Description
Flags	getFlags()	Returns the flags for the filter, which are operation specific information that can be passed along.
LoggerEx	getLogger()
Map<String,Condition<?>>	getSerializableConditions()	Used only for serializing the AlarmFilter
boolean	passes(AlarmEvent value)	Returns whether the provided value passes the condition.
protected void	setRawFlags(Flags theFlags)	Used only for deserializing the AlarmFilter

Methods inherited from class com.inductiveautomation.ignition.common.alarming.query.AbstractFilter

addRawCondition, and, equals, getConditionFor, getRawConditions, hasConditionFor, hashCode, isOptimized, logCondition, markOptimized, removeCondition, resetOptimized, toString

Methods inherited from class java.lang.Object

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

Field Details

FLAG_INCLUDE_SHELVED

public static final int FLAG_INCLUDE_SHELVED

If set, shelved events will be included in the result.

See Also:

• Constant Field Values

HIGHEST_PRIO_ONLY

public static final int HIGHEST_PRIO_ONLY

For a particular source, only return the highest priority alarm.

See Also:

• Constant Field Values

FLAG_INCLUDE_DATA

public static final int FLAG_INCLUDE_DATA

Used for historical querying, indicates that the results should include associated data.

See Also:

• Constant Field Values

FLAG_EXCLUDE_SYS

public static final int FLAG_EXCLUDE_SYS

If set, system events will not be allowed.

See Also:

• Constant Field Values

FLAG_ONLY_SYS

public static final int FLAG_ONLY_SYS

If set, only system events will be allowed.

See Also:

• Constant Field Values

FILTER_SYS

public static final int FILTER_SYS

If system events are included, setting this flag will also ensure that they are included in filtering, instead of the all or nothing approach.

See Also:

• Constant Field Values

FLAG_FORCE_TREE_STRATEGY

public static final int FLAG_FORCE_TREE_STRATEGY

These are not-commonly-used flags for forcing how we query alarm status.

See Also:

• Constant Field Values

FLAG_FORCE_STATE_STRATEGY

public static final int FLAG_FORCE_STATE_STRATEGY

See Also:

• Constant Field Values

FLAG_ORDER_BY_EVENT_TIME_ASC

public static final int FLAG_ORDER_BY_EVENT_TIME_ASC

Flag for determining whether to sort by event time

See Also:

• Constant Field Values

SOURCE

public static final Field<AlarmEvent,QualifiedPath,PathCondition<QualifiedPath>> SOURCE

PROVIDER

public static final Field<AlarmEvent,String,StringEnumCondition> PROVIDER

DISPPATH

public static final Field<AlarmEvent,StringPath,PathCondition<StringPath>> DISPPATH

SOURCE_OR_DISPPATH

public static final Field<AlarmEvent,Path[],SourceOrDisplayCondition> SOURCE_OR_DISPPATH

Filters on either path OR display path.

DISPPATH_THEN_SOURCE

public static final Field<AlarmEvent,Path[],DisplayThenSourceCondition> DISPPATH_THEN_SOURCE

Filters on display path then falls back to the source path if the display path has not been set.

PRIORITY

public static final Field<AlarmEvent,AlarmPriority,EnumCondition<AlarmPriority>> PRIORITY

STATE

public static final Field<AlarmEvent,AlarmState,EnumCondition<AlarmState>> STATE

PROPS

public static final Field<AlarmEvent,PropertySet,PropertyCondition> PROPS

EVENTTIME

public static final Field<AlarmEvent,Date,DateTimeCondition> EVENTTIME

EVENTUUID

public static final Field<AlarmEvent,String,StringCondition> EVENTUUID

LAST_STATE

public static final Field<AlarmEvent,AlarmStateTransition,EnumCondition<AlarmStateTransition>> LAST_STATE

filterFlags

protected Flags filterFlags

Constructor Details

AlarmFilter

public AlarmFilter()

Method Details

getFlags

public Flags getFlags()

Returns the flags for the filter, which are operation specific information that can be passed along.

setRawFlags

protected void setRawFlags(Flags theFlags)

Used only for deserializing the AlarmFilter

passes

public boolean passes(AlarmEvent value)

Description copied from interface: Condition

Returns whether the provided value passes the condition.

Specified by:

passes in interface Condition<AlarmEvent>

Overrides:

passes in class AbstractFilter<AlarmEvent>

getLogger

public LoggerEx getLogger()

Specified by:

getLogger in class AbstractFilter<AlarmEvent>

getSerializableConditions

public Map<String,Condition<?>> getSerializableConditions()

Used only for serializing the AlarmFilter