Package org.geotools.api.filter.expression

Interface Function

All Superinterfaces:

Expression

All Known Subinterfaces:

Categorize, CoverageReadingTransformation, FunctionExpression, GeometryTransformation, InternalFunction, Interpolate, Recode, RenderingTransformation, VolatileFunction

All Known Implementing Classes:

AbstractHSLFunction, AbstractQuantityClassificationFunction, AndFunction, AreaFunction, ArrayFunction, AsMultiGeometryFunctionExpression, AtFunction, AttributeCountFunction, BandsFunction, BoundedByFunction, CategorizeFunction, ClassificationFunction, ClassifyFunction, Collection_AverageFunction, Collection_BoundsFunction, Collection_CountFunction, Collection_MaxFunction, Collection_MedianFunction, Collection_MinFunction, Collection_NearestFunction, Collection_SumFunction, Collection_UniqueFunction, CollectionIdFunction, CollectionLinkFunction, ConcatenateFunction, ConstrastFunction, CSSFunction, DarkenFunction, DateDifferenceFunction, DefaultIfNullFunction, DesaturateFunction, EnvFunction, EqualAreaFunction, EqualIntervalFunction, ExponentialFunction, FallbackFunction, FilterFunction_abs, FilterFunction_abs_2, FilterFunction_abs_3, FilterFunction_abs_4, FilterFunction_acos, FilterFunction_area, FilterFunction_asin, FilterFunction_atan, FilterFunction_atan2, FilterFunction_between, FilterFunction_boundary, FilterFunction_boundaryDimension, FilterFunction_buffer, FilterFunction_bufferWithSegments, FilterFunction_ceil, FilterFunction_centroid, FilterFunction_contains, FilterFunction_Convert, FilterFunction_convexHull, FilterFunction_cos, FilterFunction_crosses, FilterFunction_dateFormat, FilterFunction_dateParse, FilterFunction_difference, FilterFunction_dimension, FilterFunction_disjoint, FilterFunction_disjoint3D, FilterFunction_distance, FilterFunction_distance3D, FilterFunction_double2bool, FilterFunction_endAngle, FilterFunction_endPoint, FilterFunction_envelope, FilterFunction_equalsExact, FilterFunction_equalsExactTolerance, FilterFunction_equalTo, FilterFunction_exp, FilterFunction_exteriorRing, FilterFunction_floor, FilterFunction_geometryType, FilterFunction_geomFromWKT, FilterFunction_geomLength, FilterFunction_getGeometryN, FilterFunction_getX, FilterFunction_getY, FilterFunction_getZ, FilterFunction_greaterEqualThan, FilterFunction_greaterThan, FilterFunction_IEEEremainder, FilterFunction_if_then_else, FilterFunction_in10, FilterFunction_in2, FilterFunction_in3, FilterFunction_in4, FilterFunction_in5, FilterFunction_in6, FilterFunction_in7, FilterFunction_in8, FilterFunction_in9, FilterFunction_int2bbool, FilterFunction_int2ddouble, FilterFunction_interiorPoint, FilterFunction_interiorRingN, FilterFunction_intersection, FilterFunction_intersects, FilterFunction_intersects3D, FilterFunction_isClosed, FilterFunction_isCoverage, FilterFunction_isEmpty, FilterFunction_isLike, FilterFunction_isNull, FilterFunction_isometric, FilterFunction_isRing, FilterFunction_isSimple, FilterFunction_isValid, FilterFunction_isWithinDistance, FilterFunction_isWithinDistance3D, FilterFunction_lessEqualThan, FilterFunction_lessThan, FilterFunction_list, FilterFunction_listMultiply, FilterFunction_log, FilterFunction_max, FilterFunction_max_2, FilterFunction_max_3, FilterFunction_max_4, FilterFunction_min, FilterFunction_min_2, FilterFunction_min_3, FilterFunction_min_4, FilterFunction_minimumCircle, FilterFunction_minimumDiameter, FilterFunction_minimumRectangle, FilterFunction_not, FilterFunction_notEqualTo, FilterFunction_numberFormat, FilterFunction_numberFormat2, FilterFunction_numGeometries, FilterFunction_numInteriorRing, FilterFunction_numPoints, FilterFunction_octagonalEnvelope, FilterFunction_offset, FilterFunction_overlaps, FilterFunction_parseBoolean, FilterFunction_parseDouble, FilterFunction_parseInt, FilterFunction_parseLong, FilterFunction_pgNearest, FilterFunction_pointN, FilterFunction_pow, FilterFunction_property, FilterFunction_random, FilterFunction_relate, FilterFunction_relatePattern, FilterFunction_rint, FilterFunction_round, FilterFunction_round_2, FilterFunction_roundDouble, FilterFunction_sdonn, FilterFunction_setCRS, FilterFunction_sin, FilterFunction_sqrt, FilterFunction_startAngle, FilterFunction_startPoint, FilterFunction_strAbbreviate, FilterFunction_strCapitalize, FilterFunction_strConcat, FilterFunction_strDefaultIfBlank, FilterFunction_strEndsWith, FilterFunction_strEqualsIgnoreCase, FilterFunction_strIndexOf, FilterFunction_strLastIndexOf, FilterFunction_strLength, FilterFunction_strMatches, FilterFunction_strPosition, FilterFunction_strReplace, FilterFunction_strStartsWith, FilterFunction_strStripAccents, FilterFunction_strSubstring, FilterFunction_strSubstringStart, FilterFunction_strToLowerCase, FilterFunction_strToUpperCase, FilterFunction_strTrim, FilterFunction_strTrim2, FilterFunction_symDifference, FilterFunction_tan, FilterFunction_toDegrees, FilterFunction_toRadians, FilterFunction_touches, FilterFunction_toWKT, FilterFunction_union, FilterFunction_vertices, FilterFunction_within, FontAlternativesFunction, FootprintsTransformation, FormatDateTimezoneFunction, FunctionExpressionImpl, FunctionImpl, GeometryFunction, GetFunction, GrayscaleFunction, HasFunction, HSLFunction, IDFunction, IDFunctionExpression, InArrayFunction, InFunction, InternalVolatileFunction, InterpolateFunction, JenksNaturalBreaksFunction, JsonArrayContainsFunction, JsonPointerFunction, JsonSelectAllFunction, JsonSelectFunction, LapplyFunction, LengthFunction, LightenFunction, LinFunction, ListSizeFunction, LitemFunction, LiterateFunction, MapBoxAnchorFunction, MapBoxFontBaseNameFunction, MapBoxFontStyleFunction, MapBoxFontWeightFunction, MapBoxLengthFunction, MapGetFunction, MBColor, MBDecision, MBExpression, MBFeatureData, MBHeatmap, MBLookup, MBMath, MBRampsScalesCurves, MBString, MBTypes, MBVariableBinding, MBZoom, MixFunction, ModuloFunction, NestedCollectionLinkFunction, NorthFix, NowFunction, OrFunction, PaletteFunction, PiFunction, PointOnLineFunction, PolygonLabelFunction, ProcessFunction, PropertyExistsFunction, QuantileFunction, RecodeFunction, ReprojectingFilterVisitor.FunctionReprojector, RescaleToPixelsFunction, SaturateFunction, ShadeFunction, SizeFunction, SpinFunction, StandardDeviationFunction, StringInFunction, StringTemplateFunction, StringTransformFunction, TintFunction, ToDirectPositionFunction, ToEnvelopeFunction, ToLineStringFunction, ToPointFunction, ToRgb, ToXlinkHrefFunction, UniqueIntervalFunction, URLEncodeFunction, VocabFunction, ZoomLevelFunction

