Package com.inductiveautomation.ignition.common.alarming

Class AlarmFilterBuilder

java.lang.Object
com.inductiveautomation.ignition.common.alarming.AlarmFilterBuilder
public class AlarmFilterBuilder extends Object
This class provides a convenient way to build common alarm filters. Each function returns the builder, so they can be chained together. Each chained invocation results in a new "and" condition. At the end, call build() to retrieve the resulting AlarmFilter.

  • Constructor Details

    • AlarmFilterBuilder

      public AlarmFilterBuilder()

  • Method Details

    • build

      public AlarmFilter build()

    • allowShelved

      public AlarmFilterBuilder allowShelved()
      Includes shelved events in the results. Normally shelved events are filtered out.

    • includeData

      public AlarmFilterBuilder includeData()

    • includeSystem

      public AlarmFilterBuilder includeSystem(boolean include)

    • betweenDates

      public AlarmFilterBuilder betweenDates(Date startDate, Date endDate)

    • priority_lt

      public AlarmFilterBuilder priority_lt(AlarmPriority prio)

    • priority_lte

      public AlarmFilterBuilder priority_lte(AlarmPriority prio)

    • priority_gt

      public AlarmFilterBuilder priority_gt(AlarmPriority prio)

    • priority_gte

      public AlarmFilterBuilder priority_gte(AlarmPriority prio)

    • priority_between

      public AlarmFilterBuilder priority_between(AlarmPriority a, AlarmPriority b)
      Filters for priorities between (and including) a and b

    • priority_eq

      public AlarmFilterBuilder priority_eq(AlarmPriority val)

    • sourceFilter

      public AlarmFilterBuilder sourceFilter(Collection<QualifiedPath> paths)
      Adds an "and" filter for alarm source path for each of the given paths

    • sourceFilter

      public AlarmFilterBuilder sourceFilter(String[] rawpaths)
      Adds an "and" filter for alarm source path for each of the given raw paths. The paths can be a qualified path, or a simple path fragment.

    • eventIdFilter

      public AlarmFilterBuilder eventIdFilter(String eventId, ComparisonOperator operator)

    • displayPathFilter

      public AlarmFilterBuilder displayPathFilter(Collection<StringPath> paths)
      Adds an "and" filter for alarm display path for each of the given paths

    • displayPathFilter

      public AlarmFilterBuilder displayPathFilter(String[] rawpaths)
      Adds an "and" filter for alarm display path for each of the given paths. Paths can be qualified paths or simple path fragments.

    • providerFilter

      public AlarmFilterBuilder providerFilter(String[] providers)

    • sourceOrDisplayPath

      public AlarmFilterBuilder sourceOrDisplayPath(Collection<Path> paths)
      Takes a set of paths, and will filter on source or display path. If either passes, the condition will return true.

    • displayPathThenSourceFilter

      public AlarmFilterBuilder displayPathThenSourceFilter(String[] rawFilterPaths)
      Takes a set of paths, and will filter on display path. If the display path has not been set, the source path will be used as a fallback. However, if the display path is set, it must meet the filter criteria for the condition to return true.

    • sourceOrDisplayPath

      public AlarmFilterBuilder sourceOrDisplayPath(String[] rawpaths)
      Takes a set of paths, and will filter on source or display path. If either passes, the condition will return true.

    • isState

      public AlarmFilterBuilder isState(AlarmState... states)
      Creates a condition that will pass on any of the given alarm states. In other words, if more than one state is provided, they will be "OR'd" together.

    • isPriority

      public AlarmFilterBuilder isPriority(AlarmPriority... priorities)
      Creates a condition that will pass on any of the given alarm priorities. In other words, if more than one priority is provided, they will be "OR'd" together.

    • filterSystem

      public AlarmFilterBuilder filterSystem()
      Enables a flag ensuring system events are filtered along with all other events, filters such as priority, state, display or source path, etc.