org.geotools.filter
Class FilterCapabilities

Object
  extended by FilterCapabilities

Deprecated. use FilterCapabilities.

public class FilterCapabilities
extends Object

Represents the Filter capabilities that are supported by a SQLEncoder

Each SQLEncoder class should have one static FilterCapabilities, representing the filter encoding operations that it can successfully perform.

This class is used as one big mask to detect filters that cannot be performed

Author:
Chris Holmes, TOPP
Module:
modules/library/main (gt-main.jar)

Field Summary
static long ALL
          Deprecated. Mask for Filter.EXCLUDE
static long BETWEEN
          Deprecated. Scalar Mask for between opelongion
static long COMPARE_EQUALS
          Deprecated.  
static long COMPARE_GREATER_THAN
          Deprecated.  
static long COMPARE_GREATER_THAN_EQUAL
          Deprecated.  
static long COMPARE_LESS_THAN
          Deprecated.  
static long COMPARE_LESS_THAN_EQUAL
          Deprecated.  
static long COMPARE_NOT_EQUALS
          Deprecated.  
static long FID
          Deprecated.  
static long FUNCTIONS
          Deprecated. Scalar Mask for function operations
static long LIKE
          Deprecated. Scalar Mask for like operation
static long LOGIC_AND
          Deprecated.  
static long LOGIC_NOT
          Deprecated.  
static long LOGIC_OR
          Deprecated.  
static long LOGICAL
          Deprecated. Scalar Mask for logical operation
static FilterCapabilities LOGICAL_OPENGIS
          Deprecated.  
static long NO_OP
          Deprecated. Mask for no operation
static long NONE
          Deprecated. Mask for Filter.INCLUDE
static long NULL_CHECK
          Deprecated. Scalar Mask for null check operation
static long SIMPLE_ARITHMETIC
          Deprecated. Scalar Mask for simple arithmetic operations
static long SIMPLE_COMPARISONS
          Deprecated. Scalar Mask for simple comparison operations
static FilterCapabilities SIMPLE_COMPARISONS_OPENGIS
          Deprecated.  
static long SPATIAL_BBOX
          Deprecated. Spatial Mask for bbox operation
static long SPATIAL_BEYOND
          Deprecated. Spatial Mask for beyond operation
static long SPATIAL_CONTAINS
          Deprecated. Spatial Mask for contains operation
static long SPATIAL_CROSSES
          Deprecated. Spatial Mask for crosses operation
static long SPATIAL_DISJOINT
          Deprecated. Spatial Mask for disjoint operation
static long SPATIAL_DWITHIN
          Deprecated. Spatial Mask for dwithin operation
static long SPATIAL_EQUALS
          Deprecated. Spatial Mask for equals operation
static long SPATIAL_INTERSECT
          Deprecated. Spatial Mask for intersect operation
static long SPATIAL_OVERLAPS
          Deprecated. Spatial Mask for overlaps operation
static long SPATIAL_TOUCHES
          Deprecated. Spatial Mask for touches operation
static long SPATIAL_WITHIN
          Deprecated. Spatial Mask for within operation
 
Constructor Summary
FilterCapabilities()
          Deprecated.  
FilterCapabilities(Class type)
          Deprecated.  
FilterCapabilities(long filterCapabilitiesType)
          Deprecated.  
 
Method Summary
 void addAll(FilterCapabilities capabilities)
          Deprecated. Add all the capabilities in the provided FilterCapabilities to this capabilities.
 void addType(Class type)
          Deprecated. Adds a new support type to capabilities.
 void addType(Class type, boolean addFunctionType)
          Deprecated. Adds a new support type to capabilities.
 void addType(long type)
          Deprecated. Adds a new support type to capabilities.
 void addType(short type)
          Deprecated.  
 FilterCapabilities convertFilterTypeToMask(short type)
          Deprecated. Returns the mask that is equivalent to the FilterType constant.
static FilterCapabilities findFunction(String name)
          Deprecated. Translates a String into an object that represents function expression
