com.inductiveautomation.ignition.common.expressions

Class DefaultFunctionFactory.LookupFunction

java.lang.Object

com.inductiveautomation.ignition.common.expressions.functions.BaseFunction

com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction

com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.LookupFunction

All Implemented Interfaces:

Function

Enclosing class:

DefaultFunctionFactory

public static class DefaultFunctionFactory.LookupFunction
extends AbstractFunction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FUNC_NAME

Constructor Summary

Constructors

Constructor and Description
LookupFunction()

Method Summary

Modifier and Type	Method and Description
Function	copy() Returns this.
QualifiedValue	execute(Expression[] args) Execute this function, and return the function's qualified value.
java.lang.String	getArgDocString() Returns a string to be used in the auto-generated function documentation.
protected java.lang.String	getFunctionDisplayName()
java.lang.Class<?>	getType() Returns the type of Object that this function will generate with execute
void	initArgs(Expression[] args) Calls validateNumArgs() to make sure the number of args is correct
void	setType(java.lang.Class<?> class1)
protected boolean	validateNumArgs(int num)

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction

executeArg, log

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.BaseFunction

connect, disconnect, executeAll, shutdown, startup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FUNC_NAME

public static final java.lang.String FUNC_NAME

See Also:

Constant Field Values

Constructor Detail

LookupFunction

public LookupFunction()

Method Detail

initArgs

public void initArgs(Expression[] args)

Description copied from class: AbstractFunction

Calls validateNumArgs() to make sure the number of args is correct

Specified by:

initArgs in interface Function

Overrides:

initArgs in class AbstractFunction

getFunctionDisplayName

protected java.lang.String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction

copy

public Function copy()

Description copied from class: BaseFunction

Returns this. Override to create a clone if you need a unique function object per Expression.

Specified by:

copy in interface Function

Overrides:

copy in class BaseFunction

validateNumArgs

protected boolean validateNumArgs(int num)

Overrides:

validateNumArgs in class AbstractFunction

execute

public QualifiedValue execute(Expression[] args)
                       throws ExpressionException

Description copied from interface: Function

Execute this function, and return the function's qualified value.

Throws:

ExpressionException

getArgDocString

public java.lang.String getArgDocString()

Description copied from interface: Function

Returns a string to be used in the auto-generated function documentation. The string should represent the arguments for the function, such as "string, count" for the "repeat" function.

getType

public java.lang.Class<?> getType()

Description copied from interface: Function

Returns the type of Object that this function will generate with execute

setType

public void setType(java.lang.Class<?> class1)