public interface Function
extends Expression

Instances of this class represent a function call into some implementation-specific function.

Each execution environment should provide a list of supported functions (and the number of arguments they expect) as part of a FilterCapabilities data structure.

This is included for completeness with respect to the OGC Filter specification. However, no functions are required to be supported by that specification.

Since:

GeoAPI 2.0

Author:

Chris Dillard (SYS Technologies)

Field Summary

Fields inherited from interface Expression

NIL

Method Summary

Modifier and Type	Method	Description
Literal	getFallbackValue()	The value of the fallbackValue attribute is used as a default value, if the SE implementation does not support the function.
FunctionName	getFunctionName()	Access to the FunctionName description as used in a FilterCapabilities document.
String	getName()	Returns the name of the function to be called.
List<Expression>	getParameters()	Returns the list subexpressions that will be evaluated to provide the parameters to the function.

Methods inherited from interface Expression

accept, evaluate, evaluate

Method Detail

getName

String getName()

Returns the name of the function to be called. For example, this might be "cos" or "atan2".

You can use this name to look up the number of required parameters in a FilterCapabilities data structure. For the specific meaning of the required parameters you will need to consult the documentation.

getFunctionName

FunctionName getFunctionName()

Access to the FunctionName description as used in a FilterCapabilities document.

Returns:

FunctionName description, if available.

getParameters

List<Expression> getParameters()

Returns the list subexpressions that will be evaluated to provide the parameters to the function.

getFallbackValue

Literal getFallbackValue()

The value of the fallbackValue attribute is used as a default value, if the SE implementation does not support the function. If the implementation supports the function, then the result value is determined by executing the function.

Returns:

Optional literal to use if an implementation for this function is not available.

Since:

GeoAPI 2.2