org.geotools.filter
Interface LikeFilter

All Superinterfaces:

Filter, org.opengis.filter.Filter, FilterType, org.opengis.filter.PropertyIsLike

All Known Implementing Classes:

LikeFilterImpl

public interface LikeFilter

extends Filter, org.opengis.filter.PropertyIsLike

Defines a like filter, which checks to see if an attribute matches a REGEXP.

Version:

$Id: LikeFilter.java 18021 2006-02-14 20:36:18Z jdeolive $

Author:

Rob Hranac, Vision for New York

Field Summary

Fields inherited from interface org.geotools.filter.Filter

ALL, NONE

Fields inherited from interface org.geotools.filter.FilterType

BETWEEN, COMPARE_EQUALS, COMPARE_GREATER_THAN, COMPARE_GREATER_THAN_EQUAL, COMPARE_LESS_THAN, COMPARE_LESS_THAN_EQUAL, COMPARE_NOT_EQUALS, FID, GEOMETRY_BBOX, GEOMETRY_BEYOND, GEOMETRY_CONTAINS, GEOMETRY_CROSSES, GEOMETRY_DISJOINT, GEOMETRY_DWITHIN, GEOMETRY_EQUALS, GEOMETRY_INTERSECTS, GEOMETRY_OVERLAPS, GEOMETRY_TOUCHES, GEOMETRY_WITHIN, LIKE, LOGIC_AND, LOGIC_NOT, LOGIC_OR, NULL

Method Summary

boolean	contains(Feature feature) Deprecated. use org.opengis.filter.Filter#evaluate(Feature)
java.lang.String	getEscape() Deprecated. use PropertyIsLike.getEscape()
java.lang.String	getPattern() Deprecated. use PropertyIsLike.getLiteral()
Expression	getValue() Deprecated. use PropertyIsLike.getExpression()
java.lang.String	getWildcardMulti() Deprecated. use PropertyIsLike.getWildCard()
java.lang.String	getWildcardSingle() Deprecated. use PropertyIsLike.getSingleChar()()
void	setPattern(Expression p, java.lang.String wildcardMulti, java.lang.String wildcardSingle, java.lang.String escape) Deprecated. use one of PropertyIsLike.setExpression(Expression) PropertyIsLike#setWildCard(String) {@link PropertyIsLike#setSingleChar(String)} {@link PropertyIsLike#setEscape(String)}
void	setPattern(java.lang.String pattern, java.lang.String wildcardMulti, java.lang.String wildcardSingle, java.lang.String escape) Deprecated. use one of PropertyIsLike.setExpression(Expression) PropertyIsLike#setWildCard(String) {@link PropertyIsLike#setSingleChar(String)} {@link PropertyIsLike#setEscape(String)}
void	setValue(Expression attribute) Deprecated. use PropertyIsLike.setExpression(Expression)

Methods inherited from interface org.geotools.filter.Filter

accept, and, evaluate, getFilterType, not, or

Methods inherited from interface org.opengis.filter.Filter

accept, evaluate

Methods inherited from interface org.opengis.filter.PropertyIsLike

getExpression, getLiteral, getSingleChar, getWildCard, setEscape, setExpression, setLiteral, setSingleChar, setWildCard

Method Detail

setPattern

public void setPattern(java.lang.String pattern,
                       java.lang.String wildcardMulti,
                       java.lang.String wildcardSingle,
                       java.lang.String escape)

Deprecated. use one of PropertyIsLike.setExpression(Expression) PropertyIsLike#setWildCard(String) {@link PropertyIsLike#setSingleChar(String)} {@link PropertyIsLike#setEscape(String)}

Sets the match pattern for this FilterLike.

Parameters:

pattern - The string which contains the match pattern for this filter.

wildcardMulti - The string that represents a mulitple character (1->n) wildcard.

wildcardSingle - The string that represents a single character (1) wildcard.

escape - The string that represents an escape character.

getWildcardMulti

public java.lang.String getWildcardMulti()

Deprecated. use PropertyIsLike.getWildCard()

Getter for property wildcardMulti.

Returns:

Value of property wildcardMulti.

getEscape

public java.lang.String getEscape()

Deprecated. use PropertyIsLike.getEscape()

Accessor for property escape.

Specified by:

getEscape in interface org.opengis.filter.PropertyIsLike

Returns:

Value of property escape.

setPattern

public void setPattern(Expression p,
                       java.lang.String wildcardMulti,
                       java.lang.String wildcardSingle,
                       java.lang.String escape)

Deprecated. use one of PropertyIsLike.setExpression(Expression) PropertyIsLike#setWildCard(String) {@link PropertyIsLike#setSingleChar(String)} {@link PropertyIsLike#setEscape(String)}

Sets the match pattern for this FilterLike.

Parameters:

p - The expression which evaluates to the match pattern for this filter.

wildcardMulti - The string that represents a mulitple character (1->n) wildcard.

wildcardSingle - the string that represents a single character (1) wildcard.

escape - The string that represents an escape character.

getPattern

public java.lang.String getPattern()

Deprecated. use PropertyIsLike.getLiteral()

Accessor method to retrieve the pattern.

Returns:

the pattern being matched.

setValue

public void setValue(Expression attribute)
              throws IllegalFilterException

Deprecated. use PropertyIsLike.setExpression(Expression)

Sets the expression to be evalutated as being like the pattern.

Parameters:

attribute - The value of the attribute for comparison.

Throws:

IllegalFilterException - Filter is illegal, adding something other than a string attribute.

getValue

public Expression getValue()

Deprecated. use PropertyIsLike.getExpression()

Gets the Value (left hand side) of this filter.

Returns:

The expression that is the value of the filter.

getWildcardSingle

public java.lang.String getWildcardSingle()

Deprecated. use PropertyIsLike.getSingleChar()()

Accessor for property wildcardSingle.

Returns:

Value of property wildcardSingle.

contains

public boolean contains(Feature feature)

Deprecated. use org.opengis.filter.Filter#evaluate(Feature)

Determines whether or not a given feature matches this pattern.

Specified by:

contains in interface Filter

Parameters:

feature - Specified feature to examine.

Returns:

Flag confirming whether or not this feature is inside the filter.

Task:

REVISIT: could the pattern be null such that a null = null?