public class FilterCapabilities extends Object
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
FilterCapabilities
.Modifier and Type | Field and Description |
---|---|
static long |
ALL
Mask for Filter.EXCLUDE
|
static long |
BETWEEN
Scalar Mask for between opelongion
|
static long |
COMPARE_EQUALS |
static long |
COMPARE_GREATER_THAN |
static long |
COMPARE_GREATER_THAN_EQUAL |
static long |
COMPARE_LESS_THAN |
static long |
COMPARE_LESS_THAN_EQUAL |
static long |
COMPARE_NOT_EQUALS |
static long |
FID |
static long |
FUNCTIONS
Scalar Mask for function operations
|
static long |
LIKE
Scalar Mask for like operation
|
static long |
LOGIC_AND |
static long |
LOGIC_NOT |
static long |
LOGIC_OR |
static long |
LOGICAL
Scalar Mask for logical operation
|
static FilterCapabilities |
LOGICAL_OPENGIS |
static long |
NO_OP
Mask for no operation
|
static long |
NONE
Mask for Filter.INCLUDE
|
static long |
NULL_CHECK
Scalar Mask for null check operation
|
static long |
SIMPLE_ARITHMETIC
Scalar Mask for simple arithmetic operations
|
static long |
SIMPLE_COMPARISONS
Scalar Mask for simple comparison operations
|
static FilterCapabilities |
SIMPLE_COMPARISONS_OPENGIS |
static long |
SPATIAL_BBOX
Spatial Mask for bbox operation
|
static long |
SPATIAL_BEYOND
Spatial Mask for beyond operation
|
static long |
SPATIAL_CONTAINS
Spatial Mask for contains operation
|
static long |
SPATIAL_CROSSES
Spatial Mask for crosses operation
|
static long |
SPATIAL_DISJOINT
Spatial Mask for disjoint operation
|
static long |
SPATIAL_DWITHIN
Spatial Mask for dwithin operation
|
static long |
SPATIAL_EQUALS
Spatial Mask for equals operation
|
static long |
SPATIAL_INTERSECT
Spatial Mask for intersect operation
|
static long |
SPATIAL_OVERLAPS
Spatial Mask for overlaps operation
|
static long |
SPATIAL_TOUCHES
Spatial Mask for touches operation
|
static long |
SPATIAL_WITHIN
Spatial Mask for within operation
|
Constructor and Description |
---|
FilterCapabilities() |
FilterCapabilities(Class type) |
FilterCapabilities(long filterCapabilitiesType) |
Modifier and Type | Method and Description |
---|---|
void |
addAll(FilterCapabilities capabilities)
Add all the capabilities in the provided FilterCapabilities to this capabilities.
|
void |
addType(Class type)
Adds a new support type to capabilities.
|
void |
addType(Class type,
boolean addFunctionType)
Adds a new support type to capabilities.
|
void |
addType(long type)
Adds a new support type to capabilities.
|
FilterCapabilities |
convertFilterTypeToMask(short type)
Returns the mask that is equivalent to the FilterType constant.
|
static FilterCapabilities |
findFunction(String name)
Translates a String into an object that represents function expression
|
static FilterCapabilities |
findOperation(String name)
Translates a String into an object that represents the operation
|
boolean |
fullySupports(Filter filter)
Determines if the filter and all its sub filters are supported.
|
long |
getScalarOps() |
long |
getSpatialOps() |
boolean |
supports(Class type) |
boolean |
supports(Filter filter)
Determines if the filter passed in is supported.
|
boolean |
supports(FilterCapabilities type) |
public static final long NO_OP
public static final long NONE
public static final long ALL
public static final long SPATIAL_BBOX
public static final long SPATIAL_EQUALS
public static final long SPATIAL_DISJOINT
public static final long SPATIAL_INTERSECT
public static final long SPATIAL_TOUCHES
public static final long SPATIAL_CROSSES
public static final long SPATIAL_WITHIN
public static final long SPATIAL_CONTAINS
public static final long SPATIAL_OVERLAPS
public static final long SPATIAL_BEYOND
public static final long SPATIAL_DWITHIN
public static final long LIKE
public static final long BETWEEN
public static final long NULL_CHECK
public static final long SIMPLE_ARITHMETIC
public static final long FUNCTIONS
public static final long COMPARE_EQUALS
public static final long COMPARE_GREATER_THAN
public static final long COMPARE_GREATER_THAN_EQUAL
public static final long COMPARE_LESS_THAN
public static final long COMPARE_LESS_THAN_EQUAL
public static final long COMPARE_NOT_EQUALS
public static final long FID
public static final long LOGIC_AND
public static final long LOGIC_NOT
public static final long LOGIC_OR
public static final long LOGICAL
public static final long SIMPLE_COMPARISONS
public static final FilterCapabilities SIMPLE_COMPARISONS_OPENGIS
public static final FilterCapabilities LOGICAL_OPENGIS
public FilterCapabilities(long filterCapabilitiesType)
public FilterCapabilities()
public FilterCapabilities(Class type)
public void addType(long type)
type
- The one of the masks enumerated in this classpublic void addType(Class type)
type
- the Class that indicates the new support.public void addType(Class type, boolean addFunctionType)
type
- the Class that indicates the new support.public void addAll(FilterCapabilities capabilities)
capabilities
- capabilities to add.public FilterCapabilities convertFilterTypeToMask(short type)
type
- a constant from FilterType
public boolean supports(Filter filter)
filter
- The Filter to be tested.public boolean fullySupports(Filter filter)
filter
- the filter to be tested.IllegalArgumentException
- If a null filter is passed in. As this function is recursive
a null in a logic filter will also cause an error.public boolean supports(FilterCapabilities type)
public boolean supports(Class type)
public long getScalarOps()
public long getSpatialOps()
public static FilterCapabilities findOperation(String name)
name
- String, operation nameFilterCapabilities
constantspublic static FilterCapabilities findFunction(String name)
name
- String, expression nameFilterCapabilities
constantsCopyright © 1996–2023 Geotools. All rights reserved.