com.inductiveautomation.ignition.common.expressions

Class DefaultFunctionFactory.DataSetDateAggregateFunction

java.lang.Object

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

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

com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.DataSetDateAggregateFunction

All Implemented Interfaces:

Function

Enclosing class:

DefaultFunctionFactory

public static class DefaultFunctionFactory.DataSetDateAggregateFunction
extends AbstractFunction

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.List<java.lang.String>	fakeDSNames
protected static java.util.List<java.lang.Class<?>>	fakeDSTypes
protected java.lang.String	funcName

Constructor Summary

Constructors

Constructor and Description
DataSetDateAggregateFunction()
DataSetDateAggregateFunction(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
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.
java.lang.String	getFuncName()
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	setFuncName(java.lang.String funcName)

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

executeArg, log, validateNumArgs

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

connect, copy, disconnect, executeAll, shutdown, startup

Methods inherited from class java.lang.Object

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

Field Detail

funcName

protected java.lang.String funcName

fakeDSNames

protected static java.util.List<java.lang.String> fakeDSNames

fakeDSTypes

protected static java.util.List<java.lang.Class<?>> fakeDSTypes

Constructor Detail

DataSetDateAggregateFunction

public DataSetDateAggregateFunction()

DataSetDateAggregateFunction

public DataSetDateAggregateFunction(java.lang.String name)

Method Detail

getFunctionDisplayName

protected java.lang.String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction

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

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

getFuncName

public java.lang.String getFuncName()

setFuncName

public void setFuncName(java.lang.String funcName)