org.deegree.filter.xml
Class Filter200XMLDecoder

java.lang.Object
  org.deegree.filter.xml.Filter200XMLDecoder

public class Filter200XMLDecoder
extends Object

Decodes XML fragments that comply to the OGC Filter Encoding Specification 2.0.0.

Version:

$Revision: 31902 $, $Date: 2011-09-15 22:37:15 +0200 (Thu, 15 Sep 2011) $

Author:

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

Constructor Summary

Filter200XMLDecoder()

Method Summary

static Filter	parse(XMLStreamReader xmlStream) Returns the object representation for the given fes:Filter element event that the cursor of the given XMLStreamReader points at.
static ComparisonOperator	parseComparisonOperator(XMLStreamReader xmlStream) Returns the object representation for the given fes:comparisonOps element event that the cursor of the given XMLStreamReader points at.
static CustomExpression	parseCustomExpression(XMLStreamReader xmlStream) Returns the object representation for the custom fes:expression substitution element event that the cursor of the given XMLStreamReader points at.
static Expression	parseExpression(XMLStreamReader xmlStream) Returns the object representation for the given fes:expression element event that the cursor of the associated XMLStreamReader points at.
static Function	parseFunction(XMLStreamReader xmlStream) Returns the object representation for the given fes:Function element event that the cursor of the associated XMLStreamReader points at.
static TemporalOperator	parseTemporalOperator(XMLStreamReader xmlStream) Returns the object representation for the given fes:temporalOps element event that the cursor of the given XMLStreamReader points at.

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter200XMLDecoder

public Filter200XMLDecoder()

Method Detail

parse

public static Filter parse(XMLStreamReader xmlStream)
                    throws XMLParsingException,
                           XMLStreamException

Returns the object representation for the given fes:Filter element event that the cursor of the given XMLStreamReader points at.

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

Parameters:

xmlStream - must not be null and cursor must point at the START_ELEMENT event (<fes:Filter>), points at the corresponding END_ELEMENT event (</fes:Filter>) afterwards

Returns:

corresponding Filter object, never null

Throws:

XMLParsingException - if the element is not a valid "fes:Filter" element

XMLStreamException

parseExpression

public static Expression parseExpression(XMLStreamReader xmlStream)
                                  throws XMLStreamException

Returns the object representation for the given fes:expression element event that the cursor of the associated XMLStreamReader points at.

The element must be one of the following:

• fes:ValueReference
• fes:Literal
• fes:Function
• substitution for fes:expression (handled by CustomExpression instance)

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

Parameters:

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

Returns:

corresponding Expression object, never null

Throws:

XMLParsingException - if the element is not a valid "fes:expression" element

XMLStreamException

parseFunction

public static Function parseFunction(XMLStreamReader xmlStream)
                              throws XMLStreamException

Returns the object representation for the given fes:Function element event that the cursor of the associated XMLStreamReader points at.

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

Parameters:

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

Returns:

corresponding Function object, never null

Throws:

XMLParsingException - if the element is not a valid "ogc:Function" element

XMLStreamException

parseCustomExpression

public static CustomExpression parseCustomExpression(XMLStreamReader xmlStream)
                                              throws XMLStreamException

Returns the object representation for the custom fes:expression substitution element event that the cursor of the given XMLStreamReader points at.

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

Parameters:

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

Returns:

corresponding CustomExpression object

Throws:

XMLParsingException - if the element is not a known or valid custom "fes:expression" element

XMLStreamException

parseComparisonOperator

public static ComparisonOperator parseComparisonOperator(XMLStreamReader xmlStream)
                                                  throws XMLStreamException

Returns the object representation for the given fes:comparisonOps element event that the cursor of the given XMLStreamReader points at.

The element must be one of the following:

• fes:PropertyIsEqualTo
• fes:PropertyIsGreaterThan
• fes:PropertyIsGreaterThanOrEqualTo
• fes:PropertyIsLessThan
• fes:PropertyIsLessThanOrEqualTo
• fes:PropertyIsNotEqualTo
• fes:PropertyIsBetween
• fes:PropertyIsLike
• fes:PropertyIsNull
• fes:PropertyIsNil

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

Parameters:

xmlStream - must not be null and cursor must point at the START_ELEMENT event (<fes:comparisonOps>), points at the corresponding END_ELEMENT event (</fes:comparisonOps>) afterwards

Returns:

corresponding ComparisonOperator object, never null

Throws:

XMLParsingException - if the element is not a valid "ogc:comparisonOps" element

XMLStreamException

parseTemporalOperator

public static TemporalOperator parseTemporalOperator(XMLStreamReader xmlStream)
                                              throws XMLStreamException

Returns the object representation for the given fes:temporalOps element event that the cursor of the given XMLStreamReader points at.

The element must be one of the following:

• fes:After
• fes:AnyInteracts
• fes:Before
• fes:Begins
• fes:BegunBy
• fes:During
• fes:EndedBy
• fes:Meets
• fes:MetBy
• fes:Overlapped
• fes:TContains
• fes:TEquals
• fes:TOverlaps

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

Parameters:

xmlStream - must not be null and cursor must point at the START_ELEMENT event (<fes:temporalOps>), points at the corresponding END_ELEMENT event (</fes:temporalOps>) afterwards

Returns:

corresponding TemporalOperator object, never null

Throws:

XMLParsingException - if the element is not a valid "ogc:temporalOps" element

XMLStreamException