LikeFilterImpl (Geotools modules 18-SNAPSHOT API)

Object
- FilterAbstract
- - AbstractFilter
  - - LikeFilterImpl

All Implemented Interfaces:

FilterType, Filter, MultiValuedFilter, PropertyIsLike
```
public class LikeFilterImpl
extends AbstractFilter
implements PropertyIsLike
```
Defines a like filter, which checks to see if an attribute matches a REGEXP.

Author:

Rob Hranac, Vision for New York

Nested Class Summary
- Nested classes/interfaces inherited from interface MultiValuedFilter
  MultiValuedFilter.MatchAction

Field Summary

Fields
Modifier and Type Field and Description

protected MultiValuedFilter.MatchAction matchAction
Used to indicate action with multiple values
- Fields inherited from class AbstractFilter
  LOGGER
- Fields inherited from interface PropertyIsLike
  NAME
- Fields inherited from interface Filter
  EXCLUDE, INCLUDE
- Fields inherited from interface FilterType
  ALL, 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, NONE, NULL

Fields
Modifier and Type	Field and Description
`protected MultiValuedFilter.MatchAction`	`matchAction` Used to indicate action with multiple values

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`LikeFilterImpl()` Constructor which flags the operator as like.
	`LikeFilterImpl(Expression expr, String pattern, String wildcardMulti, String wildcardSingle, String escape)`
	`LikeFilterImpl(Expression expr, String pattern, String wildcardMulti, String wildcardSingle, String escape, MultiValuedFilter.MatchAction matchAction)`
`protected`	`LikeFilterImpl(MultiValuedFilter.MatchAction matchAction)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`accept(FilterVisitor visitor, Object extraData)` Used by FilterVisitors to perform some action on this filter instance.
`static String`	`convertToSQL92(char escape, char multi, char single, boolean matchCase, String pattern)` Given OGC PropertyIsLike Filter information, construct an SQL-compatible 'like' pattern.
`boolean`	`equals(Object obj)` Compares this filter to the specified object.
`boolean`	`evaluate(Object feature)` Determines whether or not a given feature matches this pattern.
`String`	`getEscape()` Getter for property escape.
`Expression`	`getExpression()` Gets the expression for hte filter.
`String`	`getLiteral()` Returns the pattern.
`MultiValuedFilter.MatchAction`	`getMatchAction()` Flag Controlling MatchAction property When one or more of the operands evaluates to multiple values rather than a single value, which action should be taken?
`String`	`getPattern()` Deprecated. use `getLiteral()`
`String`	`getSingleChar()` THis method calls `getWildcardSingle()()` for subclass backwards compatability.
`String`	`getSQL92LikePattern()` see convertToSQL92
`String`	`getWildCard()` THis method calls `getWildcardMulti()` for subclass backwards compatability.
`String`	`getWildcardMulti()` Deprecated. use `getWildCard()`.
`String`	`getWildcardSingle()` Deprecated. use `getSingleChar()`
`int`	`hashCode()` Override of hashCode method.
`boolean`	`isMatchingCase()` Flag controlling wither comparisons are case sensitive.
`void`	`setEscape(String escape)`
`void`	`setExpression(Expression e)`
`void`	`setLiteral(String literal)` Sets the pattern.
`void`	`setMatchCase(boolean matchingCase)`
`void`	`setMatchingCase(boolean matchingCase)`
`void`	`setPattern(Expression p, String wildcardMulti, String wildcardSingle, String escape)` Deprecated. use one of `PropertyIsLike#setExpression(Expression)` `PropertyIsLike#setWildCard(String)` `PropertyIsLike#setSingleChar(String)` `PropertyIsLike#setEscape(String)`
`void`	`setPattern(String pattern, String wildcardMulti, String wildcardSingle, String escape)` Deprecated. use one of `PropertyIsLike#setLiteral(String)` `PropertyIsLike#setWildCard(String)` `PropertyIsLike#setSingleChar(String)` `PropertyIsLike#setEscape(String)`
`void`	`setSingleChar(String singleChar)`
`void`	`setValue(Expression attribute)` Deprecated. Use `setExpression(org.opengis.filter.expression.Expression)`
`void`	`setWildCard(String wildCard)`
`String`	`toString()` Return this filter as a string.

Methods inherited from class AbstractFilter
isCompareFilter, isGeometryDistanceFilter, isGeometryFilter, isLogicFilter, isMathFilter, isSimpleFilter

