Package org.geotools.api.filter
Interface FilterFactory
- All Known Implementing Classes:
FilterFactoryImpl
,FilterFactoryImplNamespaceAware
,FilterFactoryImplReportInvalidProperty
,ParameterCQLExpressionFilterFactoryImpl
public interface FilterFactory
Interface whose methods allow the caller to create instances of the various
Filter
and Expression
subclasses.
- Since:
- GeoAPI 2.0
- Author:
- Chris Dillard (SYS Technologies)
-
Method Summary
Modifier and TypeMethodDescriptionadd
(Expression expr1, Expression expr2) Computes the numeric addition of the first and second operand.after
(Expression expr1, Expression expr2) Checks if one expression is temporally after anotherafter
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression is temporally after anotherAND
filter between a list of filters.AND
filter between two filters.anyInteracts
(Expression expr1, Expression expr2) Checks if one expression temporally interacts in any way with anotheranyInteracts
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression temporally interacts in any way with anotherarithmeticOperators
(boolean simple, Functions functions) arithmetic operatorsChecks if the bounding box of the feature's geometry overlaps the indicated bounds.bbox
(String propertyName, double minx, double miny, double maxx, double maxy, String srs, MultiValuedFilter.MatchAction matchAction) Checks if the bounding box of the feature's geometry overlaps the indicated bounds.bbox
(String propertyName, BoundingBox3D env) bbox
(String propertyName, BoundingBox3D env, MultiValuedFilter.MatchAction matchAction) bbox
(Expression geometry, double minx, double miny, double maxx, double maxy, String srs) Checks if the geometry expression overlaps the specified bounding box.bbox
(Expression geometry, double minx, double miny, double maxx, double maxy, String srs, MultiValuedFilter.MatchAction matchAction) Checks if the geometry expression overlaps the specified bounding box.bbox
(Expression propertyName, Expression bounds) bbox
(Expression propertyName, Expression bounds, MultiValuedFilter.MatchAction matchAction) bbox
(Expression geometry, BoundingBox bounds) Checks if the bounding box of the feature's geometry overlaps the indicated bounds.bbox
(Expression geometry, BoundingBox3D env) Checks if the geometry expression overlaps the specified bounding box.bbox
(Expression geometry, BoundingBox3D env, MultiValuedFilter.MatchAction matchAction) Checks if the geometry expression overlaps the specified bounding box.bbox
(Expression geometry, BoundingBox bounds, MultiValuedFilter.MatchAction matchAction) Checks if the bounding box of the feature's geometry overlaps the indicated bounds.before
(Expression expr1, Expression expr2) Checks if one expression is temporally before anotherbefore
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression is temporally before anotherbegins
(Expression expr1, Expression expr2) Checks if one expression temporally begins anotherbegins
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression temporally begins anotherbegunBy
(Expression expr1, Expression expr2) Checks if one expression is temporally begun by anotherbegunBy
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression is temporally begun by anotherbetween
(Expression expr, Expression lower, Expression upper) A compact way of encoding a range check.between
(Expression expr, Expression lower, Expression upper, MultiValuedFilter.MatchAction matchAction) A compact way of encoding a range check.Check if all of a feature's geometry is more distant than the given distance from this object's geometry.beyond
(String propertyName, Geometry geometry, double distance, String units, MultiValuedFilter.MatchAction matchAction) Check if all of a feature's geometry is more distant than the given distance from this object's geometry.beyond
(Expression geometry1, Expression geometry2, double distance, String units) Check if all of a geometry is more distant than the given distance from this object's geometry.beyond
(Expression geometry1, Expression geometry2, double distance, String units, MultiValuedFilter.MatchAction matchAction) Check if all of a geometry is more distant than the given distance from this object's geometry.capabilities
(String version, ScalarCapabilities scalar, SpatialCapabilities spatial, IdCapabilities id) filter capabilitiescapabilities
(String version, ScalarCapabilities scalar, SpatialCapabilities spatial, IdCapabilities id, TemporalCapabilities temporal) filter capabilitiescomparisonOperators
(Operator... comparisonOperators) comparison operatorsChecks if the the first geometric operand contains the second.contains
(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction) Checks if the the first geometric operand contains the second.contains
(Expression geometry1, Expression geometry2) Checks if the the first geometric operand contains the second.contains
(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the the first geometric operand contains the second.Checks if the first geometric operand crosses the second.crosses
(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction) Checks if the first geometric operand crosses the second.crosses
(Expression geometry1, Expression geometry2) Checks if the first geometric operand crosses the second.crosses
(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the first geometric operand crosses the second.Checks if the first operand is disjoint from the second.disjoint
(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction) Checks if the first operand is disjoint from the second.disjoint
(Expression geometry1, Expression geometry2) Checks if the first operand is disjoint from the second.disjoint
(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the first operand is disjoint from the second.divide
(Expression expr1, Expression expr2) Computes the numeric quotient resulting from dividing the first operand by the second.during
(Expression expr1, Expression expr2) Checks if one expression is temporally during anotherduring
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression is temporally during anotherChecks if any part of the first geometry lies within the given distance of the second geometry.dwithin
(String propertyName, Geometry geometry, double distance, String units, MultiValuedFilter.MatchAction matchAction) Checks if any part of the first geometry lies within the given distance of the second geometry.dwithin
(Expression geometry1, Expression geometry2, double distance, String units) Checks if any part of the first geometry lies within the given distance of the second geometry.dwithin
(Expression geometry1, Expression geometry2, double distance, String units, MultiValuedFilter.MatchAction matchAction) Checks if any part of the first geometry lies within the given distance of the second geometry.endedBy
(Expression expr1, Expression expr2) Checks if one expression is temporally ended by anotherendedBy
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression is temporally ended by anotherends
(Expression expr1, Expression expr2) Checks if one expression temporally ends by anotherends
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression temporally ends by anotherequal
(Expression geometry1, Expression geometry2) Checks if the geometry of the two operands are equal.equal
(Expression expr1, Expression expr2, boolean matchCase) Compares that two sub-expressions are equal to eacher otherequal
(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction) Compares that two sub-expressions are equal to eacher otherequal
(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the geometry of the two operands are equal.Checks if the geometry of the two operands are equal.equals
(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction) Checks if the geometry of the two operands are equal.equals
(Expression expr1, Expression expr2) Compares that two sub-expressions are equal to each other.Creates a new feautre id from a stringCreates a new feature id with version informationfunction
(String name, Expression... args) Call into some implementation-specific function.function
(Name name, Expression... args) Call into some implementation-specific function.functionName
(String name, int nargs) function namefunctionName
(String name, int nargs, List<String> argNames) FunctionName used to describe an available function.functionName
(String name, List<Parameter<?>> args, Parameter<?> ret) FunctionName used to describe an available function.functionName
(Name name, int nargs) function namefunctionName
(Name name, int nargs, List<String> argNames) FunctionName used to describe an available function.functionName
(Name name, List<Parameter<?>> args, Parameter<?> ret) FunctionName used to describe an available function.functions
(FunctionName... functionNames) functionsgmlObjectId
(String id) Creates a new gml object id from a stringgreater
(Expression expr1, Expression expr2) Checks that the first sub-expression is greater than the second subexpression.greater
(Expression expr1, Expression expr2, boolean matchCase) Checks that the first sub-expression is greater than the second subexpression.greater
(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction) Checks that the first sub-expression is greater than the second subexpression.greaterOrEqual
(Expression expr1, Expression expr2) Checks that the first sub-expression is greater or equal to the second subexpression.greaterOrEqual
(Expression expr1, Expression expr2, boolean matchCase) Checks that the first sub-expression is greater or equal to the second subexpression.greaterOrEqual
(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction) Checks that the first sub-expression is greater or equal to the second subexpression.id
(Set<? extends Identifier> ids) Passes only for objects that have one of the IDs given to this object.idCapabilities
(boolean eid, boolean fid) id capabilitiesintersects
(String propertyName, Geometry geometry) Checks if the two geometric operands intersect.intersects
(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction) Checks if the two geometric operands intersect.intersects
(Expression geometry1, Expression geometry2) Checks if the two geometric operands intersect.intersects
(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the two geometric operands intersect.isNil
(Expression expr, Object nilReason) Checks if an expression's value is nil.isNull
(Expression expr) Checks if an expression's value isnull
.less
(Expression expr1, Expression expr2) Checks that its first sub-expression is less than its second subexpression.less
(Expression expr1, Expression expr2, boolean matchCase) less
(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction) lessOrEqual
(Expression expr1, Expression expr2) Checks that its first sub-expression is less than or equal to its second subexpression.lessOrEqual
(Expression expr1, Expression expr2, boolean matchCase) lessOrEqual
(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction) like
(Expression expr, String pattern) Character string comparison operator with pattern matching and default wildcards.Character string comparison operator with pattern matching and specified wildcards.like
(Expression expr, String pattern, String wildcard, String singleChar, String escape, boolean matchCase) Character string comparison operator with pattern matching and specified wildcards.like
(Expression expr, String pattern, String wildcard, String singleChar, String escape, boolean matchCase, MultiValuedFilter.MatchAction matchAction) Character string comparison operator with pattern matching and specified wildcards.literal
(boolean b) A constant, literalBoolean
value that can be used in expressions.literal
(byte b) A constant, literalByte
value that can be used in expressions.literal
(char c) A constant, literalCharacter
value that can be used in expressions.literal
(double d) A constant, literalDouble
value that can be used in expressions.literal
(float f) A constant, literalFloat
value that can be used in expressions.literal
(int i) A constant, literalInteger
value that can be used in expressions.literal
(long l) A constant, literalLong
value that can be used in expressions.literal
(short s) A constant, literalShort
value that can be used in expressions.A constant, literal value that can be used in expressions.meets
(Expression expr1, Expression expr2) Checks if one expression temporally meets anothermeets
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression temporally meets anothermetBy
(Expression expr1, Expression expr2) Checks if one expression is temporally met by anothermetBy
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression is temporally met by anothermultiply
(Expression expr1, Expression expr2) Computes the numeric product of their first and second operand.default NativeFilter
nativeFilter
(String nativeFilter) Builds a new native filter, which will should be delegated to the data store.Reverses the logical value of a filter.notEqual
(Expression expr1, Expression expr2) Checks that the first sub-expression is not equal to the second subexpression.notEqual
(Expression expr1, Expression expr2, boolean matchCase) Checks that the first sub-expression is not equal to the second subexpression.notEqual
(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction) Checks that the first sub-expression is not equal to the second subexpression.operatorsOR
filter between a list of filters.OR
filter between two filters.overlappedBy
(Expression expr1, Expression expr2) Checks if one expression is temporally overlapped by anotheroverlappedBy
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression is temporally overlapped by anotherChecks if the interior of the first geometry somewhere overlaps the interior of the second geometry.overlaps
(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction) Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.overlaps
(Expression geometry1, Expression geometry2) Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.overlaps
(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.<T> Parameter<T>
parameter
(String name, Class<T> type, InternationalString title, InternationalString description, boolean required, int minOccurs, int maxOccurs, T defaultValue) Creates a parameter of a function.Retrieves the value of a feature's property.property
(String xpath, NamespaceSupport namespaceContext) Retrieves the value of a feature's property.Retrieves the value of a feature's property.resourceId
(String fid, String featureVersion, Version version) ResouceId for identifier based queryresourceId
(String fid, Date startTime, Date endTime) ResourceId for time based query.scalarCapabilities
(ComparisonOperators comparison, ArithmeticOperators arithmetic, boolean logical) scalar capabilitiesIndicates an property by which contents should be sorted, along with intended order.spatialCapabilities
(GeometryOperand[] geometryOperands, SpatialOperators spatial) spatial capabilitiesspatialOperator
(String name, GeometryOperand... geometryOperands) spatial operatorspatialOperators
(SpatialOperator... spatialOperators) spatial operatorssubtract
(Expression expr1, Expression expr2) Computes the numeric difference between the first and second operand.tcontains
(Expression expr1, Expression expr2) Checks if one expression temporally contains anothertcontains
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression temporally contains anothertemporalCapabilities
(TemporalOperator... temporalOperators) temporal capabilitiestemporalOperator
(String name) temporal operatortequals
(Expression expr1, Expression expr2) Checks if one expression temporally equals anothertequals
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression temporally equals anotherChecks if the feature's geometry touches, but does not overlap with the geometry held by this object.touches
(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction) Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.touches
(Expression propertyName1, Expression geometry2) Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.touches
(Expression propertyName1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.toverlaps
(Expression expr1, Expression expr2) Checks if one expression temporally overlaps anothertoverlaps
(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression temporally overlaps anotherChecks if the feature's geometry is completely contained by the specified constant geometry.within
(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction) Checks if the feature's geometry is completely contained by the specified constant geometry.within
(Expression geometry1, Expression geometry2) Checks if the feature's geometry is completely contained by the specified constant geometry.within
(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the feature's geometry is completely contained by the specified constant geometry.
-
Method Details
-
featureId
Creates a new feautre id from a string -
featureId
Creates a new feature id with version information -
gmlObjectId
Creates a new gml object id from a string -
resourceId
ResouceId for identifier based query -
resourceId
ResourceId for time based query.Date range constructor for a feature id; none or one of
start
andend
can benull
, making for an unconstrained date range at either of the ends.- Parameters:
fid
- feature id, non null;startTime
- lower end timestamp of the time range, inclusive, ornull
only ifend != null
endTime
- upper end timestamp of the time range, inclusive, ornull
only ifstart != null
-
and
AND
filter between two filters. -
and
AND
filter between a list of filters. -
or
OR
filter between two filters. -
or
OR
filter between a list of filters. -
not
Reverses the logical value of a filter. -
id
Passes only for objects that have one of the IDs given to this object. -
property
Retrieves the value of a feature's property. -
between
A compact way of encoding a range check. -
between
PropertyIsBetween between(Expression expr, Expression lower, Expression upper, MultiValuedFilter.MatchAction matchAction) A compact way of encoding a range check. -
equals
Compares that two sub-expressions are equal to each other. -
equal
Compares that two sub-expressions are equal to eacher other -
equal
PropertyIsEqualTo equal(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction) Compares that two sub-expressions are equal to eacher other -
notEqual
Checks that the first sub-expression is not equal to the second subexpression. -
notEqual
Checks that the first sub-expression is not equal to the second subexpression.- Parameters:
expr1
- first expressionexpr2
- second expressionmatchCase
- true if the comparison should be case insensitive- Returns:
- evaluates to true of expr1 not equal to expr2
-
notEqual
PropertyIsNotEqualTo notEqual(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction) Checks that the first sub-expression is not equal to the second subexpression.- Parameters:
expr1
- first expressionexpr2
- second expressionmatchCase
- true if the comparison should be case insensitivematchAction
- action for multi-valued properties- Returns:
- evaluates to true of expr1 not equal to expr2
-
greater
Checks that the first sub-expression is greater than the second subexpression. -
greater
Checks that the first sub-expression is greater than the second subexpression.- Parameters:
expr1
- first expressionexpr2
- second expressionmatchCase
- true if the comparison should be case insensitive- Returns:
- evaluates to true of expr1 is greater than expr2
-
greater
PropertyIsGreaterThan greater(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction) Checks that the first sub-expression is greater than the second subexpression.- Parameters:
expr1
- first expressionexpr2
- second expressionmatchCase
- true if the comparison should be case insensitive- Returns:
- evaluates to true of expr1 is greater than expr2
-
greaterOrEqual
Checks that the first sub-expression is greater or equal to the second subexpression. -
greaterOrEqual
PropertyIsGreaterThanOrEqualTo greaterOrEqual(Expression expr1, Expression expr2, boolean matchCase) Checks that the first sub-expression is greater or equal to the second subexpression. -
greaterOrEqual
PropertyIsGreaterThanOrEqualTo greaterOrEqual(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction) Checks that the first sub-expression is greater or equal to the second subexpression. -
less
Checks that its first sub-expression is less than its second subexpression. -
less
-
less
PropertyIsLessThan less(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction) -
lessOrEqual
Checks that its first sub-expression is less than or equal to its second subexpression. -
lessOrEqual
-
lessOrEqual
PropertyIsLessThanOrEqualTo lessOrEqual(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction) -
like
Character string comparison operator with pattern matching and default wildcards. -
like
PropertyIsLike like(Expression expr, String pattern, String wildcard, String singleChar, String escape) Character string comparison operator with pattern matching and specified wildcards. -
like
PropertyIsLike like(Expression expr, String pattern, String wildcard, String singleChar, String escape, boolean matchCase) Character string comparison operator with pattern matching and specified wildcards. -
like
PropertyIsLike like(Expression expr, String pattern, String wildcard, String singleChar, String escape, boolean matchCase, MultiValuedFilter.MatchAction matchAction) Character string comparison operator with pattern matching and specified wildcards. -
isNull
Checks if an expression's value isnull
. -
isNil
Checks if an expression's value is nil. -
bbox
Checks if the bounding box of the feature's geometry overlaps the indicated bounds.This method is defined in strict accordance with the Filter 1.0 specification, you may find the FilterFactory.bbox(Expression, BoundingBox) to be easier to use.
- Parameters:
propertyName
- Name of geometry property (for a PropertyName to access a Feature's Geometry)minx
- Minimum "x" value (for a literal BoundingBox)miny
- Minimum "y" value (for a literal BoundingBox)maxx
- Maximum "x" value (for a literal BoundingBox)maxy
- Maximum "y" value (for a literal BoundingBox)srs
- Indicating the CoordinateReferenceSystem to use for a literal BoundingBox
-
bbox
-
bbox
-
bbox
-
bbox
-
bbox
BBOX bbox(String propertyName, double minx, double miny, double maxx, double maxy, String srs, MultiValuedFilter.MatchAction matchAction) Checks if the bounding box of the feature's geometry overlaps the indicated bounds.This method is defined in strict accordance with the Filter 1.0 specification, you may find the FilterFactory.bbox(Expression, BoundingBox) to be easier to use.
- Parameters:
propertyName
- Name of geometry property (for a PropertyName to access a Feature's Geometry)minx
- Minimum "x" value (for a literal BoundingBox)miny
- Minimum "y" value (for a literal BoundingBox)maxx
- Maximum "x" value (for a literal BoundingBox)maxy
- Maximum "y" value (for a literal BoundingBox)srs
- Indicating the CoordinateReferenceSystem to use for a literal BoundingBox
-
beyond
Check if all of a feature's geometry is more distant than the given distance from this object's geometry. -
beyond
Beyond beyond(String propertyName, Geometry geometry, double distance, String units, MultiValuedFilter.MatchAction matchAction) Check if all of a feature's geometry is more distant than the given distance from this object's geometry. -
contains
Checks if the the first geometric operand contains the second. -
contains
Contains contains(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction) Checks if the the first geometric operand contains the second. -
crosses
Checks if the first geometric operand crosses the second. -
crosses
Checks if the first geometric operand crosses the second. -
disjoint
Checks if the first operand is disjoint from the second. -
disjoint
Disjoint disjoint(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction) Checks if the first operand is disjoint from the second. -
dwithin
Checks if any part of the first geometry lies within the given distance of the second geometry. -
dwithin
DWithin dwithin(String propertyName, Geometry geometry, double distance, String units, MultiValuedFilter.MatchAction matchAction) Checks if any part of the first geometry lies within the given distance of the second geometry. -
equals
Checks if the geometry of the two operands are equal. -
equals
Checks if the geometry of the two operands are equal. -
intersects
Checks if the two geometric operands intersect. -
intersects
Intersects intersects(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction) Checks if the two geometric operands intersect. -
overlaps
Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry. -
overlaps
Overlaps overlaps(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction) Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry. -
touches
Checks if the feature's geometry touches, but does not overlap with the geometry held by this object. -
touches
Checks if the feature's geometry touches, but does not overlap with the geometry held by this object. -
within
Checks if the feature's geometry is completely contained by the specified constant geometry. -
within
Checks if the feature's geometry is completely contained by the specified constant geometry. -
after
Checks if one expression is temporally after another -
after
Checks if one expression is temporally after another -
anyInteracts
Checks if one expression temporally interacts in any way with another -
anyInteracts
AnyInteracts anyInteracts(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression temporally interacts in any way with another -
before
Checks if one expression is temporally before another -
before
Checks if one expression is temporally before another -
begins
Checks if one expression temporally begins another -
begins
Checks if one expression temporally begins another -
begunBy
Checks if one expression is temporally begun by another -
begunBy
Checks if one expression is temporally begun by another -
during
Checks if one expression is temporally during another -
during
Checks if one expression is temporally during another -
endedBy
Checks if one expression is temporally ended by another -
endedBy
Checks if one expression is temporally ended by another -
ends
Checks if one expression temporally ends by another -
ends
Checks if one expression temporally ends by another -
meets
Checks if one expression temporally meets another -
meets
Checks if one expression temporally meets another -
metBy
Checks if one expression is temporally met by another -
metBy
Checks if one expression is temporally met by another -
overlappedBy
Checks if one expression is temporally overlapped by another -
overlappedBy
OverlappedBy overlappedBy(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction) Checks if one expression is temporally overlapped by another -
toverlaps
Checks if one expression temporally overlaps another -
toverlaps
Checks if one expression temporally overlaps another -
tcontains
Checks if one expression temporally contains another -
tcontains
Checks if one expression temporally contains another -
tequals
Checks if one expression temporally equals another -
tequals
Checks if one expression temporally equals another -
add
Computes the numeric addition of the first and second operand. -
divide
Computes the numeric quotient resulting from dividing the first operand by the second. -
multiply
Computes the numeric product of their first and second operand. -
subtract
Computes the numeric difference between the first and second operand. -
function
Call into some implementation-specific function. -
function
Call into some implementation-specific function. -
literal
A constant, literal value that can be used in expressions. -
literal
A constant, literalByte
value that can be used in expressions. -
literal
A constant, literalShort
value that can be used in expressions. -
literal
A constant, literalInteger
value that can be used in expressions. -
literal
A constant, literalLong
value that can be used in expressions. -
literal
A constant, literalFloat
value that can be used in expressions. -
literal
A constant, literalDouble
value that can be used in expressions. -
literal
A constant, literalCharacter
value that can be used in expressions. -
literal
A constant, literalBoolean
value that can be used in expressions. -
sort
Indicates an property by which contents should be sorted, along with intended order. -
operator
operators -
spatialOperator
spatial operator -
temporalOperator
temporal operator -
functionName
function name -
functionName
function name -
functions
functions -
spatialOperators
spatial operators -
comparisonOperators
comparison operators -
arithmeticOperators
arithmetic operators -
scalarCapabilities
ScalarCapabilities scalarCapabilities(ComparisonOperators comparison, ArithmeticOperators arithmetic, boolean logical) scalar capabilities -
spatialCapabilities
SpatialCapabilities spatialCapabilities(GeometryOperand[] geometryOperands, SpatialOperators spatial) spatial capabilities -
idCapabilities
id capabilities -
temporalCapabilities
temporal capabilities -
capabilities
FilterCapabilities capabilities(String version, ScalarCapabilities scalar, SpatialCapabilities spatial, IdCapabilities id) filter capabilities -
capabilities
FilterCapabilities capabilities(String version, ScalarCapabilities scalar, SpatialCapabilities spatial, IdCapabilities id, TemporalCapabilities temporal) filter capabilities -
parameter
<T> Parameter<T> parameter(String name, Class<T> type, InternationalString title, InternationalString description, boolean required, int minOccurs, int maxOccurs, T defaultValue) Creates a parameter of a function.- Parameters:
name
- Parameter nametype
- Parameter type/classtitle
- Human readable title of the parameterdescription
- Extended description of the parameterrequired
- Flag indicating if the parameter is required or notminOccurs
- The minimum number of occurrences of the parametermaxOccurs
- The maximum number of occurrences of the parameterdefaultValue
- Default value for the parameter
-
functionName
FunctionName used to describe an available function.- Parameters:
name
- name of functionnargs
- number of arguments, use a negative number to indicate a minimum if the function supports an open ended number of argumentsargNames
- Optional list of argument names
-
functionName
FunctionName used to describe an available function.- Parameters:
name
- qualified name of functionnargs
- number of arguments, use a negative number to indicate a minimum if the function supports an open ended number of argumentsargNames
- Optional list of argument names
-
functionName
FunctionName used to describe an available function.- Parameters:
name
- name of functionargs
- Parameters describing function arguments.ret
- Parameter describing function return.
-
functionName
FunctionName used to describe an available function.- Parameters:
name
- qualified name of functionargs
- Parameters describing function arguments.ret
- Parameter describing function return.
-
id
-
property
Retrieves the value of a feature's property.- Parameters:
name
- Name of attribute referenced- Returns:
- PropertyName
-
property
Retrieves the value of a feature's property.- Parameters:
xpath
- XPath expression (subject to the restrictions of filter specificaiton)namespaceContext
- Used to interpret any namespace prefixs in above xpath expression- Returns:
- PropertyName
-
bbox
Checks if the geometry expression overlaps the specified bounding box. -
bbox
BBOX bbox(Expression geometry, double minx, double miny, double maxx, double maxy, String srs, MultiValuedFilter.MatchAction matchAction) Checks if the geometry expression overlaps the specified bounding box. -
bbox
Checks if the geometry expression overlaps the specified bounding box. -
bbox
Checks if the geometry expression overlaps the specified bounding box. -
bbox
Checks if the bounding box of the feature's geometry overlaps the indicated bounds.This method does not strictly confirm to the the Filter 1.0 specification, you may use it to check expressions other than PropertyName.
- Parameters:
geometry
- Expression used to access a Geometry, in order to check for interaction with boundsbounds
- Indicates the bounds to check geometry against
-
bbox
Checks if the bounding box of the feature's geometry overlaps the indicated bounds.This method does not strictly confirm to the the Filter 1.0 specification, you may use it to check expressions other than PropertyName.
- Parameters:
geometry
- Expression used to access a Geometry, in order to check for interaction with boundsbounds
- Indicates the bounds to check geometry againstmatchAction
- Match Action
-
beyond
Check if all of a geometry is more distant than the given distance from this object's geometry. -
beyond
Beyond beyond(Expression geometry1, Expression geometry2, double distance, String units, MultiValuedFilter.MatchAction matchAction) Check if all of a geometry is more distant than the given distance from this object's geometry. -
contains
Checks if the the first geometric operand contains the second. -
contains
Contains contains(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the the first geometric operand contains the second. -
crosses
Checks if the first geometric operand crosses the second. -
crosses
Crosses crosses(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the first geometric operand crosses the second. -
disjoint
Checks if the first operand is disjoint from the second. -
disjoint
Disjoint disjoint(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the first operand is disjoint from the second. -
dwithin
Checks if any part of the first geometry lies within the given distance of the second geometry. -
dwithin
DWithin dwithin(Expression geometry1, Expression geometry2, double distance, String units, MultiValuedFilter.MatchAction matchAction) Checks if any part of the first geometry lies within the given distance of the second geometry. -
equal
Checks if the geometry of the two operands are equal. -
equal
Checks if the geometry of the two operands are equal. -
intersects
Checks if the two geometric operands intersect. -
intersects
Intersects intersects(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the two geometric operands intersect. -
overlaps
Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry. -
overlaps
Overlaps overlaps(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry. -
touches
Checks if the feature's geometry touches, but does not overlap with the geometry held by this object. -
touches
Touches touches(Expression propertyName1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the feature's geometry touches, but does not overlap with the geometry held by this object. -
within
Checks if the feature's geometry is completely contained by the specified constant geometry. -
within
Within within(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction) Checks if the feature's geometry is completely contained by the specified constant geometry. -
nativeFilter
Builds a new native filter, which will should be delegated to the data store.- Parameters:
nativeFilter
- the native filter- Returns:
- the build native filter
-