org.gvsig.catalog.languages

Class FilterEncoding

java.lang.Object

org.gvsig.catalog.languages.AbstractGeneralLanguage

org.gvsig.catalog.languages.FilterEncoding

All Implemented Interfaces:

ILanguages

public class FilterEncoding
extends AbstractGeneralLanguage

This class implements the Filter Encoding Language. It is used to create queries in this language

See Also:

http://portal.opengeospatial.org/files/?artifact_id=8340

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ESCAPE
static String	DEFAULT_NAMESPACE
static String	DEFAULT_PREFIX
static String	DEFAULT_SINGLECHAR
static String	DEFAULT_WILDCARD
static String	PROPERTY_IS_EQUALS_TO
static String	PROPERTY_IS_GREATER
static String	PROPERTY_IS_GREATER_THAN
static String	PROPERTY_IS_LESS
static String	PROPERTY_IS_LESS_THAN
static String	PROPERTY_IS_LIKE
static String	TYPE_LITERAL
static String	TYPE_TWO_PROPERTIES

Fields inherited from class org.gvsig.catalog.languages.AbstractGeneralLanguage

ALL_WORDS, and, AND, ANY_WORDS, currentClause, currentQuery, EXACT_WORDS, or, OR

Constructor Summary

Constructors

Constructor and Description
FilterEncoding() Create a new Filter Encoding Parser with the deafault values
FilterEncoding(String prefix, String wildCard, String singleChar, String escape) Create a new Filter Encoding Parser

Method Summary

Modifier and Type	Method and Description
void	addBoundingBox(Coordinates coordinates, String propertyName, boolean not) It Adds a Bounding Box query
void	addClauses(String propertyName, Iterator propertyValues, String concordancia, String relationship, String type, String operator) It Adds a new clause of the query
void	addClauses(String propertyName, String propertyValue, String concordancia) It Adds a new clause of the query
void	addClauses(String propertyName, String propertyValue, String concordancia, String relationship, String type, String operator) It Adds a new clause of the query
protected void	addCurrentClauseQuery(String operator) It adds the "and" label to join different operations
String	getEscapeCharLabel()
String	getSingleCharLabel()
String	getWildCard()
String	getWildCardLabel()
void	setEscapeCharLabel(String escapeCharLabel)
void	setSingleCharLabel(String singleCharLabel)
void	setWildCardLabel(String wildCardLabel)
String	toString() It returns the encoded query

Methods inherited from class org.gvsig.catalog.languages.AbstractGeneralLanguage

getOperator, parseValues, parseValues

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_IS_LIKE

public static final String PROPERTY_IS_LIKE

See Also:

Constant Field Values

PROPERTY_IS_LESS

public static final String PROPERTY_IS_LESS

See Also:

Constant Field Values

PROPERTY_IS_GREATER

public static final String PROPERTY_IS_GREATER

See Also:

Constant Field Values

PROPERTY_IS_GREATER_THAN

public static final String PROPERTY_IS_GREATER_THAN

See Also:

Constant Field Values

PROPERTY_IS_LESS_THAN

public static final String PROPERTY_IS_LESS_THAN

See Also:

Constant Field Values

PROPERTY_IS_EQUALS_TO

public static final String PROPERTY_IS_EQUALS_TO

See Also:

Constant Field Values

TYPE_LITERAL

public static final String TYPE_LITERAL

See Also:

Constant Field Values

TYPE_TWO_PROPERTIES

public static final String TYPE_TWO_PROPERTIES

See Also:

Constant Field Values

DEFAULT_PREFIX

public static final String DEFAULT_PREFIX

See Also:

Constant Field Values

DEFAULT_WILDCARD

public static final String DEFAULT_WILDCARD

See Also:

Constant Field Values

DEFAULT_SINGLECHAR

public static final String DEFAULT_SINGLECHAR

See Also:

Constant Field Values

DEFAULT_ESCAPE

public static final String DEFAULT_ESCAPE

See Also:

Constant Field Values

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

FilterEncoding

public FilterEncoding(String prefix,
                      String wildCard,
                      String singleChar,
                      String escape)

Create a new Filter Encoding Parser

Parameters:

prefix - Prefix of the labels (if its necessary). Typically "ogc".

wildCard - It Depends of the server

singleChar - It Depends of the server

escape - It Depends of the server

FilterEncoding

public FilterEncoding()

Create a new Filter Encoding Parser with the deafault values

Method Detail

addClauses

public void addClauses(String propertyName,
                       String propertyValue,
                       String concordancia,
                       String relationship,
                       String type,
                       String operator)

It Adds a new clause of the query

Parameters:

propertyName - The property name

propertyValue - The property value

concordancia - "E" (Exact phrase), "A" (All words) or "Y" (anY word).

relationship - PropertyIsLike, PropertyIsLess, PropertyIsGreater,... See the File encoding Documentation.

type - Values: "P" (to comparate two propertyes) or "L" (to comparate one property and one literal value)

operator - "And" or "Or". Operator between fields

addClauses

public void addClauses(String propertyName,
                       String propertyValue,
                       String concordancia)

It Adds a new clause of the query

Parameters:

propertyName - The property name

propertyValue - The property value

concordancia - "E" (Exact phrase), "A" (All words) or "Y" (anY word).

addClauses

public void addClauses(String propertyName,
                       Iterator propertyValues,
                       String concordancia,
                       String relationship,
                       String type,
                       String operator)

It Adds a new clause of the query

Parameters:

propertyName - The property name

propertyValues - The property value separated by blank spaces

concordancia - "E" (Exact phrase), "A" (All words) or "Y" (anY word).

relationship - PropertyIsLike, PropertyIsLess, PropertyIsGreater,... See the File encoding Documentation.

type - Values: "P" (to comparate two propertyes) or "L" (to comparate one property and one literal value)

operator - "And" or "Or". Operator between fields

addCurrentClauseQuery

protected void addCurrentClauseQuery(String operator)

It adds the "and" label to join different operations

Parameters:

operator -

toString

public String toString()

It returns the encoded query

Specified by:

toString in interface ILanguages

Overrides:

toString in class Object

Returns:

addBoundingBox

public void addBoundingBox(Coordinates coordinates,
                           String propertyName,
                           boolean not)

It Adds a Bounding Box query

Parameters:

coordinates - Coordinates to find

propertyName - Property that contains the geom field

not - If we have to envolve the query with the "NOT" tag.

getWildCard

public String getWildCard()

Returns:

the wildCard

getWildCardLabel

public String getWildCardLabel()

Returns:

the wildCardLabel

setWildCardLabel

public void setWildCardLabel(String wildCardLabel)

Parameters:

wildCardLabel - the wildCardLabel to set

getEscapeCharLabel

public String getEscapeCharLabel()

Returns:

the escapeCharLabel

setEscapeCharLabel

public void setEscapeCharLabel(String escapeCharLabel)

Parameters:

escapeCharLabel - the escapeCharLabel to set

getSingleCharLabel

public String getSingleCharLabel()

Returns:

the singleCharLabel

setSingleCharLabel

public void setSingleCharLabel(String singleCharLabel)

Parameters:

singleCharLabel - the singleCharLabel to set