Package org.n52.shetland.ogc.filter

Class ComparisonFilter

java.lang.Object

org.n52.shetland.ogc.filter.Filter<FilterConstants.ComparisonOperator>

org.n52.shetland.ogc.filter.ComparisonFilter

All Implemented Interfaces:

AbstractSelectionClause, FilterClause

public class ComparisonFilter
extends Filter<FilterConstants.ComparisonOperator>

OGC Filter class for comparison filter

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
ComparisonFilter()	default constructor
ComparisonFilter(FilterConstants.ComparisonOperator operator, String valueReference, String value)	constructor
ComparisonFilter(FilterConstants.ComparisonOperator operator, String valueReference, String value, String valueUpper)	constructor for FilterConstants.ComparisonOperator.PropertyIsBetween filter
ComparisonFilter(FilterConstants.ComparisonOperator operator, String valueReference, String value, String valueUpper, String escapeString)	constructor for FilterConstants.ComparisonOperator.PropertyIsLike filter

Method Summary

Modifier and Type	Method	Description
ComparisonFilter	copy()
String	getEscapeString()	Get escape characters
FilterConstants.ComparisonOperator	getOperator()	Get filter operator.
String	getSingleChar()	Get single char character
String	getValue()	Get filter value
String	getValueUpper()	Get upper filter value
String	getWildCard()	Get wild card character
boolean	isMatchCase()
boolean	isSetEscapeString()	Check if escape string is not null or empty
boolean	isSetSingleChar()	Check if single char is not null or empty
boolean	isSetValue()	Check if value is not null or empty
boolean	isSetValueUpper()	Check if value upper is not null or empty
boolean	isSetWildCard()	Check if wild card is not null or empty
void	setEscapeString(String escapeString)	Set escape characters
void	setMatchCase(boolean matchCase)
ComparisonFilter	setOperator(FilterConstants.ComparisonOperator operator)	Set filter operator.
void	setSingleChar(String singleChar)	Set single char character
void	setValue(String value)	Set filter value
void	setValueUpper(String valueUpper)	Set upper filter value
void	setWildCard(String wildCard)	Set wild card character
String	toString()

Methods inherited from class org.n52.shetland.ogc.filter.Filter

getValueReference, hasValueReference, isSetOperator, setValueReference

Methods inherited from class java.lang.Object

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

Constructor Detail

ComparisonFilter

public ComparisonFilter()

default constructor

ComparisonFilter

public ComparisonFilter(FilterConstants.ComparisonOperator operator,
                        String valueReference,
                        String value)

constructor

Parameters:

operator - Filter operator

valueReference - valueReference

value - value

ComparisonFilter

public ComparisonFilter(FilterConstants.ComparisonOperator operator,
                        String valueReference,
                        String value,
                        String valueUpper)
                 throws OwsExceptionReport

constructor for FilterConstants.ComparisonOperator.PropertyIsBetween filter

Parameters:

operator - Filter operator

valueReference - valueReference

value - value

valueUpper - upper value

Throws:

OwsExceptionReport - If operator is not FilterConstants.ComparisonOperator.PropertyIsBetween

ComparisonFilter

public ComparisonFilter(FilterConstants.ComparisonOperator operator,
                        String valueReference,
                        String value,
                        String valueUpper,
                        String escapeString)
                 throws OwsExceptionReport

constructor for FilterConstants.ComparisonOperator.PropertyIsLike filter

Parameters:

operator - Filter operator

valueReference - valueReference

value - value

valueUpper - upper value for between filter

escapeString - Escape characters

Throws:

OwsExceptionReport - If operator is not FilterConstants.ComparisonOperator.PropertyIsLike

Method Detail

getOperator

public FilterConstants.ComparisonOperator getOperator()

Description copied from class: Filter

Get filter operator.

Specified by:

getOperator in class Filter<FilterConstants.ComparisonOperator>

Returns:

filter operator

setOperator

public ComparisonFilter setOperator(FilterConstants.ComparisonOperator operator)

Description copied from class: Filter

Set filter operator.

Specified by:

setOperator in class Filter<FilterConstants.ComparisonOperator>

Parameters:

operator - filter operator

Returns:

this

getValue

public String getValue()

Get filter value

Returns:

filter value

getValueUpper

public String getValueUpper()

Get upper filter value

Returns:

upper filter value

setValue

public void setValue(String value)

Set filter value

Parameters:

value - filter value

setValueUpper

public void setValueUpper(String valueUpper)

Set upper filter value

Parameters:

valueUpper - upper filter value

getEscapeString

public String getEscapeString()

Get escape characters

Returns:

escape characters

setEscapeString

public void setEscapeString(String escapeString)

Set escape characters

Parameters:

escapeString - escape characters

getWildCard

public String getWildCard()

Get wild card character

Returns:

wild card character

setWildCard

public void setWildCard(String wildCard)

Set wild card character

Parameters:

wildCard - wild card character

getSingleChar

public String getSingleChar()

Get single char character

Returns:

single char character

setSingleChar

public void setSingleChar(String singleChar)

Set single char character

Parameters:

singleChar - single char character

isSetValue

public boolean isSetValue()

Check if value is not null or empty

Returns:

true, if value is not empty

isSetValueUpper

public boolean isSetValueUpper()

Check if value upper is not null or empty

Returns:

true, if value upper is not empty

isSetEscapeString

public boolean isSetEscapeString()

Check if escape string is not null or empty

Returns:

true, if escape string is not empty

isSetWildCard

public boolean isSetWildCard()

Check if wild card is not null or empty

Returns:

true, if wild card is not empty

isSetSingleChar

public boolean isSetSingleChar()

Check if single char is not null or empty

Returns:

true, if single char is not empty

isMatchCase

public boolean isMatchCase()

Returns:

the matchCase

setMatchCase

public void setMatchCase(boolean matchCase)

Parameters:

matchCase - the matchCase to set

copy

public ComparisonFilter copy()

toString

public String toString()

Overrides:

toString in class Object