org.geotools.filter.function

Class Collection_SumFunction

Object

ExpressionAbstract

DefaultExpression

FunctionExpressionImpl

Collection_SumFunction

All Implemented Interfaces:

FunctionExpression, Factory, Expression, Function

public class Collection_SumFunction
extends FunctionExpressionImpl

Calculates the sum value of an attribute for a given FeatureCollection and Expression.

Since:

2.2M2

Author:

Cory Horner

Field Summary

Fields

Modifier and Type	Field and Description
static FunctionName	NAME

Fields inherited from class FunctionExpressionImpl

fallback, functionName, name, params

Fields inherited from interface Expression

NIL

Constructor Summary

Constructors

Constructor and Description
Collection_SumFunction() Creates a new instance of Collection_SumFunction

Method Summary

Modifier and Type	Method and Description
Object	evaluate(Object feature) Subclass should override, default implementation returns null.
void	setExpression(Expression e)
void	setParameters(List<Expression> args) The provided arguments are evaulated with respect to the FeatureCollection.

Methods inherited from class FunctionExpressionImpl

accept, equals, functionName, getExpression, getFallbackValue, getFunctionName, getImplementationHints, getName, getParameters, hashCode, setFallbackValue, toString

Methods inherited from class DefaultExpression

isAttributeExpression, isExpression, isFunctionExpression, isGeometryExpression, isLiteralExpression, isMathExpression

Methods inherited from class ExpressionAbstract

evaluate

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Expression

evaluate

Field Detail

NAME

public static FunctionName NAME

Constructor Detail

Collection_SumFunction

public Collection_SumFunction()

Creates a new instance of Collection_SumFunction

Method Detail

setParameters

public void setParameters(List<Expression> args)

The provided arguments are evaulated with respect to the FeatureCollection.

For an aggregate function (like sum) please use the WFS mandated XPath syntax to refer to featureMember content.

To refer to all 'X': featureMember/asterisk/X

Specified by:

setParameters in interface FunctionExpression

Overrides:

setParameters in class FunctionExpressionImpl

evaluate

public Object evaluate(Object feature)

Description copied from class: ExpressionAbstract

Subclass should override, default implementation returns null.

Specified by:

evaluate in interface Expression

Overrides:

evaluate in class FunctionExpressionImpl

Returns:

default implementation returns null

setExpression

public void setExpression(Expression e)