static FilterCapabilities findOperation(String name)
          Deprecated. Translates a String into an object that represents the operation
 boolean fullySupports(Filter filter)
          Deprecated. Determines if the filter and all its sub filters are supported.
 long getScalarOps()
          Deprecated.  
 long getSpatialOps()
          Deprecated.  
 boolean supports(Class type)
          Deprecated.  
 boolean supports(Filter filter)
          Deprecated. Determines if the filter passed in is supported.
 boolean supports(FilterCapabilities type)
          Deprecated.  
 boolean supports(long type)
          Deprecated.  
 boolean supports(short type)
          Deprecated.  
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NO_OP

public static final long NO_OP
Deprecated. 
Mask for no operation

See Also:
Constant Field Values

NONE

public static final long NONE
Deprecated. 
Mask for Filter.INCLUDE

See Also:
Constant Field Values

ALL

public static final long ALL
Deprecated. 
Mask for Filter.EXCLUDE

See Also:
Constant Field Values

SPATIAL_BBOX

public static final long SPATIAL_BBOX
Deprecated. 
Spatial Mask for bbox operation

See Also:
Constant Field Values

SPATIAL_EQUALS

public static final long SPATIAL_EQUALS
Deprecated. 
Spatial Mask for equals operation

See Also:
Constant Field Values

SPATIAL_DISJOINT

public static final long SPATIAL_DISJOINT
Deprecated. 
Spatial Mask for disjoint operation

See Also:
Constant Field Values

SPATIAL_INTERSECT

public static final long SPATIAL_INTERSECT
Deprecated. 
Spatial Mask for intersect operation

See Also:
Constant Field Values

SPATIAL_TOUCHES

public static final long SPATIAL_TOUCHES
Deprecated. 
Spatial Mask for touches operation

See Also:
Constant Field Values

SPATIAL_CROSSES

public static final long SPATIAL_CROSSES
Deprecated. 
Spatial Mask for crosses operation

See Also:
Constant Field Values

SPATIAL_WITHIN

public static final long SPATIAL_WITHIN
Deprecated. 
Spatial Mask for within operation

See Also:
Constant Field Values

SPATIAL_CONTAINS

public static final long SPATIAL_CONTAINS
Deprecated. 
Spatial Mask for contains operation

See Also:
Constant Field Values

SPATIAL_OVERLAPS

public static final long SPATIAL_OVERLAPS
Deprecated. 
Spatial Mask for overlaps operation

See Also:
Constant Field Values

SPATIAL_BEYOND

public static final long SPATIAL_BEYOND
Deprecated. 
Spatial Mask for beyond operation

See Also:
Constant Field Values

SPATIAL_DWITHIN

public static final long SPATIAL_DWITHIN
Deprecated. 
Spatial Mask for dwithin operation

See Also:
Constant Field Values

LIKE

public static final long LIKE
Deprecated. 
Scalar Mask for like operation

See Also:
Constant Field Values

BETWEEN

public static final long BETWEEN
Deprecated. 
Scalar Mask for between opelongion

See Also:
Constant Field Values

NULL_CHECK

public static final long NULL_CHECK
Deprecated. 
Scalar Mask for null check operation

See Also:
Constant Field Values

SIMPLE_ARITHMETIC

public static final long SIMPLE_ARITHMETIC
Deprecated. 
Scalar Mask for simple arithmetic operations

See Also:
Constant Field Values

FUNCTIONS

public static final long FUNCTIONS
Deprecated. 
Scalar Mask for function operations

See Also:
Constant Field Values

COMPARE_EQUALS

public static final long COMPARE_EQUALS
Deprecated. 
See Also:
Constant Field Values

COMPARE_GREATER_THAN

public static final long COMPARE_GREATER_THAN
Deprecated. 
See Also:
Constant Field Values

COMPARE_GREATER_THAN_EQUAL

public static final long COMPARE_GREATER_THAN_EQUAL
Deprecated. 
See Also:
Constant Field Values

COMPARE_LESS_THAN

public static final long COMPARE_LESS_THAN
Deprecated. 
See Also:
Constant Field Values

COMPARE_LESS_THAN_EQUAL

public static final long COMPARE_LESS_THAN_EQUAL
Deprecated. 
See Also:
Constant Field Values

COMPARE_NOT_EQUALS

public static final long COMPARE_NOT_EQUALS
Deprecated. 
See Also:
Constant Field Values

FID

public static final long FID
Deprecated. 
See Also:
Constant Field Values

LOGIC_AND

