org.geotools.filter.expression
Interface FunctionExpression

All Superinterfaces:

org.opengis.filter.expression.Expression, Expression, ExpressionType, Factory, org.opengis.filter.expression.Function

All Known Implementing Classes:

AreaFunction, ClassificationFunction, Collection_AverageFunction, Collection_BoundsFunction, Collection_CountFunction, Collection_MaxFunction, Collection_MedianFunction, Collection_MinFunction, Collection_SumFunction, Collection_UniqueFunction, FilterFunction_area, FilterFunction_between, FilterFunction_boundary, FilterFunction_boundaryDimension, FilterFunction_buffer, FilterFunction_bufferWithSegments, FilterFunction_centroid, FilterFunction_contains, FilterFunction_convexHull, FilterFunction_crosses, FilterFunction_difference, FilterFunction_dimension, FilterFunction_disjoint, FilterFunction_distance, FilterFunction_double2bool, FilterFunction_endPoint, FilterFunction_envelope, FilterFunction_equalsExact, FilterFunction_equalsExactTolerance, FilterFunction_equalTo, FilterFunction_exteriorRing, FilterFunction_geometryType, FilterFunction_geomFromWKT, FilterFunction_geomLength, FilterFunction_getGeometryN, FilterFunction_getX, FilterFunction_getY, FilterFunction_greaterEqualThan, FilterFunction_greaterThan, 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_isClosed, FilterFunction_isEmpty, FilterFunction_isLike, FilterFunction_isNull, FilterFunction_isRing, FilterFunction_isSimple, FilterFunction_isValid, FilterFunction_isWithinDistance, FilterFunction_lessEqualThan, FilterFunction_lessThan, FilterFunction_not, FilterFunction_notEqualTo, FilterFunction_numGeometries, FilterFunction_numInteriorRing, FilterFunction_numPoints, FilterFunction_overlaps, FilterFunction_parseBoolean, FilterFunction_parseDouble, FilterFunction_parseInt, FilterFunction_pointN, FilterFunction_relate, FilterFunction_relatePattern, FilterFunction_roundDouble, FilterFunction_startPoint, FilterFunction_strConcat, FilterFunction_strEndsWith, FilterFunction_strEqualsIgnoreCase, FilterFunction_strIndexOf, FilterFunction_strLastIndexOf, FilterFunction_strLength, FilterFunction_strMatches, FilterFunction_strStartsWith, FilterFunction_strSubstring, FilterFunction_strSubstringStart, FilterFunction_strTrim, FilterFunction_symDifference, FilterFunction_touches, FilterFunction_toWKT, FilterFunction_union, FilterFunction_within, FunctionExpressionImpl, MaxFunction, MinFunction, PaletteFunction

public interface FunctionExpression

extends Expression, Factory, org.opengis.filter.expression.Function

Interface for a function expression implementation

Author:

James Macgill, PSU

Field Summary

Fields inherited from interface org.geotools.filter.expression.ExpressionType

ATTRIBUTE, ATTRIBUTE_DOUBLE, ATTRIBUTE_GEOMETRY, ATTRIBUTE_INTEGER, ATTRIBUTE_STRING, ATTRIBUTE_UNDECLARED, FUNCTION, LITERAL_DOUBLE, LITERAL_GEOMETRY, LITERAL_INTEGER, LITERAL_STRING, MATH_ADD, MATH_DIVIDE, MATH_MULTIPLY, MATH_SUBTRACT

Method Summary

int	getArgCount() Returns the number of arguments this requires.
Expression[]	getArgs() Deprecated. use Function.getParameters()
java.lang.String	getName() Gets the name of this function.
short	getType() Gets the type of this expression.
void	setArgs(Expression[] args) Deprecated. use Function.setParameters(List)

Methods inherited from interface org.geotools.filter.expression.Expression

accept, evaluate, getValue

Methods inherited from interface org.opengis.filter.expression.Expression

accept, evaluate

Methods inherited from interface org.geotools.factory.Factory

getImplementationHints

Methods inherited from interface org.opengis.filter.expression.Function

getParameters, setName, setParameters

Method Detail

getArgCount

public int getArgCount()

Returns the number of arguments this requires. For example [arg1][arg2]. This function must have EXACTLY 2 arguments, so this function would return 2. The parser might use this information to ensure validity, and its also for reporting capabilities. NOTE: this was previously javadoc-ed incorrectly, please note the new definition. NOTE: you cannot have a function with a variable number of arguments.

Returns:

the number of args required by this function.

getType

public short getType()

Gets the type of this expression.

Specified by:

getType in interface Expression

Returns:

the short representation of a function expression.

getArgs

public Expression[] getArgs()

Deprecated. use Function.getParameters()

Gets the arguments to be evaluated by this function.

Returns:

an array of the args to be evaluated.

getName

public java.lang.String getName()

Gets the name of this function.

Specified by:

getName in interface org.opengis.filter.expression.Function

Returns:

the name of the function.

setArgs

public void setArgs(Expression[] args)

Deprecated. use Function.setParameters(List)

Sets the arguments to be evaluated by this function.

Parameters:

args - an array of expressions to be evaluated.