org.geotools.filter
Class MinFunction

java.lang.Object
  org.geotools.filter.expression.ExpressionAbstract
      org.geotools.filter.DefaultExpression
          org.geotools.filter.FunctionExpressionImpl
              org.geotools.filter.MinFunction

All Implemented Interfaces:

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

public class MinFunction

extends FunctionExpressionImpl

implements FunctionExpression

A function that returns the minimum of two arguments.

Version:

$Id: MinFunction.java 18021 2006-02-14 20:36:18Z jdeolive $

Author:

James

Field Summary

Fields inherited from class org.geotools.filter.DefaultExpression

expressionType, permissiveConstruction

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

Constructor Summary

MinFunction()
Creates a new instance of MinFunction

Method Summary

java.lang.Object	evaluate(Feature feature) Returns a value for this expression.
int	getArgCount() Gets the number of arguments that are set.
Expression[]	getArgs() Gets the arguments to be evaluated by this function.
java.lang.String	getName() Gets the name of this function.
void	setArgs(Expression[] args) Sets the arguments to be evaluated by this function.
java.lang.String	toString() Return this function as a string.

Methods inherited from class org.geotools.filter.FunctionExpressionImpl

accept, getImplementationHints, getParameters, getType, setName, setParameters

Methods inherited from class org.geotools.filter.DefaultExpression

accept, evaluate, getValue, isAttributeExpression, isExpression, isGeometryExpression, isLiteralExpression, isMathExpression, isMathExpression

Methods inherited from class org.geotools.filter.expression.ExpressionAbstract

eval

Methods inherited from class java.lang.Object

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

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

getType

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

accept, 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

Constructor Detail

MinFunction

public MinFunction()

Creates a new instance of MinFunction

Method Detail

evaluate

public java.lang.Object evaluate(Feature feature)

Returns a value for this expression.

Specified by:

evaluate in interface Expression

Overrides:

evaluate in class DefaultExpression

Parameters:

feature - Specified feature to use when returning value.

Returns:

Value of the feature object.

getArgCount

public int getArgCount()

Gets the number of arguments that are set.

Specified by:

getArgCount in interface FunctionExpression

Specified by:

getArgCount in class FunctionExpressionImpl

Returns:

the number of args.

getName

public java.lang.String getName()

Gets the name of this function.

Specified by:

getName in interface FunctionExpression

Overrides:

getName in class FunctionExpressionImpl

Returns:

the name of the function.

setArgs

public void setArgs(Expression[] args)

Sets the arguments to be evaluated by this function.

Specified by:

setArgs in interface FunctionExpression

Overrides:

setArgs in class FunctionExpressionImpl

Parameters:

args - an array of expressions to be evaluated.

getArgs

public Expression[] getArgs()

Gets the arguments to be evaluated by this function.

Specified by:

getArgs in interface FunctionExpression

Overrides:

getArgs in class FunctionExpressionImpl

Returns:

an array of the args to be evaluated.

toString

public java.lang.String toString()

Return this function as a string.

Returns:

String representation of this min function.