org.geotools.filter
Class FilterCapabilitiesMask

java.lang.Object
  org.geotools.filter.FilterCapabilities
      org.geotools.filter.FilterCapabilitiesMask

public class FilterCapabilitiesMask

extends FilterCapabilities

This class should be merged with FilterCapabilities at some point

Author:

dzwiers

Field Summary

static int	BBOX Spatial Mask for bbox operation
static int	BETWEEN Scalar Mask for between operation
static int	BEYOND Spatial Mask for beyond operation
static int	CONTAINS Spatial Mask for contains operation
static int	CROSSES Spatial Mask for crosses operation
static int	DISJOINT Spatial Mask for disjoint operation
static int	DWITHIN Spatial Mask for dwithin operation
static int	EQUALS Spatial Mask for equals operation
static int	FUNCTIONS Scalar Mask for function operations
static int	INTERSECT Spatial Mask for intersect operation
static int	LIKE Scalar Mask for like operation
static int	LOGICAL Scalar Mask for logical operation
static int	NO_OP Mask for no operation
static int	NULL_CHECK Scalar Mask for null check operation
static int	OVERLAPS Spatial Mask for overlaps operation
static int	SIMPLE_ARITHMETIC Scalar Mask for simple arithmetic operations
static int	SIMPLE_COMPARISONS Scalar Mask for simple comparison operations
static int	TOUCHES Spatial Mask for touches operation
static int	WITHIN Spatial Mask for within operation

Constructor Summary

FilterCapabilitiesMask()

Method Summary

void	addType(short type) Adds a new support type to capabilities.
static int	findOperation(java.lang.String s) Translates a String into an int mask for the operation
boolean	fullySupports(Filter filter) Determines if the filter and all its sub filters are supported.
int	getScalarOps()
int	getSpatialOps()
boolean	supports(Filter filter) Determines if the filter passed in is supported.
boolean	supports(short type) Determines if the filter type passed in is supported.
static java.lang.String	writeScalarOperation(int i) Converts a singular mask to the appropriate string as a Scalar Op
static java.lang.String	writeSpatialOperation(int i) Converts a singular mask to the appropriate string as a Spatial Op

Methods inherited from class java.lang.Object

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

Field Detail

NO_OP

public static final int NO_OP

Mask for no operation

See Also:

Constant Field Values

BBOX

public static final int BBOX

Spatial Mask for bbox operation

See Also:

Constant Field Values

EQUALS

public static final int EQUALS

Spatial Mask for equals operation

See Also:

Constant Field Values

DISJOINT

public static final int DISJOINT

Spatial Mask for disjoint operation

See Also:

Constant Field Values

INTERSECT

public static final int INTERSECT

Spatial Mask for intersect operation

See Also:

Constant Field Values

TOUCHES

public static final int TOUCHES

Spatial Mask for touches operation

See Also:

Constant Field Values

CROSSES

public static final int CROSSES

Spatial Mask for crosses operation

See Also:

Constant Field Values

WITHIN

public static final int WITHIN

Spatial Mask for within operation

See Also:

Constant Field Values

CONTAINS

public static final int CONTAINS

Spatial Mask for contains operation

See Also:

Constant Field Values

OVERLAPS

public static final int OVERLAPS

Spatial Mask for overlaps operation

See Also:

Constant Field Values

BEYOND

public static final int BEYOND

Spatial Mask for beyond operation

See Also:

Constant Field Values

DWITHIN

public static final int DWITHIN

Spatial Mask for dwithin operation

See Also:

Constant Field Values

LOGICAL

public static final int LOGICAL

Scalar Mask for logical operation

See Also:

Constant Field Values

SIMPLE_COMPARISONS

public static final int SIMPLE_COMPARISONS

Scalar Mask for simple comparison operations

See Also:

Constant Field Values

LIKE

public static final int LIKE

Scalar Mask for like operation

See Also:

Constant Field Values

BETWEEN

public static final int BETWEEN

Scalar Mask for between operation

See Also:

Constant Field Values

NULL_CHECK

public static final int NULL_CHECK

Scalar Mask for null check operation

See Also:

Constant Field Values

SIMPLE_ARITHMETIC

public static final int SIMPLE_ARITHMETIC

Scalar Mask for simple arithmetic operations

See Also:

Constant Field Values

FUNCTIONS

public static final int FUNCTIONS

Scalar Mask for function operations

See Also:

Constant Field Values

Constructor Detail

FilterCapabilitiesMask

public FilterCapabilitiesMask()

Method Detail

findOperation

public static int findOperation(java.lang.String s)

Translates a String into an int mask for the operation

Parameters:

s - String, operation name

Returns:

one of the filter constants

writeSpatialOperation

public static java.lang.String writeSpatialOperation(int i)

Converts a singular mask to the appropriate string as a Spatial Op

Parameters:

i - The int constant

Returns:

The String representation of the int as a FilterType

writeScalarOperation

public static java.lang.String writeScalarOperation(int i)

Converts a singular mask to the appropriate string as a Scalar Op

Parameters:

i - The int constant

Returns:

The String representation of the int as a FilterType

addType

public void addType(short type)

Description copied from class: FilterCapabilities

Adds a new support type to capabilities.

Overrides:

addType in class FilterCapabilities

Parameters:

type - The AbstractFilter type that is supported

fullySupports

public boolean fullySupports(Filter filter)

Description copied from class: FilterCapabilities

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.NONE can be used. Embedded nulls can be a particular source of problems, buried in logic filters.

Overrides:

fullySupports in class FilterCapabilities

Parameters:

filter - the filter to be tested.

Returns:

true if all sub filters are supported, false otherwise.

supports

public boolean supports(Filter filter)

Description copied from class: FilterCapabilities

Determines if the filter passed in is supported.

Overrides:

supports in class FilterCapabilities

Parameters:

filter - The Filter to be tested.

Returns:

true if supported, false otherwise.

supports

public boolean supports(short type)

Description copied from class: FilterCapabilities

Determines if the filter type passed in is supported.

Overrides:

supports in class FilterCapabilities

Parameters:

type - The AbstractFilter type to be tested

Returns:

true if supported, false otherwise.

getScalarOps

public int getScalarOps()

getSpatialOps

public int getSpatialOps()