public static final long LOGIC_AND
Deprecated. 
See Also:
Constant Field Values

LOGIC_NOT

public static final long LOGIC_NOT
Deprecated. 
See Also:
Constant Field Values

LOGIC_OR

public static final long LOGIC_OR
Deprecated. 
See Also:
Constant Field Values

LOGICAL

public static final long LOGICAL
Deprecated. 
Scalar Mask for logical operation

See Also:
Constant Field Values

SIMPLE_COMPARISONS

public static final long SIMPLE_COMPARISONS
Deprecated. 
Scalar Mask for simple comparison operations

See Also:
Constant Field Values

SIMPLE_COMPARISONS_OPENGIS

public static final FilterCapabilities SIMPLE_COMPARISONS_OPENGIS
Deprecated. 

LOGICAL_OPENGIS

public static final FilterCapabilities LOGICAL_OPENGIS
Deprecated. 
Constructor Detail

FilterCapabilities

public FilterCapabilities(long filterCapabilitiesType)
Deprecated. 

FilterCapabilities

public FilterCapabilities()
Deprecated. 

FilterCapabilities

public FilterCapabilities(Class type)
Deprecated. 
Method Detail

addType

public void addType(long type)
Deprecated. 
Adds a new support type to capabilities.

Parameters:
type - The one of the masks enumerated in this class

addType

public void addType(Class type)
Deprecated. 
Adds a new support type to capabilities. For 2.2 only function expression support is added this way. As of geotools 2.3 this will be the supported way of adding to Filtercapabilities.

Parameters:
type - the Class that indicates the new support.

addType

public void addType(Class type,
                    boolean addFunctionType)
Deprecated. 
Adds a new support type to capabilities. For 2.2 only function expression support is added this way. As of geotools 2.3 this will be the supported way of adding to Filtercapabilities.

Parameters:
type - the Class that indicates the new support.

addAll

public void addAll(FilterCapabilities capabilities)
Deprecated. 
Add all the capabilities in the provided FilterCapabilities to this capabilities.

Parameters:
capabilities - capabilities to add.

addType

public void addType(short type)
Deprecated. 

Adds a new support type to capabilities.

Parameters:
type - The FilterType type that is supported
See Also:
convertFilterTypeToMask(short), addType(long)

convertFilterTypeToMask

public FilterCapabilities convertFilterTypeToMask(short type)
Deprecated. 
Returns the mask that is equivalent to the FilterType constant.

Parameters:
type - a constant from FilterType
Returns:
the mask that is equivalent to the FilterType constant.

supports

public boolean supports(Filter filter)
Deprecated. 
Determines if the filter passed in is supported.

Parameters:
filter - The Filter to be tested.
Returns:
true if supported, false otherwise.

fullySupports

public boolean fullySupports(Filter filter)
Deprecated. 
Determines if the filter and all its sub filters are supported. Is most important for logic filters, as they are the only ones with subFilters. Null filters should not be used here, if nothing should be filtered than Filter.INCLUDE can be used. Embedded nulls can be a particular source of problems, buried in logic filters.

Parameters:
filter - the filter to be tested.
Returns:
true if all sub filters are supported, false otherwise.
Throws:
IllegalArgumentException - If a null filter is passed in. As this function is recursive a null in a logic filter will also cause an error.

supports

public boolean supports(short type)
Deprecated. 

Determines if the filter type passed in is supported.

Parameters:
type - The AbstractFilter type to be tested
Returns:
true if supported, false otherwise.

supports

public boolean supports(long type)
Deprecated. 

supports

public boolean supports(FilterCapabilities type)
Deprecated. 

supports

public boolean supports(Class type)
Deprecated. 

getScalarOps

public long getScalarOps()
Deprecated. 

getSpatialOps

public long getSpatialOps()
Deprecated. 

findOperation

public static FilterCapabilities findOperation(String name)
Deprecated. 
Translates a String into an object that represents the operation

Parameters:
name - String, operation name
Returns:
one of the FilterCapabilities constants

findFunction

public static FilterCapabilities findFunction(String name)
Deprecated. 
Translates a String into an object that represents function expression

Parameters:
name - String, expression name
Returns:
one of the FilterCapabilities constants


Copyright © 1996-2009 Geotools. All Rights Reserved.