org.geotools.brewer.color
Class PaletteFunction

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.brewer.color.PaletteFunction
All Implemented Interfaces:
Factory, ExpressionType, FunctionExpression, org.opengis.filter.expression.Expression, org.opengis.filter.expression.Function

public class PaletteFunction
extends FunctionExpressionImpl
implements FunctionExpression

Author:
James Macgill

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
PaletteFunction()
          Creates a new instance of PaletteFunction
PaletteFunction(org.opengis.filter.FilterFactory factory)
           
 
Method Summary
 java.lang.Object evaluate(org.opengis.feature.simple.SimpleFeature feature)
          Returns a value for this expression.
 int getArgCount()
          Gets the number of arguments that are set.
 ClassificationFunction getClassifier()
           
 org.opengis.filter.expression.Expression getEvaluationExpression()
           
 int getNumberOfClasses()
           
 java.lang.String getPaletteName()
           
 void setClassifier(ClassificationFunction cf)
           
 void setEvaluationExpression(org.opengis.filter.expression.Expression e)
           
 void setFilterFactory(org.opengis.filter.FilterFactory factory)
           
 void setNumberOfClasses(int i)
           
 void setPaletteName(java.lang.String s)
           
 void setParameters(java.util.List args)
          Sets the function parameters.
 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
 
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.FunctionExpression
getArgs, getName, getType, setArgs
 
Methods inherited from interface org.geotools.filter.Expression
accept, getValue
 
Methods inherited from interface org.geotools.factory.Factory
getImplementationHints
 
Methods inherited from interface org.opengis.filter.expression.Function
getFallbackValue, getParameters
 
Methods inherited from interface org.opengis.filter.expression.Expression
accept, evaluate, evaluate
 

Constructor Detail

PaletteFunction

public PaletteFunction()
Creates a new instance of PaletteFunction


PaletteFunction

public PaletteFunction(org.opengis.filter.FilterFactory factory)
Method Detail

setFilterFactory

public void setFilterFactory(org.opengis.filter.FilterFactory factory)

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.

setParameters

public void setParameters(java.util.List args)
Description copied from class: FunctionExpressionImpl
Sets the function parameters.

Specified by:
setParameters in interface FunctionExpression
Overrides:
setParameters in class FunctionExpressionImpl

getEvaluationExpression

public org.opengis.filter.expression.Expression getEvaluationExpression()

setEvaluationExpression

public void setEvaluationExpression(org.opengis.filter.expression.Expression e)

getClassifier

public ClassificationFunction getClassifier()

setClassifier

public void setClassifier(ClassificationFunction cf)

getNumberOfClasses

public int getNumberOfClasses()

setNumberOfClasses

public void setNumberOfClasses(int i)

getPaletteName

public java.lang.String getPaletteName()

setPaletteName

public void setPaletteName(java.lang.String s)

evaluate

public java.lang.Object evaluate(org.opengis.feature.simple.SimpleFeature feature)
Description copied from class: DefaultExpression
Returns a value for this expression. If the expression is an attribute expression then the attribute of the feature should be returned. If a literal then the feature is ignored, the literal is returned as it has no relation to the feature.

Overrides:
evaluate in class DefaultExpression
Parameters:
feature - Specified feature to use when returning value.
Returns:
The value of this expression based on the feature.

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


Copyright © 1996-2010 Geotools. All Rights Reserved.