org.gvsig.expressionevaluator.spi

Class AbstractFunction

java.lang.Object

org.gvsig.expressionevaluator.spi.AbstractFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

$ConstantFunction, $HostExpressionFunction, $IdentifierFunction, AbsFunction, AbstractBinaryOperator, AbstractFeatureFunction, AbstractGeometryFunction, AbstractSelectFunction, AbstractUnaryOperator, ACosFunction, AffineTransformFunction, AsciiFunction, ASinFunction, ATanFunction, AvgFunction, BetweenOperator, BitAndFunction, BitGetFunction, BitOrFunction, BitXorFunction, BreakFunction, CallFunction, CallMethodFunction, CallStaticMethodFunction, CaseFunction, CastFunction, CeilFunction, CharFunction, CodeBlockFunction, CodeBlockWithExceptFunction, ColorFunction, ConcatFunction, CosFunction, CoshFunction, CotFunction, CountFunction, CRC32Function, CreateChartFunction, CreateChartPanelFunction, CreateFnFunction, CreateFnFunction.UserFunction, CreateHtmlPanelFunction, CreateInMemoryTableFunction, CurrentDateFunction, CurrentTimeFunction, CurrentTimestampFunction, DateAddFunction, DateDiffFunction, DateFunction, DecodeFunction, DecrFunction, DegreesFunction, DesktopBrowse, DesktopEdit, DesktopOpen, DictFunction, DistanceFunction, EncodeFunction, EscapeFunction, EvalFunction, ExecuteSQLFunction, ExistsTableFunction, ExpFunction, ExtractFunction, FileFunction, FloorFunction, ForEachFunction, ForFunction, FormatFunction, GetattrFunction, GetDisposableInfoFunction, GetFolderFunction, GetitemFunction, HomeFunction, IFFunction, IFNULLFunction, IIFFunction, ImageFromHTMLFunction, ImageHeightFunction, ImageHorizontalflipFunction, ImageReadFunction, ImageResizeFunction, ImageRotateFunction, ImageTransformFunction, ImageVerticalflipFunction, ImageWidthFunction, ImageWriteFunction, ImportFunction, IncrFunction, InsertIntoTableFunction, InstrFunction, JsonValueFunction, LabeledValueFunction, LastPathFunction, LeftFunction, LenFunction, LengthFunction, LetFunction, ListFunction, LocateFunction, Log10Function, LogFunction, LowerFunction, LpadFunction, LTrimFunction, MapFunction, MaxFunction, MD5HexFunction, MidFunction, MinFunction, ModFunction, PassFunction, PiFunction, PowFunction, PrintFunction, RadiansFunction, RandFunction, RangeFunction, RelativeInstantFunction, RelativeIntervalFunction, RepeatFunction, ReplaceFunction, ReturnFunction, ReverseFunction, ReverseInStrFunction, RightFunction, RoundFunction, RpadFunction, RTrimFunction, ScriptFunction, SetattrFunction, SetFolderFunction, SetLastPathFunction, SetTemporaryFolderFunction, ShowWindowFunction, SignFunction, SinFunction, SinhFunction, SpaceFunction, SplitFunction, SplitPartFunction, SqrtFunction, StringBuilderFunction, StringWriterFunction, SubstringFunction, SumFunction, SwingBlockFunction, TanFunction, TanhFunction, TemporaryFileFunction, TemporaryFolderFunction, TimeFunction, TimestampFunction, ToDateFunction, ToDoubleFunction, ToFloatFunction, ToIntegerFunction, ToJsonFunction, ToLongFunction, ToStrFunction, ToTimestampFunction, TrimFunction, TryFunction, TupleFunction, UniqueTemporaryFileFunction, UpdateFunction, UpperFunction, URLFunction, UrlReadByteArrayFunction, UrlReadFunction, UserFunction, UUIDFunction, VarFunction, WhileFunction, ZeroFunction

public abstract class AbstractFunction
extends java.lang.Object
implements Function

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOGGER
protected static int	TYPE_BIGDECIMAL
protected static int	TYPE_BOOLEAN
protected static int	TYPE_DATE
protected static int	TYPE_DOUBLE
protected static int	TYPE_FLOAT
protected static int	TYPE_INT
protected static int	TYPE_LONG
protected static int	TYPE_NULL
protected static int	TYPE_STRING

