AlarmEventCollectionExpressionParseContext

java.lang.Object
- com.inductiveautomation.ignition.gateway.expressions.AbstractMultiLevelExpressionParseContext
- - com.inductiveautomation.ignition.gateway.expressions.AlarmEventCollectionExpressionParseContext

All Implemented Interfaces:

ExpressionParseContext
```
public class AlarmEventCollectionExpressionParseContext
extends AbstractMultiLevelExpressionParseContext
```
This parse context is built to work with a collection of events. It works much like the PropertyBasedExpressionParseContext, except that allows indexing into the collection, and supports additional collection-related properties, such as "Count", "MinPriority", etc.
Examples:
{MaxPriority}
{Priority}

Constructor Summary

Constructors
Constructor	Description
`AlarmEventCollectionExpressionParseContext(PropertyResolver propResolver, java.util.List<AlarmEvent> alarmEvents)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`expandCollectionReferences(java.lang.String expression)`	We want our message syntax to support building a "loop" message.
`protected Expression`	`tryCreateBoundExpression(java.lang.String path)`	This function should create the expression if possible.

Methods inherited from class com.inductiveautomation.ignition.gateway.expressions.AbstractMultiLevelExpressionParseContext
createBoundExpression, getBaseFunctionFactory, getDelegateParseContext, getFunctionFactory

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AlarmEventCollectionExpressionParseContext
```
public AlarmEventCollectionExpressionParseContext(PropertyResolver propResolver,
                                                  java.util.List<AlarmEvent> alarmEvents)
```
- Method Detail
  - tryCreateBoundExpression
```
protected Expression tryCreateBoundExpression(java.lang.String path)
```
    Description copied from class: AbstractMultiLevelExpressionParseContext
    
    This function should create the expression if possible. If not, it should return null instead of throwing the error, in which case the parent parse context will be tried.
    
    Specified by:
    
    tryCreateBoundExpression in class AbstractMultiLevelExpressionParseContext
  - expandCollectionReferences
```
public java.lang.String expandCollectionReferences(java.lang.String expression)
                                            throws java.lang.Exception
```
    We want our message syntax to support building a "loop" message. Since that not part of the parser, and we happen to know how many events there will be here, so we create an expanded, parsable message here.
    
    Throws:
    
    java.lang.Exception