Function

All Known Subinterfaces:

BinaryOperator, Operator, UnaryOperator

All Known Implementing Classes:

$ConstantFunction, $HostExpressionFunction, $IdentifierFunction, AbsFunction, AbstractBinaryOperator, AbstractFeatureFunction, AbstractFunction, AbstractGeometryBinaryOperator, AbstractGeometryFunction, AbstractSelectFunction, AbstractUnaryOperator, ACosFunction, AddOperator, AffineTransformFunction, AndAndOperator, AndOperator, AsciiFunction, ASinFunction, ATanFunction, AvgFunction, BetweenOperator, BitAndFunction, BitGetFunction, BitOrFunction, BitXorFunction, BreakFunction, CallFunction, CallMethodFunction, CallStaticMethodFunction, CaseFunction, CastFunction, CeilFunction, CharFunction, CodeBlockFunction, CodeBlockWithExceptFunction, ColorFunction, ConcatFunction, ConcatOperator, ConvexTrapezoidLengthFunction, CosFunction, CoshFunction, CotFunction, CountFunction, CRC32Function, CreateChartFunction, CreateChartPanelFunction, CreateFnFunction, CreateFnFunction.UserFunction, CreateHtmlPanelFunction, CreateInMemoryTableFunction, CreateTableFunction, CreateTableStructureFunction, CurrentDateFunction, CurrentRowFunction, CurrentStoreFunction, CurrentTimeFunction, CurrentTimestampFunction, DateAddFunction, DateDiffFunction, DateFunction, DecodeFunction, DecrFunction, DegreesFunction, DesktopBrowse, DesktopEdit, DesktopOpen, DictFunction, DistanceFunction, DivOperator, EncodeFunction, EqOperator, EscapeFunction, EvalFunction, ExecuteSQLFunction, ExecuteSQLFunction, ExistsFunction, ExistsTableFunction, ExpFunction, ExtractFunction, FileFunction, FloorFunction, ForEachFunction, ForeingValueFunction, ForFunction, FormatFunction, GeometryFunction, GeOperator, GetattrFunction, GetattrFunction, GetDisposableInfoFunction, GetFolderFunction, GetitemFunction, GtOperator, HomeFunction, IFFunction, IFNULLFunction, IIFFunction, IlikeOperator, ImageFromHTMLFunction, ImageHeightFunction, ImageHorizontalflipFunction, ImageReadFunction, ImageResizeFunction, ImageRotateFunction, ImageTransformFunction, ImageVerticalflipFunction, ImageWidthFunction, ImageWriteFunction, ImportFunction, IncrFunction, InOperator, InsertIntoTableFunction, InstrFunction, IsOperator, IsSelectedCurrentRowFunction, JsonValueFunction, LabeledValueFunction, LastPathFunction, LeftFunction, LenFunction, LengthFunction, LeOperator, LetFunction, LikeOperator, ListFunction, LocateFunction, Log10Function, LogFunction, LowerFunction, LpadFunction, LtOperator, LTrimFunction, MapFunction, MaxFunction, MD5HexFunction, MidFunction, MinFunction, ModFunction, MulOperator, NegOperator, NeOperator, NotOperator, OrOperator, PassFunction, PiFunction, PointByAngleFunction, PowFunction, PrintFunction, RadiansFunction, RandFunction, RangeFunction, RegExpOperator, RelativeInstantFunction, RelativeIntervalFunction, RepeatFunction, ReplaceFunction, ReturnFunction, ReverseFunction, ReverseInStrFunction, RightFunction, RoundFunction, RowTagFunction, RpadFunction, RTrimFunction, ScriptFunction, SelectAggregateFunction, SelectCountFromSelectionFunction, SelectCountFunction, SelectFunction, SetattrFunction, SetFolderFunction, SetLastPathFunction, SetRowTagFunction, SetTemporaryFolderFunction, ShowWindowFunction, SignFunction, SinFunction, SinhFunction, SpaceFunction, SplitFunction, SplitPartFunction, SqrtFunction, STAreaFunction, STAsBinaryFunction, STAsTextFunction, STBoundaryFunction, STBufferFunction, STCentroidFunction, STContainsFunction, STConvexHullFunction, STCoveredByFunction, STCoversFunction, STCrossesFunction, STDifferenceFunction, STDimensionFunction, STDisjointFunction, STDistanceFunction, STEndPointFunction, STEnvelopeFunction, STExteriorRingFunction, STForce2DFunction, STGeometryNFunction, STGeomFromTextFunction, STGeomFromWKBFunction, STIntersectionFunction, STIntersectsFunction, STIsEmptyFunction, STIsSimpleFunction, STIsValidFunction, STLengthFunction, STMakePointFunction, STMakePolygonFunction, STNumGeometriesFunction, STNumPointsFunction, STOverlapsFunction, STPerimeterFunction, STPointFunction, STPointNFunction, StringBuilderFunction, StringWriterFunction, STSetSRIDFunction, STSRIDFunction, STStartPointFunction, STTouchesFunction, STTransformFunction, STUnionFunction, STWithinFunction, STXFunction, STYFunction, STZFunction, SubstOperator, 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 interface Function
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`GROUP_AGGREGATE`
`static java.lang.String`	`GROUP_BOOLEAN`
`static java.lang.String`	`GROUP_CONVERSION`
`static java.lang.String`	`GROUP_DATETIME`
`static java.lang.String`	`GROUP_NUMERIC`
`static java.lang.String`	`GROUP_OGC`
`static java.lang.String`	`GROUP_OTHER`
`static java.lang.String`	`GROUP_PROGRAMMING`
`static java.lang.String`	`GROUP_STRING`

