org.diirt.support.cf.formula

Class CFQueryFunction

java.lang.Object

org.diirt.datasource.formula.StatefulFormulaFunction

org.diirt.support.cf.formula.CFQueryFunction

All Implemented Interfaces:

FormulaFunction

public class CFQueryFunction
extends StatefulFormulaFunction

Function that connects to the Channel Finder server, runs the query, and returns the result.

Author:

Kunal Shroff

Constructor Summary

Constructors

Constructor and Description
CFQueryFunction()

Method Summary

Modifier and Type	Method and Description
Object	calculate(List<Object> args) Calculate the result of the function given the arguments.
List<String>	getArgumentNames() The ordered list of the argument names.
List<Class<?>>	getArgumentTypes() The ordered list of the arguments type.
String	getDescription() Return the description of the function.
String	getName() Return the name of the function.
Class<?>	getReturnType() The type of the function result.
boolean	isVarArgs() Whether the function takes a variable number of arguments.

Methods inherited from class org.diirt.datasource.formula.StatefulFormulaFunction

dispose, isPure

Methods inherited from class java.lang.Object

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

Constructor Detail

CFQueryFunction

public CFQueryFunction()

Method Detail

isVarArgs

public boolean isVarArgs()

Description copied from interface: FormulaFunction

Whether the function takes a variable number of arguments.

Variable arguments can only be at the end of the argument list, and have the same type.

Returns:

true if the function can accept a variable number of arguments

getName

public String getName()

Description copied from interface: FormulaFunction

Return the name of the function.

Returns:

the function name

getDescription

public String getDescription()

Description copied from interface: FormulaFunction

Return the description of the function.

Returns:

the function description

getArgumentTypes

public List<Class<?>> getArgumentTypes()

Description copied from interface: FormulaFunction

The ordered list of the arguments type.

Returns:

the types of the arguments

getArgumentNames

public List<String> getArgumentNames()

Description copied from interface: FormulaFunction

The ordered list of the argument names.

Returns:

the names of the names

getReturnType

public Class<?> getReturnType()

Description copied from interface: FormulaFunction

The type of the function result.

Returns:

the result type

calculate

public Object calculate(List<Object> args)

Description copied from interface: FormulaFunction

Calculate the result of the function given the arguments.

Parameters:

args - the argument list

Returns:

the result of the function