Class SubscriptExpression
java.lang.Object
com.inductiveautomation.ignition.common.expressions.AbstractExpression
com.inductiveautomation.ignition.common.expressions.SubscriptExpression
- All Implemented Interfaces:
Expression
This expression takes a reference to an array, dataset, collection, or map and subscripts inside
it to pull out a value, like:
{dataset}[0,5]. Arrays, lists, JSON/document arrays, and
datasets also support negative indices to count from the end, e.g. {list}[-1] for the
last element; maps and property sets do not.-
Field Summary
Fields inherited from class AbstractExpression
children, context, updateListener -
Constructor Summary
ConstructorsConstructorDescriptionSubscriptExpression(Expression e, Expression sub1) SubscriptExpression(Expression e, Expression sub1, Expression sub2) -
Method Summary
Modifier and TypeMethodDescription@NonNull QualifiedValueexecute()Compute and return the value of this expression.Return a human-readable name for the operation that this expression performs.Methods inherited from class AbstractExpression
connect, disconnect, getChildren, setChildren, shutdown, startupMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface Expression
getType
-
Constructor Details
-
SubscriptExpression
-
SubscriptExpression
-
SubscriptExpression
public SubscriptExpression()
-
-
Method Details
-
execute
Description copied from interface:ExpressionCompute and return the value of this expression.- Returns:
- the result of the expression evaluation as a
QualifiedValue - Throws:
ExpressionException- if an error occurs during execution
-
getOpName
Description copied from interface:ExpressionReturn a human-readable name for the operation that this expression performs.- Returns:
- the operation name
-