Method Summary

All Methods Instance Methods Abstract Methods
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)`
`java.lang.Object`	`call(Interpreter interpreter, java.lang.Object[] args)`
`java.lang.String`	`description()`
`java.lang.String[]`	`descriptionArgs()`
`java.lang.String`	`getFullDescription()` Return a full description of the funcion internationalized in HTML.
`java.lang.String`	`group()`
`boolean`	`isHidden()`
`boolean`	`isOperator()`
`boolean`	`isSQLCompatible()`
`java.lang.String`	`name()`
`java.lang.String`	`returnType()`
`java.lang.String`	`template()`
`java.lang.String`	`toString(Codes args, Formatter<Code> formatter)`
`ExpressionBuilder.Value`	`toValue(ExpressionBuilder builder, Codes parameters)`
`boolean`	`useArgumentsInsteadObjects()`

Field Detail
- GROUP_NUMERIC
```
static final java.lang.String GROUP_NUMERIC
```
  See Also:
  
  Constant Field Values
- GROUP_STRING
```
static final java.lang.String GROUP_STRING
```
  See Also:
  
  Constant Field Values
- GROUP_DATETIME
```
static final java.lang.String GROUP_DATETIME
```
  See Also:
  
  Constant Field Values
- GROUP_BOOLEAN
```
static final java.lang.String GROUP_BOOLEAN
```
  See Also:
  
  Constant Field Values
- GROUP_OGC
```
static final java.lang.String GROUP_OGC
```
  See Also:
  
  Constant Field Values
- GROUP_PROGRAMMING
```
static final java.lang.String GROUP_PROGRAMMING
```
  See Also:
  
  Constant Field Values
- GROUP_CONVERSION
```
static final java.lang.String GROUP_CONVERSION
```
  See Also:
  
  Constant Field Values
- GROUP_AGGREGATE
```
static final java.lang.String GROUP_AGGREGATE
```
  See Also:
  
  Constant Field Values
- GROUP_OTHER
```
static final java.lang.String GROUP_OTHER
```
  See Also:
  
  Constant Field Values

Method Detail

group
```
java.lang.String group()
```

name
```
java.lang.String name()
```

returnType
```
java.lang.String returnType()
```

argc
```
Range argc()
```

description
```
java.lang.String description()
```

getFullDescription
```
java.lang.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
```
java.lang.String template()
```

descriptionArgs
```
java.lang.String[] descriptionArgs()
```

call

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

Throws:: java.lang.Exception

call

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

Throws:: java.lang.Exception

addAlias
```
void addAlias(java.lang.String name)
```

aliases

java.util.List<java.lang.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

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

toValue

ExpressionBuilder.Value toValue(ExpressionBuilder builder,
                                Codes parameters)

Interface Function

Field Summary

Method Summary

Field Detail

GROUP_NUMERIC

GROUP_STRING

GROUP_DATETIME

GROUP_BOOLEAN

GROUP_OGC

GROUP_PROGRAMMING

GROUP_CONVERSION

GROUP_AGGREGATE

GROUP_OTHER

Method Detail

group

name

returnType

argc

description

getFullDescription

template

descriptionArgs

call

call

addAlias

aliases

isOperator

isHidden

useArgumentsInsteadObjects

isSQLCompatible

allowConstantFolding

toString

toValue