Package org.gvsig.expressionevaluator

Interface Function

All Known Implementing Classes:

AbstractFunction

public interface Function

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GROUP_AGGREGATE
static final String	GROUP_BOOLEAN
static final String	GROUP_CONVERSION
static final String	GROUP_DATETIME
static final String	GROUP_NUMERIC
static final String	GROUP_OGC
static final String	GROUP_OTHER
static final String	GROUP_PROGRAMMING
static final String	GROUP_STRING

Method Summary

Modifier and Type	Method	Description
void	addAlias(String name)
List<String>	aliases()
boolean	allowConstantFolding()	Returns true if the function always returns the same value for the same parameters.
org.apache.commons.lang3.Range	argc()
Object	call(Interpreter interpreter, Object[] args)
Object	call(Interpreter interpreter, Codes args)
String	description()
String[]	descriptionArgs()
String	getFullDescription()	Return a full description of the funcion internationalized in HTML.
String	group()
boolean	isHidden()
boolean	isOperator()
boolean	isSQLCompatible()
String	name()
String	returnType()
String	template()
String	toString(Codes args, Formatter<Code> formatter)
ExpressionBuilder.Value	toValue(ExpressionBuilder builder, Codes parameters)
boolean	useArgumentsInsteadObjects()

Field Details

GROUP_NUMERIC

static final String GROUP_NUMERIC

See Also:

• Constant Field Values

GROUP_STRING

static final String GROUP_STRING

See Also:

• Constant Field Values

GROUP_DATETIME

static final String GROUP_DATETIME

See Also:

• Constant Field Values

GROUP_BOOLEAN

static final String GROUP_BOOLEAN

See Also:

• Constant Field Values

GROUP_OGC

static final String GROUP_OGC

See Also:

• Constant Field Values

GROUP_PROGRAMMING

static final String GROUP_PROGRAMMING

See Also:

• Constant Field Values

GROUP_CONVERSION

static final String GROUP_CONVERSION

See Also:

• Constant Field Values

GROUP_AGGREGATE

static final String GROUP_AGGREGATE

See Also:

• Constant Field Values

GROUP_OTHER

static final String GROUP_OTHER

See Also:

• Constant Field Values

Method Details

group

String group()

name

String name()

returnType

String returnType()

argc

org.apache.commons.lang3.Range argc()

description

String description()

getFullDescription

String getFullDescription()

Return a full description of the funcion internationalized in HTML. This full description contains, t name, description, args, template and return type.

Returns:

full description in HTML as a String

template

String template()

descriptionArgs

String[] descriptionArgs()

call

Object call(Interpreter interpreter,
 Object[] args)
     throws Exception

Throws:

Exception

call

Object call(Interpreter interpreter,
 Codes args)
     throws Exception

Throws:

Exception

addAlias

void addAlias(String name)

aliases

List<String> aliases()

isOperator

boolean isOperator()

isHidden

boolean isHidden()

useArgumentsInsteadObjects

boolean useArgumentsInsteadObjects()

isSQLCompatible

boolean isSQLCompatible()

allowConstantFolding

boolean allowConstantFolding()

Returns true if the function always returns the same value for the same parameters. If so, it is possible to optimize the generated code through the process of "constant folding". https://en.wikipedia.org/wiki/Constant_folding

Returns:

true if this function allow constant folding optimization.

toString

String toString(Codes args,
 Formatter<Code> formatter)

toValue

ExpressionBuilder.Value toValue(ExpressionBuilder builder,
 Codes parameters)