org.geotools.filter.expression
Interface LiteralExpression

All Superinterfaces:
org.opengis.filter.expression.Expression, Expression, ExpressionType, org.opengis.filter.expression.Literal
All Known Subinterfaces:
BBoxExpression
All Known Implementing Classes:
BBoxExpressionImpl, ConstantExpression, LiteralExpressionImpl

public interface LiteralExpression
extends Expression, org.opengis.filter.expression.Literal

Defines an expression that holds a literal for return.

Version:
$Id: LiteralExpression.java 18021 2006-02-14 20:36:18Z jdeolive $
Author:
Rob Hranac, Vision for New York, Chris Holmes, TOPP

Field Summary
 
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
 
Method Summary
 java.lang.Object getLiteral()
          Deprecated. use Literal.getValue().
 short getType()
          Returns the literal type.
 java.lang.Object getValue(Feature feature)
          Deprecated. use Expression.evaluate(Feature).
 void setLiteral(java.lang.Object literal)
          Deprecated. use Literal.setValue(Object)
 
Methods inherited from interface org.geotools.filter.expression.Expression
accept, evaluate
 
Methods inherited from interface org.opengis.filter.expression.Expression
accept, evaluate
 
Methods inherited from interface org.opengis.filter.expression.Literal
getValue, setValue
 

Method Detail

setLiteral

public void setLiteral(java.lang.Object literal)
                throws IllegalFilterException
Deprecated. use Literal.setValue(Object)

Sets the literal.

Parameters:
literal - The literal to store inside this expression.
Throws:
IllegalFilterException - This literal type is not in scope.

getValue

public java.lang.Object getValue(Feature feature)
Deprecated. use Expression.evaluate(Feature).

Gets the value of this literal.

Specified by:
getValue in interface Expression
Parameters:
feature - Required by the interface but not used.
Returns:
the literal held by this expression. Ignores the passed in feature.

getType

public short getType()
Returns the literal type.

Specified by:
getType in interface Expression
Returns:
the short representation of the literal expression type.

getLiteral

public java.lang.Object getLiteral()
Deprecated. use Literal.getValue().

Retrieves the literal of this expression.

Returns:
the literal held by this expression.


Copyright © GeoTools. All Rights Reserved.