Fields inherited from interface org.gvsig.expressionevaluator.Function

GROUP_AGGREGATE, GROUP_BOOLEAN, GROUP_CONVERSION, GROUP_DATETIME, GROUP_NUMERIC, GROUP_OGC, GROUP_OTHER, GROUP_PROGRAMMING, GROUP_STRING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFunction(java.lang.String group, java.lang.String name, Range argc)
protected	AbstractFunction(java.lang.String group, java.lang.String name, Range argc, java.lang.String description, java.lang.String template)
protected	AbstractFunction(java.lang.String group, java.lang.String name, Range argc, java.lang.String description, java.lang.String template, java.lang.String[] descriptionArgs)
protected	AbstractFunction(java.lang.String group, java.lang.String name, Range argc, java.lang.String description, java.lang.String template, java.lang.String[] descriptionArgs, java.lang.String returnType)
protected	AbstractFunction(java.lang.String group, java.lang.String name, Range argc, java.lang.String description, java.lang.String template, java.lang.String[] descriptionArgs, java.lang.String returnType, boolean sqlCompatible)

Method Summary

Modifier and Type	Method and Description
void	addAlias(java.lang.String name)
java.util.List<java.lang.String>	aliases()
boolean	allowConstantFolding() Returns true if the function always returns the same value for the same parameters.
Range	argc()
java.lang.Object	call(Interpreter interpreter, Codes args)
protected void	checkDoubleValue(double value)
protected void	checkFloatValue(float value)
java.lang.String	description()
java.lang.String[]	descriptionArgs()
protected java.math.BigDecimal	getBigDecimal(java.lang.Object value, int arg)
protected boolean	getBoolean(Interpreter interpreter, Codes args, int n)
protected boolean	getBoolean(java.lang.Object[] args, int n)
protected boolean	getBoolean(java.lang.Object[] args, int n, java.lang.Double accuracy)
protected boolean	getBoolean(java.lang.Object value, int n)
protected boolean	getBoolean(java.lang.Object value, int n, java.lang.Double accuracy)
protected java.lang.Comparable	getComparable(java.lang.Object[] args, int n)
protected java.lang.Comparable	getComparable(java.lang.Object value, int n)
protected java.lang.Comparable	getDate(java.lang.Object[] args, int n)
protected java.util.Date	getDate(java.lang.Object value, int n)
protected double	getDouble(java.lang.Object[] args, int n)
protected double	getDouble(java.lang.Object value, int arg)
protected java.io.File	getFile(java.lang.Object[] args, int n)
protected java.io.File	getFile(java.lang.Object value, int n)
protected float	getFloat(java.lang.Object[] args, int n)
protected float	getFloat(java.lang.Object value, int arg)
java.lang.String	getFullDescription() Return a full description of the funcion internationalized in HTML.
protected int	getInt(Interpreter interpreter, Codes args, int n)
protected int	getInt(java.lang.Object[] args, int n)
protected int	getInt(java.lang.Object value, int n)
protected JsonArray	getJsonArray(java.lang.Object[] args, int n)
protected JsonArray	getJsonArray(java.lang.Object value, int n)
protected JsonObject	getJsonObject(java.lang.Object[] args, int n)
protected JsonObject	getJsonObject(java.lang.Object value, int n)
protected JsonStructure	getJsonStructure(java.lang.Object[] args, int n)
protected JsonStructure	getJsonStructure(java.lang.Object value, int n)
protected GetItemWithSize64	getList(java.lang.Object[] args, int index)
protected java.time.LocalDateTime	getLocalDateTime(java.lang.Object[] args, int n)
protected java.time.LocalDateTime	getLocalDateTime(java.lang.Object value, int n)
protected long	getLong(java.lang.Object[] args, int n)
protected long	getLong(java.lang.Object value, int n)
protected java.lang.Object	getObject(Interpreter interpreter, Codes args, int n)
protected java.lang.Object	getObject(java.lang.Object[] args, int n)
protected java.lang.String	getStr(java.lang.Object[] args, int n)
protected java.lang.String	getStr(java.lang.Object value, int n)
protected int	getType(java.lang.Object op1, java.lang.Object op2)
java.net.URL	getURL(java.lang.Object[] args, int index)
java.lang.String	group()
boolean	isHidden()
protected boolean	isNull(java.lang.Object[] args, int n)
boolean	isOperator()
boolean	isSQLCompatible()
java.lang.String	name()
java.lang.String	returnType()
java.lang.String	template()
protected boolean	toBoolean(java.lang.Object value, java.lang.Double accuracy)
java.lang.String	toString()
java.lang.String	toString(Codes args, Formatter<Code> formatter)
ExpressionBuilder.Value	toValue(ExpressionBuilder builder, Codes parameters)
boolean	useArgumentsInsteadObjects()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.expressionevaluator.Function

