org.deegree.filter.expression
Class Function

java.lang.Object
  org.deegree.filter.expression.Function

All Implemented Interfaces:

Expression

Direct Known Subclasses:

Categorize, ChangeCase, Concatenate, FormatDate, FormatNumber, Interpolate, IsCurve, IsPoint, IsSurface, Recode, StringLength, StringPosition, Substring, Trim

public class Function
extends Object
implements Expression

TODO add documentation here

Version:

$Revision:$, $Date:$

Author:

Markus Schneider , last edited by: $Author:$

Nested Class Summary

Nested classes/interfaces inherited from interface org.deegree.filter.Expression

Expression.Type

Constructor Summary

Function(String name, List<Expression> params)

Method Summary

Object[]	evaluate(MatchableObject object) Determines the values of the expression for the given MatchableObject.
String	getName()
List<Expression>	getParameters()
Expression[]	getParams() Returns the expression's paramters.
Expression.Type	getType() Returns the type of expression.
String	toString(String indent)

Methods inherited from class java.lang.Object

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

Constructor Detail

Function

public Function(String name,
                List<Expression> params)

Method Detail

getName

public String getName()

getParameters

public List<Expression> getParameters()

getType

public Expression.Type getType()

Description copied from interface: Expression

Returns the type of expression. Use this to safely determine the subtype of Expression.

Specified by:

getType in interface Expression

Returns:

type of expression

evaluate

public Object[] evaluate(MatchableObject object)
                  throws FilterEvaluationException

Description copied from interface: Expression

Determines the values of the expression for the given MatchableObject.

Note that this returns an Object[], as an expression may evaluate to multiple values, e.g. a PropertyName that targets a multi property of a feature.

Specified by:

evaluate in interface Expression

Parameters:

object - object that the expression is evaluated upon

Returns:

the values of the expression, may be empty (and even contain null values), but never null

Throws:

FilterEvaluationException

toString

public String toString(String indent)

Specified by:

toString in interface Expression

getParams

public Expression[] getParams()

Description copied from interface: Expression

Returns the expression's paramters.

Specified by:

getParams in interface Expression

Returns:

the parameters of the expression