Package com.inductiveautomation.ignition.common.alarming.query

Class AlarmQueryResultImpl

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<AlarmEvent>

com.inductiveautomation.ignition.common.alarming.query.AlarmQueryResultImpl

All Implemented Interfaces:

AlarmQueryResult, Serializable, Cloneable, Iterable<AlarmEvent>, Collection<AlarmEvent>, List<AlarmEvent>, RandomAccess

public class AlarmQueryResultImpl
extends ArrayList<AlarmEvent>
implements AlarmQueryResult, Serializable

Returns a Dataset derived from an AlarmEvent query. The Dataset is comprised of Primitive types to avoid exposing users to internal types.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DISPLAY_PATH
static final int	EVENT_ID
static final int	EVENT_STATE
static final int	EVENT_TIME
static final int	IS_SYSTEM_EVENT
static final int	PRIORITY
static final int	SOURCE

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
AlarmQueryResultImpl(boolean isHistory)
AlarmQueryResultImpl(AlarmQueryResult copy)

Method Summary

Modifier and Type	Method	Description
protected Dataset	buildAssociatedData(AlarmEvent evt)	Builds a dataset from associated data.
protected Dataset	buildDS()
static AlarmQueryResult	buildFrom(List<AlarmQueryResult> results)	Combines multiple results into a single one.
Dataset	getAssociatedData(String uuid)	Returns the associated data of an event as a dataset.
Dataset	getDataset()	Returns the alarms as a dataset.
AlarmEvent	getEvent(String uuid)	Returns the actual AlarmEvent object for the specified event uuid.
protected Property[]	getPropertiesForDS()	Gets an array of the column property types for the dataset.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Field Details

EVENT_ID

public static final int EVENT_ID

See Also:

• Constant Field Values

SOURCE

public static final int SOURCE

See Also:

• Constant Field Values

DISPLAY_PATH

public static final int DISPLAY_PATH

See Also:

• Constant Field Values

EVENT_TIME

public static final int EVENT_TIME

See Also:

• Constant Field Values

EVENT_STATE

public static final int EVENT_STATE

See Also:

• Constant Field Values

PRIORITY

public static final int PRIORITY

See Also:

• Constant Field Values

IS_SYSTEM_EVENT

public static final int IS_SYSTEM_EVENT

See Also:

• Constant Field Values

Constructor Details

AlarmQueryResultImpl

public AlarmQueryResultImpl(boolean isHistory)

AlarmQueryResultImpl

public AlarmQueryResultImpl(AlarmQueryResult copy)

Method Details

buildFrom

public static AlarmQueryResult buildFrom(List<AlarmQueryResult> results)

Combines multiple results into a single one. If the incoming set is only one element, it is returned directly. *

getDataset

public Dataset getDataset()

Description copied from interface: AlarmQueryResult

Returns the alarms as a dataset. The specific columns depend on whether this is the result of a status query, or history query.

History: EventId, Source, DisplayPath, EventTime, EventState, Priority, IsSystemEvent
Status: EventId, Source, DisplayPath, EventTime, State, Priority

Specified by:

getDataset in interface AlarmQueryResult

getAssociatedData

public Dataset getAssociatedData(String uuid)

Description copied from interface: AlarmQueryResult

Returns the associated data of an event as a dataset. The columns are [PropertyName, Value]

Specified by:

getAssociatedData in interface AlarmQueryResult

getEvent

public AlarmEvent getEvent(String uuid)

Description copied from interface: AlarmQueryResult

Returns the actual AlarmEvent object for the specified event uuid.

Specified by:

getEvent in interface AlarmQueryResult

getPropertiesForDS

protected Property[] getPropertiesForDS()

Gets an array of the column property types for the dataset.

Returns:

Property[] , an array consisting of the CommonAlarmProperties for the AlarmQueryResult dataset.

buildDS

protected Dataset buildDS()

buildAssociatedData

protected Dataset buildAssociatedData(AlarmEvent evt)

Builds a dataset from associated data.