call

Field Detail

LOGGER

protected static Logger LOGGER

TYPE_INT

protected static final int TYPE_INT

See Also:

Constant Field Values

TYPE_LONG

protected static final int TYPE_LONG

See Also:

Constant Field Values

TYPE_FLOAT

protected static final int TYPE_FLOAT

See Also:

Constant Field Values

TYPE_DOUBLE

protected static final int TYPE_DOUBLE

See Also:

Constant Field Values

TYPE_BOOLEAN

protected static final int TYPE_BOOLEAN

See Also:

Constant Field Values

TYPE_STRING

protected static final int TYPE_STRING

See Also:

Constant Field Values

TYPE_DATE

protected static final int TYPE_DATE

See Also:

Constant Field Values

TYPE_NULL

protected static final int TYPE_NULL

See Also:

Constant Field Values

TYPE_BIGDECIMAL

protected static final int TYPE_BIGDECIMAL

See Also:

Constant Field Values

Constructor Detail

AbstractFunction

protected AbstractFunction(java.lang.String group,
                           java.lang.String name,
                           Range argc,
                           java.lang.String description,
                           java.lang.String template,
                           java.lang.String[] descriptionArgs,
                           java.lang.String returnType,
                           boolean sqlCompatible)

AbstractFunction

protected AbstractFunction(java.lang.String group,
                           java.lang.String name,
                           Range argc,
                           java.lang.String description,
                           java.lang.String template,
                           java.lang.String[] descriptionArgs,
                           java.lang.String returnType)

AbstractFunction

protected AbstractFunction(java.lang.String group,
                           java.lang.String name,
                           Range argc,
                           java.lang.String description,
                           java.lang.String template,
                           java.lang.String[] descriptionArgs)

AbstractFunction

protected AbstractFunction(java.lang.String group,
                           java.lang.String name,
                           Range argc,
                           java.lang.String description,
                           java.lang.String template)

AbstractFunction

protected AbstractFunction(java.lang.String group,
                           java.lang.String name,
                           Range argc)

Method Detail

name

public java.lang.String name()

Specified by:

name in interface Function

returnType

public java.lang.String returnType()

Specified by:

returnType in interface Function

group

public java.lang.String group()

Specified by:

group in interface Function

argc

public Range argc()

Specified by:

argc in interface Function

description

public java.lang.String description()

Specified by:

description in interface Function

descriptionArgs

public java.lang.String[] descriptionArgs()

Specified by:

descriptionArgs in interface Function

getFullDescription

public java.lang.String getFullDescription()

Description copied from interface: Function

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

Specified by:

getFullDescription in interface Function

Returns:

full description in HTML as a String

addAlias

public void addAlias(java.lang.String name)

Specified by:

addAlias in interface Function

aliases

public java.util.List<java.lang.String> aliases()

Specified by:

aliases in interface Function

template

public java.lang.String template()

Specified by:

template in interface Function

isOperator

public boolean isOperator()

Specified by:

isOperator in interface Function

isHidden

public boolean isHidden()

Specified by:

isHidden in interface Function

useArgumentsInsteadObjects

public boolean useArgumentsInsteadObjects()

Specified by:

useArgumentsInsteadObjects in interface Function

isSQLCompatible

public boolean isSQLCompatible()

Specified by:

isSQLCompatible in interface Function

allowConstantFolding

public boolean allowConstantFolding()

Description copied from interface: Function

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

Specified by:

