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

Class AlarmQueryResultImpl

  • All Implemented Interfaces:
    AlarmQueryResult, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<AlarmEvent>, java.util.Collection<AlarmEvent>, java.util.List<AlarmEvent>, java.util.RandomAccess
    public class AlarmQueryResultImpl
extends java.util.ArrayList<AlarmEvent>
implements AlarmQueryResult, java.io.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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected Dataset buildAssociatedData​(AlarmEvent evt)
      Builds a dataset from associated data.
      protected Dataset buildDS()  
      static AlarmQueryResult buildFrom​(java.util.List<AlarmQueryResult> results)
      Combines multiple results into a single one.
      Dataset getAssociatedData​(java.lang.String uuid)
      Returns the associated data of an event as a dataset.
      Dataset getDataset()
      Returns the alarms as a dataset.
      AlarmEvent getEvent​(java.lang.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

    • Constructor Detail

      • AlarmQueryResultImpl

        public AlarmQueryResultImpl​(boolean isHistory)

    • Method Detail

      • buildFrom

        public static AlarmQueryResult buildFrom​(java.util.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​(java.lang.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

      • 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.