org.deegree.filter.expression.custom
Class AbstractCustomExpression

java.lang.Object
  org.deegree.filter.expression.custom.AbstractCustomExpression

All Implemented Interfaces:

Expression, CustomExpression

Direct Known Subclasses:

Categorize, ChangeCase, Concatenate, FormatDate, FormatNumber, Interpolate, Recode, StringLength, StringPosition, Substring, Trim

public abstract class AbstractCustomExpression
extends Object
implements CustomExpression

Base class for implementing CustomExpressions.

Version:

$Revision: 31664 $, $Date: 2011-08-26 16:18:07 +0200 (Fri, 26 Aug 2011) $

Author:

Markus Schneider, last edited by: $Author: mschneider $

Nested Class Summary

Nested classes/interfaces inherited from interface org.deegree.filter.Expression

Expression.Type

Constructor Summary

AbstractCustomExpression()

Method Summary

Expression[]	getParams() Returns the expression's paramters.
Expression.Type	getType() Returns the type of expression.
abstract CustomExpression	parse(XMLStreamReader xmlStream)
CustomExpression	parse100(XMLStreamReader xmlStream) Returns the object representation for the given ogc:Function element event (Filter Encoding 1.0.0) that the cursor of the given XMLStreamReader points at.
CustomExpression	parse110(XMLStreamReader xmlStream) Returns the object representation for the given ogc:Function element event (Filter Encoding 1.1.0) that the cursor of the given XMLStreamReader points at.
CustomExpression	parse200(XMLStreamReader xmlStream) Returns the object representation for the given ogc:Function element event (Filter Encoding 2.0.0) that the cursor of the given XMLStreamReader points at.
String	toString(String indent)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deegree.filter.expression.custom.CustomExpression

getElementName

Methods inherited from interface org.deegree.filter.Expression

evaluate

Constructor Detail

AbstractCustomExpression

public AbstractCustomExpression()

Method Detail

getType

public Expression.Type getType()

Description copied from interface: Expression

Returns the type of expression. Use this to safely determine the subtype of Expression.

Specified by:

getType in interface Expression

Returns:

type of expression

parse100

public CustomExpression parse100(XMLStreamReader xmlStream)
                          throws XMLStreamException

Description copied from interface: CustomExpression

Returns the object representation for the given ogc:Function element event (Filter Encoding 1.0.0) that the cursor of the given XMLStreamReader points at.

• Precondition: cursor must point at the START_ELEMENT event (<ogc:function>)
• Postcondition: cursor points at the corresponding END_ELEMENT event (</ogc:function>)

Specified by:

parse100 in interface CustomExpression

Parameters:

xmlStream - cursor must point at the START_ELEMENT event (<ogc:Function>), points at the corresponding END_ELEMENT event (</ogc:Function>) afterwards

Returns:

corresponding Expression object

Throws:

XMLStreamException

parse110

public CustomExpression parse110(XMLStreamReader xmlStream)
                          throws XMLStreamException

Description copied from interface: CustomExpression

Returns the object representation for the given ogc:Function element event (Filter Encoding 1.1.0) that the cursor of the given XMLStreamReader points at.

• Precondition: cursor must point at the START_ELEMENT event (<ogc:function>)
• Postcondition: cursor points at the corresponding END_ELEMENT event (</ogc:function>)

Specified by:

parse110 in interface CustomExpression

Parameters:

xmlStream - cursor must point at the START_ELEMENT event (<ogc:Function>), points at the corresponding END_ELEMENT event (</ogc:Function>) afterwards

Returns:

corresponding Expression object

Throws:

XMLStreamException

parse200

public CustomExpression parse200(XMLStreamReader xmlStream)
                          throws XMLStreamException

Description copied from interface: CustomExpression

Returns the object representation for the given ogc:Function element event (Filter Encoding 2.0.0) that the cursor of the given XMLStreamReader points at.

• Precondition: cursor must point at the START_ELEMENT event (<ogc:function>)
• Postcondition: cursor points at the corresponding END_ELEMENT event (</ogc:function>)

Specified by:

parse200 in interface CustomExpression

Parameters:

xmlStream - cursor must point at the START_ELEMENT event (<ogc:Function>), points at the corresponding END_ELEMENT event (</ogc:Function>) afterwards

Returns:

corresponding Expression object

Throws:

XMLStreamException

parse

public abstract CustomExpression parse(XMLStreamReader xmlStream)
                                throws XMLStreamException

Parameters:

xmlStream -

Throws:

XMLStreamException

getParams

public Expression[] getParams()

Description copied from interface: Expression

Returns the expression's paramters.

Specified by:

getParams in interface Expression

Returns:

the parameters of the expression

toString

public String toString(String indent)

Specified by:

toString in interface Expression