org.geotools.filter.function.math
Class PiFunction

java.lang.Object
  extended by org.geotools.filter.expression.ExpressionAbstract
      extended by org.geotools.filter.DefaultExpression
          extended by org.geotools.filter.FunctionExpressionImpl
              extended by org.geotools.filter.function.math.PiFunction
All Implemented Interfaces:
Factory, ExpressionType, FunctionExpression, org.opengis.filter.expression.Expression, org.opengis.filter.expression.Function

public class PiFunction
extends FunctionExpressionImpl

Allow access to the value of Math.PI as an expression

Since:
2.2, 2.5
Author:
Jody Garnett

Field Summary
 
Fields inherited from class org.geotools.filter.FunctionExpressionImpl
fallback, name, params
 
Fields inherited from class org.geotools.filter.DefaultExpression
expressionType, permissiveConstruction
 
Fields inherited from interface org.geotools.filter.ExpressionType
ATTRIBUTE, ATTRIBUTE_DOUBLE, ATTRIBUTE_GEOMETRY, ATTRIBUTE_INTEGER, ATTRIBUTE_STRING, ATTRIBUTE_UNDECLARED, FUNCTION, LITERAL_DOUBLE, LITERAL_GEOMETRY, LITERAL_INTEGER, LITERAL_LONG, LITERAL_STRING, LITERAL_UNDECLARED, MATH_ADD, MATH_DIVIDE, MATH_MULTIPLY, MATH_SUBTRACT
 
Fields inherited from interface org.opengis.filter.expression.Expression
NIL
 
Constructor Summary
PiFunction()
           
 
Method Summary
 java.lang.Object evaluate(java.lang.Object object)
          This method checks if the object is an instance of Feature and if so, calls through to #evaluate(Feature).
 int getArgCount()
          Gets the number of arguments that are set.
 java.lang.String toString()
          Creates a String representation of this Function with the function name and the arguments.
 
Methods inherited from class org.geotools.filter.FunctionExpressionImpl
accept, equals, getArgs, getExpression, getFallbackValue, getImplementationHints, getName, getParameters, getType, setArgs, setFallbackValue, setName, setParameters
 
Methods inherited from class org.geotools.filter.DefaultExpression
accept, evaluate, getValue, isAttributeExpression, isExpression, isFunctionExpression, isGeometryExpression, isLiteralExpression, isMathExpression, isMathExpression
 
Methods inherited from class org.geotools.filter.expression.ExpressionAbstract
eval, eval, evaluate
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.geotools.filter.Expression
accept, evaluate, getValue
 
Methods inherited from interface org.opengis.filter.expression.Expression
evaluate
 

Constructor Detail

PiFunction

public PiFunction()
Method Detail

getArgCount

public int getArgCount()
Description copied from class: FunctionExpressionImpl
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.

toString

public java.lang.String toString()
Description copied from class: FunctionExpressionImpl
Creates a String representation of this Function with the function name and the arguments. The String created should be good for most subclasses

Overrides:
toString in class FunctionExpressionImpl

evaluate

public java.lang.Object evaluate(java.lang.Object object)
Description copied from class: DefaultExpression
This method checks if the object is an instance of Feature and if so, calls through to #evaluate(Feature). This is done to maintain backwards compatability with previous version of Expression api which depended on Feature. If the object is not an instance of feature the super implementation is called.

Specified by:
evaluate in interface org.opengis.filter.expression.Expression
Overrides:
evaluate in class DefaultExpression


Copyright © 1996-2010 Geotools. All Rights Reserved.