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>
,java.io.Serializable
public class AlarmFilter extends AbstractFilter<AlarmEvent>
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static Field<AlarmEvent,StringPath,PathCondition<StringPath>>
DISPPATH
static Field<AlarmEvent,Path[],DisplayThenSourceCondition>
DISPPATH_THEN_SOURCE
Filters on display path then falls back to the source path if the display path has not be set.static Field<AlarmEvent,java.util.Date,DateTimeCondition>
EVENTTIME
static Field<AlarmEvent,java.lang.String,StringCondition>
EVENTUUID
static int
FLAG_EXCLUDE_SYS
If set, system events will not be allowed.static int
FLAG_FORCE_STATE_STRATEGY
static int
FLAG_FORCE_TREE_STRATEGY
These are not-commonly-used flags for forcing how we query alarm status.static int
FLAG_INCLUDE_DATA
Used for historical querying, indicates that the results should include associated data.static int
FLAG_INCLUDE_SHELVED
If set, shelved events will be included in the result.static int
FLAG_ONLY_SYS
If set, only system events will be allowed.static int
HIGHEST_PRIO_ONLY
For a particular source, only return the highest priority alarm.static Field<AlarmEvent,AlarmPriority,EnumCondition<AlarmPriority>>
PRIORITY
static Field<AlarmEvent,PropertySet,PropertyCondition>
PROPS
static Field<AlarmEvent,java.lang.String,StringEnumCondition>
PROVIDER
static Field<AlarmEvent,QualifiedPath,PathCondition<QualifiedPath>>
SOURCE
static Field<AlarmEvent,Path[],SourceOrDisplayCondition>
SOURCE_OR_DISPPATH
Filters on either path OR display path.static Field<AlarmEvent,AlarmState,EnumCondition<AlarmState>>
STATE
-
Constructor Summary
Constructors Constructor Description AlarmFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Flags
getFlags()
Returns the flags for the filter, which are operation specific information that can be passed along.protected void
logCondition(Condition<?> c, java.lang.Object val, boolean passed)
Can be overridden to log success/failure conditions.boolean
passes(AlarmEvent value)
Returns whether the provided value passes the condition.-
Methods inherited from class com.inductiveautomation.ignition.common.alarming.query.AbstractFilter
and, getConditionFor, hasConditionFor, toString
-
-
-
-
Field Detail
-
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
-
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
-
SOURCE
public static final Field<AlarmEvent,QualifiedPath,PathCondition<QualifiedPath>> SOURCE
-
PROVIDER
public static final Field<AlarmEvent,java.lang.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 be 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,java.util.Date,DateTimeCondition> EVENTTIME
-
EVENTUUID
public static final Field<AlarmEvent,java.lang.String,StringCondition> EVENTUUID
-
-
Method Detail
-
getFlags
public Flags getFlags()
Returns the flags for the filter, which are operation specific information that can be passed along.
-
passes
public boolean passes(AlarmEvent value)
Description copied from interface:Condition
Returns whether the provided value passes the condition.- Specified by:
passes
in interfaceCondition<AlarmEvent>
- Overrides:
passes
in classAbstractFilter<AlarmEvent>
-
logCondition
protected void logCondition(Condition<?> c, java.lang.Object val, boolean passed)
Description copied from class:AbstractFilter
Can be overridden to log success/failure conditions.- Overrides:
logCondition
in classAbstractFilter<AlarmEvent>
-
-