allowConstantFolding in interface Function

Returns:

true if this function allow constant folding optimization.

call

public java.lang.Object call(Interpreter interpreter,
                             Codes args)
                      throws java.lang.Exception

Specified by:

call in interface Function

Throws:

java.lang.Exception

getInt

protected int getInt(java.lang.Object[] args,
                     int n)

getInt

protected int getInt(java.lang.Object value,
                     int n)

getInt

protected int getInt(Interpreter interpreter,
                     Codes args,
                     int n)

getLong

protected long getLong(java.lang.Object[] args,
                       int n)

getLong

protected long getLong(java.lang.Object value,
                       int n)

getDouble

protected double getDouble(java.lang.Object[] args,
                           int n)

getDouble

protected double getDouble(java.lang.Object value,
                           int arg)

getBigDecimal

protected java.math.BigDecimal getBigDecimal(java.lang.Object value,
                                             int arg)

getFloat

protected float getFloat(java.lang.Object[] args,
                         int n)

getFloat

protected float getFloat(java.lang.Object value,
                         int arg)

getStr

protected java.lang.String getStr(java.lang.Object[] args,
                                  int n)

getStr

protected java.lang.String getStr(java.lang.Object value,
                                  int n)

getFile

protected java.io.File getFile(java.lang.Object[] args,
                               int n)

getFile

protected java.io.File getFile(java.lang.Object value,
                               int n)

isNull

protected boolean isNull(java.lang.Object[] args,
                         int n)

getObject

protected java.lang.Object getObject(java.lang.Object[] args,
                                     int n)

getJsonObject

protected JsonObject getJsonObject(java.lang.Object[] args,
                                   int n)

getJsonObject

protected JsonObject getJsonObject(java.lang.Object value,
                                   int n)

getJsonArray

protected JsonArray getJsonArray(java.lang.Object[] args,
                                 int n)

getJsonArray

protected JsonArray getJsonArray(java.lang.Object value,
                                 int n)

getJsonStructure

protected JsonStructure getJsonStructure(java.lang.Object[] args,
                                         int n)

getJsonStructure

protected JsonStructure getJsonStructure(java.lang.Object value,
                                         int n)

getObject

protected java.lang.Object getObject(Interpreter interpreter,
                                     Codes args,
                                     int n)

getComparable

protected java.lang.Comparable getComparable(java.lang.Object[] args,
                                             int n)

getComparable

protected java.lang.Comparable getComparable(java.lang.Object value,
                                             int n)

getDate

protected java.lang.Comparable getDate(java.lang.Object[] args,
                                       int n)

getDate

protected java.util.Date getDate(java.lang.Object value,
                                 int n)

getLocalDateTime

protected java.time.LocalDateTime getLocalDateTime(java.lang.Object[] args,
                                                   int n)

getLocalDateTime

protected java.time.LocalDateTime getLocalDateTime(java.lang.Object value,
                                                   int n)

getURL

public java.net.URL getURL(java.lang.Object[] args,
                           int index)
                    throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

getBoolean

protected boolean getBoolean(java.lang.Object[] args,
                             int n,
                             java.lang.Double accuracy)

getBoolean

protected boolean getBoolean(java.lang.Object[] args,
                             int n)

getBoolean

protected boolean getBoolean(java.lang.Object value,
                             int n)

getBoolean

protected boolean getBoolean(java.lang.Object value,
                             int n,
                             java.lang.Double accuracy)

getBoolean

protected boolean getBoolean(Interpreter interpreter,
                             Codes args,
                             int n)

toBoolean

protected boolean toBoolean(java.lang.Object value,
                            java.lang.Double accuracy)

getList

protected GetItemWithSize64 getList(java.lang.Object[] args,
                                    int index)

getType

protected int getType(java.lang.Object op1,
                      java.lang.Object op2)

toString

public java.lang.String toString(Codes args,
                                 Formatter<Code> formatter)

Specified by:

toString in interface Function

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

checkDoubleValue

protected void checkDoubleValue(double value)

checkFloatValue

protected void checkFloatValue(float value)

toValue

public ExpressionBuilder.Value toValue(ExpressionBuilder builder,
                                       Codes parameters)

Specified by:

toValue in interface Function