Methods inherited from class FilterAbstract
accepts, eval, eval

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - matchAction
```
protected MultiValuedFilter.MatchAction matchAction
```
    Used to indicate action with multiple values
- Constructor Detail
  - LikeFilterImpl
```
protected LikeFilterImpl()
```
    Constructor which flags the operator as like.
  - LikeFilterImpl
```
public LikeFilterImpl(Expression expr,
                      String pattern,
                      String wildcardMulti,
                      String wildcardSingle,
                      String escape)
```
  - LikeFilterImpl
```
protected LikeFilterImpl(MultiValuedFilter.MatchAction matchAction)
```
  - LikeFilterImpl
```
public LikeFilterImpl(Expression expr,
                      String pattern,
                      String wildcardMulti,
                      String wildcardSingle,
                      String escape,
                      MultiValuedFilter.MatchAction matchAction)
```
- Method Detail
  - convertToSQL92
```
public static String convertToSQL92(char escape,
                                    char multi,
                                    char single,
                                    boolean matchCase,
                                    String pattern)
                             throws IllegalArgumentException
```
    Given OGC PropertyIsLike Filter information, construct an SQL-compatible 'like' pattern. SQL % --> match any number of characters _ --> match a single character NOTE; the SQL command is 'string LIKE pattern [ESCAPE escape-character]' We could re-define the escape character, but I'm not doing to do that in this code since some databases will not handle this case. Method: 1. Examples: ( escape ='!', multi='*', single='.' ) broadway* -> 'broadway%' broad_ay -> 'broad_ay' broadway -> 'broadway' broadway!* -> 'broadway*' (* has no significance and is escaped) can't -> 'can''t' ( ' escaped for SQL compliance) NOTE: we also handle "'" characters as special because they are end-of-string characters. SQL will convert ' to '' (double single quote). NOTE: we dont handle "'" as a 'special' character because it would be too confusing to have a special char as another special char. Using this will throw an error (IllegalArgumentException).
    
    Parameters:
    
    escape -
    
    multi -
    
    single -
    
    pattern -
    
    Throws:
    
    IllegalArgumentException
  - getSQL92LikePattern
```
public String getSQL92LikePattern()
                           throws IllegalArgumentException
```
    see convertToSQL92
    
    Throws:
    
    IllegalArgumentException
  - setWildCard
```
public void setWildCard(String wildCard)
```
  - setSingleChar
```
public void setSingleChar(String singleChar)
```
  - setEscape
```
public void setEscape(String escape)
```
  - setMatchCase
```
public void setMatchCase(boolean matchingCase)
```
  - isMatchingCase
```
public boolean isMatchingCase()
```
    Description copied from interface: PropertyIsLike
    
    Flag controlling wither comparisons are case sensitive.
    The ability to match case is pending the Filter 2.0 specification.
    
    Specified by:
    
    isMatchingCase in interface PropertyIsLike
    
    Returns:
    
    true if the comparison is case sensetive, otherwise false.
  - getMatchAction
```
public MultiValuedFilter.MatchAction getMatchAction()
```
    Description copied from interface: MultiValuedFilter
    
    Flag Controlling MatchAction property When one or more of the operands evaluates to multiple values rather than a single value, which action should be taken? If there are n values for the left operand and m values for the right operand, there are n * m possible combinations that can be compared, ANY - if any of the possible combinations match, the result is true (aggregated OR) ALL - only if all of the possible combinations match, the result is true (aggregated AND) ONE - only if exactly one of the possible combinations match, the result is true (aggregated XOR)
    
    Specified by:
    
    getMatchAction in interface MultiValuedFilter
    
    Returns:
    
    MatchAction flag
  - setMatchingCase
```
public void setMatchingCase(boolean matchingCase)
```
  - setValue
```
public final void setValue(Expression attribute)
                    throws IllegalFilterException
```
    Deprecated. Use setExpression(org.opengis.filter.expression.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.
  - getExpression
```
public Expression getExpression()
```
    Gets the expression for hte filter.
    This method calls th deprecated #getValue() for backwards compatability with subclasses.
    
    Specified by:
    
    getExpression in interface PropertyIsLike
  - setExpression
```
public void setExpression(Expression e)
```
  - setPattern
```
public final void setPattern(Expression p,
                             String wildcardMulti,
                             String wildcardSingle,
                             String escape)
```
    Deprecated. use one of PropertyIsLike#setExpression(Expression) PropertyIsLike#setWildCard(String) PropertyIsLike#setSingleChar(String) 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
  - setPattern
```
public final void setPattern(String pattern,
                             String wildcardMulti,
                             String wildcardSingle,
                             String escape)
```
    Deprecated. use one of PropertyIsLike#setLiteral(String) PropertyIsLike#setWildCard(String) PropertyIsLike#setSingleChar(String) 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
  - getPattern
```
public final String getPattern()
```
    Deprecated. use getLiteral()
    
    Accessor method to retrieve the pattern.
    
    Returns:
    
    the pattern being matched.
  - getLiteral
```
public String getLiteral()
```
    Returns the pattern.
    
    Specified by:
    
    getLiteral in interface PropertyIsLike
  - setLiteral
```
public void setLiteral(String literal)
```
    Sets the pattern.
  - evaluate
```
public boolean evaluate(Object feature)
```
    Determines whether or not a given feature matches this pattern.
    
    Specified by:
    
    evaluate in interface Filter
    
    Parameters:
    
    feature - Specified feature to examine.
    
    Returns:
    
    Flag confirming whether or not this feature is inside the filter.
    
    TODO:
    
    REVISIT: could the pattern be null such that a null = null?
  - toString
```
public String toString()
```
    Return this filter as a string.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this like filter.
  - getEscape
```
public String getEscape()
```
    Getter for property escape.
    
    Specified by:
    
    getEscape in interface PropertyIsLike
    
    Returns:
    
    Value of property escape.
  - getWildcardMulti
```
public final String getWildcardMulti()
```
    Deprecated. use getWildCard().
    
    Getter for property wildcardMulti.
    
    Returns:
    
    Value of property wildcardMulti.
  - getWildCard
```
public String getWildCard()
```
    THis method calls getWildcardMulti() for subclass backwards compatability.
    
    Specified by:
    
    getWildCard in interface PropertyIsLike
    
    See Also:
    
    PropertyIsLike.getWildCard().
  - getWildcardSingle
```
public final String getWildcardSingle()
```
    Deprecated. use getSingleChar()
    
    Getter for property wildcardSingle.
    
    Returns:
    
    Value of property wildcardSingle.
  - getSingleChar
```
public String getSingleChar()
```
    THis method calls getWildcardSingle()() for subclass backwards compatability.
    
    Specified by:
    
    getSingleChar in interface PropertyIsLike
    
    See Also:
    
    PropertyIsLike.getSingleChar()().
  - equals
```
public boolean equals(Object obj)
```
    Compares this filter to the specified object. Returns true if the passed in object is the same as this filter. Checks to make sure the filter types, the value, and the pattern are the same. &
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - - the object to compare this LikeFilter against.
    
    Returns:
    
    true if specified object is equal to this filter; false otherwise.
  - hashCode
```
public int hashCode()
```
    Override of hashCode method.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code for this like filter implementation.
  - accept
```
public Object accept(FilterVisitor visitor,
                     Object extraData)
```
    Used by FilterVisitors to perform some action on this filter instance. Typicaly used by Filter decoders, but may also be used by any thing which needs infomration from filter structure. Implementations should always call: visitor.visit(this); It is importatant that this is not left to a parent class unless the parents API is identical.
    
    Specified by:
    
    accept in interface Filter
    
    Parameters:
    
    visitor - The visitor which requires access to this filter, the method must call visitor.visit(this);

Class LikeFilterImpl

Nested Class Summary

Nested classes/interfaces inherited from interface MultiValuedFilter

Field Summary

Fields inherited from class AbstractFilter

Fields inherited from interface PropertyIsLike

Fields inherited from interface Filter

Fields inherited from interface FilterType

Constructor Summary

Method Summary

Methods inherited from class AbstractFilter

Methods inherited from class FilterAbstract

Methods inherited from class Object

Field Detail

matchAction

Constructor Detail

LikeFilterImpl

LikeFilterImpl

LikeFilterImpl

LikeFilterImpl

Method Detail

convertToSQL92

getSQL92LikePattern

setWildCard

setSingleChar

setEscape

setMatchCase

isMatchingCase

getMatchAction

setMatchingCase

setValue

getExpression

setExpression

setPattern

setPattern

getPattern

getLiteral

setLiteral

evaluate

toString

getEscape

getWildcardMulti

getWildCard

getWildcardSingle

getSingleChar

equals

hashCode

accept