org.geotools.filter
Interface FilterFactory
- All Superinterfaces:
- Factory, FilterFactory, FilterFactory2
Deprecated. use FilterFactory
public interface FilterFactory
- extends Factory, FilterFactory2
This specifies the interface to create filters.
- TODO:
- TODO: This needs to be massively overhauled. This should be the
source of immutability of filters. See
FeatureTypeFactory
,
as that provides a good example of what this should look like. The
mutable factory to create immutable objects is a good model for this.
The creation methods should only create fully formed filters. This
in turn means that all the set functions in the filters should be
eliminated. When rewriting this class/package, keep in mind
FilterSAXParser in the filter module, as the factory should fit
cleanly with that, and should handle sax parsing without too much
memory overhead., REVISIT: resolve errors, should all throw errors?
Method Summary |
Filter |
and(Filter f1,
Filter f2)
Deprecated. use FilterFactory.and(org.opengis.filter.Filter, org.opengis.filter.Filter) |
BBOX |
bbox(Expression geometry,
double minx,
double miny,
double maxx,
double maxy,
String srs)
Deprecated. Checks if the geometry expression overlaps the specified bounding box. |
Beyond |
beyond(Expression geometry1,
Expression geometry2,
double distance,
String units)
Deprecated. Check if all of a geometry is more distant than the given distance from this object's geometry. |
Contains |
contains(Expression geometry1,
Expression geometry2)
Deprecated. Checks if the the first geometric operand contains the second. |
AttributeExpression |
createAttributeExpression(AttributeDescriptor at)
Deprecated. use createAttributeExpression( at ), will be removed for
GeoTools 2.3 |
AttributeExpression |
createAttributeExpression(SimpleFeatureType schema)
Deprecated. use createAttributeExpression(String) instead. |
AttributeExpression |
createAttributeExpression(SimpleFeatureType schema,
String xpath)
Deprecated. use createAttributeExpression( xpath ), will be removed for
GeoTools 2.3 |
AttributeExpression |
createAttributeExpression(String xpath)
Deprecated. Creates an AttributeExpression using the supplied xpath. |
BBoxExpression |
createBBoxExpression(Envelope env)
Deprecated. Please use filterFactory.literal( JTS.toGeometry( bounds ) ) |
BetweenFilter |
createBetweenFilter()
Deprecated. Creates an empty Between Filter. |
CompareFilter |
createCompareFilter(short type)
Deprecated. use one of FilterFactory.less(Expression, Expression)
FilterFactory.lessOrEqual(Expression, Expression)
FilterFactory.equals(Expression, Expression)
FilterFactory.greater(Expression, Expression)
FilterFactory.greaterOrEqual(Expression, Expression)
FilterFactory.between(Expression, Expression, Expression) |
EnvironmentVariable |
createEnvironmentVariable(String name)
Deprecated. Creates an Environment Variable |
FidFilter |
createFidFilter()
Deprecated. Creates a new Fid Filter with no initial fids. |
FidFilter |
createFidFilter(String fid)
Deprecated. Creates a Fid Filter with an initial fid. |
FunctionExpression |
createFunctionExpression(String name)
Deprecated. Creates a Function Expression. |
GeometryDistanceFilter |
createGeometryDistanceFilter(short filterType)
Deprecated. use one of
FilterFactory.beyond(String, Geometry, double, String)
FilterFactory.dwithin(String, Geometry, double, String) |
GeometryFilter |
createGeometryFilter(short filterType)
Deprecated. use one of
FilterFactory.bbox(String, double, double, double, double, String)
FilterFactory.beyond(String, Geometry, double, String)
FilterFactory.contains(String, Geometry)
FilterFactory.crosses(String, Geometry)
FilterFactory.disjoint(String, Geometry)
FilterFactory.dwithin(String, Geometry, double, String)
FilterFactory.equals(String, Geometry)
FilterFactory.intersects(String, Geometry)
FilterFactory.overlaps(String, Geometry)
FilterFactory.touches(String, Geometry)
FilterFactory.within(String, Geometry) |
LikeFilter |
createLikeFilter()
Deprecated. Creates a Like Filter. |
LiteralExpression |
createLiteralExpression()
Deprecated. Creates an empty Literal Expression |
LiteralExpression |
createLiteralExpression(double d)
Deprecated. Creates a Double Literal Expression |
LiteralExpression |
createLiteralExpression(int i)
Deprecated. Creates an Integer Literal Expression. |
LiteralExpression |
createLiteralExpression(Object o)
Deprecated. Creates a Literal Expression from an Object. |
LiteralExpression |
createLiteralExpression(String s)
Deprecated. Creates a String Literal Expression |
LogicFilter |
createLogicFilter(Filter filter1,
Filter filter2,
short filterType)
Deprecated. use one of FilterFactory.and(Filter, Filter)
FilterFactory.or(Filter, Filter)
FilterFactory.not(Filter) |
LogicFilter |
createLogicFilter(Filter filter,
short filterType)
Deprecated. use one of FilterFactory.and(Filter, Filter)
FilterFactory.or(Filter, Filter)
FilterFactory.not(Filter) |
LogicFilter |
createLogicFilter(short filterType)
Deprecated. use one of FilterFactory.and(Filter, Filter)
FilterFactory.or(Filter, Filter)
FilterFactory.not(Filter) |
MathExpression |
createMathExpression()
Deprecated. use one of
FilterFactory.add(Expression, Expression)
FilterFactory.subtract(Expression, Expression)
FilterFactory.multiply(Expression, Expression)
FilterFactory.divide(Expression, Expression) |
MathExpression |
createMathExpression(short expressionType)
Deprecated. use one of
FilterFactory.add(Expression, Expression)
FilterFactory.subtract(Expression, Expression)
FilterFactory.multiply(Expression, Expression)
FilterFactory.divide(Expression, Expression) |
NullFilter |
createNullFilter()
Deprecated. Creates an empty Null Filter. |
Crosses |
crosses(Expression geometry1,
Expression geometry2)
Deprecated. Checks if the first geometric operand crosses the second. |
Disjoint |
disjoint(Expression geometry1,
Expression geometry2)
Deprecated. Checks if the first operand is disjoint from the second. |
DWithin |
dwithin(Expression geometry1,
Expression geometry2,
double distance,
String units)
Deprecated. Checks if any part of the first geometry lies within the given distance of the second geometry. |
Equals |
equal(Expression geometry1,
Expression geometry2)
Deprecated. Checks if the geometry of the two operands are equal. |
Intersects |
intersects(Expression geometry1,
Expression geometry2)
Deprecated. Checks if the two geometric operands intersect. |
Filter |
not(Filter f)
Deprecated. use FilterFactory.not(org.opengis.filter.Filter) |
Filter |
or(Filter f1,
Filter f2)
Deprecated. use FilterFactory.or(org.opengis.filter.Filter, org.opengis.filter.Filter) |
Overlaps |
overlaps(Expression geometry1,
Expression geometry2)
Deprecated. Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry. |
Touches |
touches(Expression propertyName1,
Expression geometry2)
Deprecated. Checks if the feature's geometry touches, but does not overlap with the geometry held by this object. |
Within |
within(Expression geometry1,
Expression geometry2)
Deprecated. Checks if the feature's geometry is completely contained by the specified constant geometry. |
Methods inherited from interface FilterFactory2 |
bbox, bbox, bbox, bbox, bbox, beyond, contains, crosses, disjoint, dwithin, equal, functionName, functionName, functionName, functionName, id, intersects, like, like, overlaps, parameter, property, property, touches, within |
Methods inherited from interface FilterFactory |
add, after, after, and, and, anyInteracts, anyInteracts, arithmeticOperators, bbox, bbox, bbox, bbox, before, before, begins, begins, begunBy, begunBy, between, between, beyond, beyond, capabilities, capabilities, comparisonOperators, contains, contains, crosses, crosses, disjoint, disjoint, divide, during, during, dwithin, dwithin, endedBy, endedBy, ends, ends, equal, equal, equals, equals, equals, featureId, featureId, function, function, functionName, functionName, functions, gmlObjectId, greater, greater, greater, greaterOrEqual, greaterOrEqual, greaterOrEqual, id, idCapabilities, intersects, intersects, isNil, isNull, less, less, less, lessOrEqual, lessOrEqual, lessOrEqual, like, like, literal, literal, literal, literal, literal, literal, literal, literal, literal, meets, meets, metBy, metBy, multiply, not, notEqual, notEqual, notEqual, operator, or, or, overlappedBy, overlappedBy, overlaps, overlaps, property, resourceId, resourceId, scalarCapabilities, sort, spatialCapabilities, spatialOperator, spatialOperators, subtract, tcontains, tcontains, temporalCapabilities, temporalOperator, tequals, tequals, touches, touches, toverlaps, toverlaps, within, within |
createLogicFilter
LogicFilter createLogicFilter(Filter filter1,
Filter filter2,
short filterType)
throws IllegalFilterException
- Deprecated. use one of
FilterFactory.and(Filter, Filter)
FilterFactory.or(Filter, Filter)
FilterFactory.not(Filter)
- Creates a logic filter from two filters and a type.
- Parameters:
filter1
- the first filter to join.filter2
- the second filter to join.filterType
- must be a logic type.
- Returns:
- the newly constructed logic filter.
- Throws:
IllegalFilterException
- If there were any problems creating the
filter, including wrong type.
createLogicFilter
LogicFilter createLogicFilter(short filterType)
throws IllegalFilterException
- Deprecated. use one of
FilterFactory.and(Filter, Filter)
FilterFactory.or(Filter, Filter)
FilterFactory.not(Filter)
- Creates an empty logic filter from a type.
- Parameters:
filterType
- must be a logic type.
- Returns:
- the newly constructed logic filter.
- Throws:
IllegalFilterException
- If there were any problems creating the
filter, including wrong type.
createLogicFilter
LogicFilter createLogicFilter(Filter filter,
short filterType)
throws IllegalFilterException
- Deprecated. use one of
FilterFactory.and(Filter, Filter)
FilterFactory.or(Filter, Filter)
FilterFactory.not(Filter)
- Creates a logic filter with an initial filter..
- Parameters:
filter
- the initial filter to set.filterType
- Must be a logic type.
- Returns:
- the newly constructed logic filter.
- Throws:
IllegalFilterException
- If there were any problems creating the
filter, including wrong type.
createBBoxExpression
BBoxExpression createBBoxExpression(Envelope env)
throws IllegalFilterException
- Deprecated. Please use filterFactory.literal( JTS.toGeometry( bounds ) )
- Creates a literal geometry expression from an envelope.
- Parameters:
env
- the envelope to use for this bounding box.
- Returns:
- The newly created BBoxExpression.
- Throws:
IllegalFilterException
- if there were creation problems.
createLiteralExpression
LiteralExpression createLiteralExpression(int i)
- Deprecated.
- Creates an Integer Literal Expression.
- Parameters:
i
- the int to serve as literal.
- Returns:
- The new Literal Expression
createMathExpression
MathExpression createMathExpression()
throws IllegalFilterException
- Deprecated. use one of
FilterFactory.add(Expression, Expression)
FilterFactory.subtract(Expression, Expression)
FilterFactory.multiply(Expression, Expression)
FilterFactory.divide(Expression, Expression)
- Creates a Math Expression
- Returns:
- The new Math Expression
- Throws:
IllegalFilterException
- if there were creation problems.
createFidFilter
FidFilter createFidFilter()
- Deprecated.
- Creates a new Fid Filter with no initial fids.
- Returns:
- The new Fid Filter.
createAttributeExpression
AttributeExpression createAttributeExpression(String xpath)
- Deprecated.
- Creates an AttributeExpression using the supplied xpath.
The supplied xpath can be used to query a varity of content - most
notably Features.
- Parameters:
xpath
- XPath used to retrive value
- Returns:
- The new Attribtue Expression
createAttributeExpression
AttributeExpression createAttributeExpression(SimpleFeatureType schema,
String xpath)
throws IllegalFilterException
- Deprecated. use createAttributeExpression( xpath ), will be removed for
GeoTools 2.3
- Creates a Attribute Expression given a schema and attribute path.
If you supply a schema, it will be used as a sanitch check for the
provided path.
- Parameters:
schema
- the schema to get the attribute from, or nullxpath
- the xPath of the attribute to compare.
- Returns:
- The new Attribute Expression.
- Throws:
IllegalFilterException
- if there were creation problems.
createAttributeExpression
AttributeExpression createAttributeExpression(AttributeDescriptor at)
throws IllegalFilterException
- Deprecated. use createAttributeExpression( at ), will be removed for
GeoTools 2.3
- Shortcut the process - will only grab values matching AttributeType.
- Parameters:
at
-
- Returns:
- The new Attribtue Expression
- Throws:
IllegalFilterException
- if there were creation problems
createLiteralExpression
LiteralExpression createLiteralExpression(Object o)
throws IllegalFilterException
- Deprecated.
- Creates a Literal Expression from an Object.
- Parameters:
o
- the object to serve as the literal.
- Returns:
- The new Literal Expression
- Throws:
IllegalFilterException
- if there were creation problems.
createCompareFilter
CompareFilter createCompareFilter(short type)
throws IllegalFilterException
- Deprecated. use one of
FilterFactory.less(Expression, Expression)
FilterFactory.lessOrEqual(Expression, Expression)
FilterFactory.equals(Expression, Expression)
FilterFactory.greater(Expression, Expression)
FilterFactory.greaterOrEqual(Expression, Expression)
FilterFactory.between(Expression, Expression, Expression)
- Creates a new compare filter of the given type.
- Parameters:
type
- the type of comparison - must be a compare type.
- Returns:
- The new compare filter.
- Throws:
IllegalFilterException
- if there were creation problems.
createLiteralExpression
LiteralExpression createLiteralExpression()
- Deprecated.
- Creates an empty Literal Expression
- Returns:
- The new Literal Expression.
createLiteralExpression
LiteralExpression createLiteralExpression(String s)
- Deprecated.
- Creates a String Literal Expression
- Parameters:
s
- the string to serve as the literal.
- Returns:
- The new Literal Expression
createLiteralExpression
LiteralExpression createLiteralExpression(double d)
- Deprecated.
- Creates a Double Literal Expression
- Parameters:
d
- the double to serve as the literal.
- Returns:
- The new Literal Expression
createAttributeExpression
AttributeExpression createAttributeExpression(SimpleFeatureType schema)
- Deprecated. use
createAttributeExpression(String)
instead.
- Creates a Attribute Expression with an initial schema.
- Parameters:
schema
- the schema to create with.
- Returns:
- The new Attribute Expression.
createMathExpression
MathExpression createMathExpression(short expressionType)
throws IllegalFilterException
- Deprecated. use one of
FilterFactory.add(Expression, Expression)
FilterFactory.subtract(Expression, Expression)
FilterFactory.multiply(Expression, Expression)
FilterFactory.divide(Expression, Expression)
- Creates a Math Expression of the given type.
- Parameters:
expressionType
- must be a math expression type.
- Returns:
- The new Math Expression.
- Throws:
IllegalFilterException
- if there were creation problems.
createNullFilter
NullFilter createNullFilter()
- Deprecated.
- Creates an empty Null Filter.
- Returns:
- The new Null Filter.
createBetweenFilter
BetweenFilter createBetweenFilter()
throws IllegalFilterException
- Deprecated.
- Creates an empty Between Filter.
- Returns:
- The new Between Filter.
- Throws:
IllegalFilterException
- if there were creation problems.
createGeometryFilter
GeometryFilter createGeometryFilter(short filterType)
throws IllegalFilterException
- Deprecated. use one of
FilterFactory.bbox(String, double, double, double, double, String)
FilterFactory.beyond(String, Geometry, double, String)
FilterFactory.contains(String, Geometry)
FilterFactory.crosses(String, Geometry)
FilterFactory.disjoint(String, Geometry)
FilterFactory.dwithin(String, Geometry, double, String)
FilterFactory.equals(String, Geometry)
FilterFactory.intersects(String, Geometry)
FilterFactory.overlaps(String, Geometry)
FilterFactory.touches(String, Geometry)
FilterFactory.within(String, Geometry)
- Creates a Geometry Filter.
- Parameters:
filterType
- the type to create, must be a geometry type.
- Returns:
- The new Geometry Filter.
- Throws:
IllegalFilterException
- if the filterType is not a geometry.
createGeometryDistanceFilter
GeometryDistanceFilter createGeometryDistanceFilter(short filterType)
throws IllegalFilterException
- Deprecated. use one of
FilterFactory.beyond(String, Geometry, double, String)
FilterFactory.dwithin(String, Geometry, double, String)
- Creates a Geometry Distance Filter
- Parameters:
filterType
- the type to create, must be beyond or dwithin.
- Returns:
- The new Expression
- Throws:
IllegalFilterException
- if the filterType is not a geometry
distance type.
createFidFilter
FidFilter createFidFilter(String fid)
- Deprecated.
- Creates a Fid Filter with an initial fid.
- Parameters:
fid
- the feature ID to create with.
- Returns:
- The new FidFilter.
createLikeFilter
LikeFilter createLikeFilter()
- Deprecated.
- Creates a Like Filter.
- Returns:
- The new Like Filter.
createFunctionExpression
FunctionExpression createFunctionExpression(String name)
- Deprecated.
- Creates a Function Expression.
- Parameters:
name
- the function name.
- Returns:
- The new Function Expression.
createEnvironmentVariable
EnvironmentVariable createEnvironmentVariable(String name)
- Deprecated.
- Creates an Environment Variable
- Parameters:
name
- the function name.
- Returns:
- The new Function Expression.
or
Filter or(Filter f1,
Filter f2)
- Deprecated. use
FilterFactory.or(org.opengis.filter.Filter, org.opengis.filter.Filter)
and
Filter and(Filter f1,
Filter f2)
- Deprecated. use
FilterFactory.and(org.opengis.filter.Filter, org.opengis.filter.Filter)
not
Filter not(Filter f)
- Deprecated. use
FilterFactory.not(org.opengis.filter.Filter)
bbox
BBOX bbox(Expression geometry,
double minx,
double miny,
double maxx,
double maxy,
String srs)
- Deprecated.
- Checks if the geometry expression overlaps the specified bounding box.
- Specified by:
bbox
in interface FilterFactory2
beyond
Beyond beyond(Expression geometry1,
Expression geometry2,
double distance,
String units)
- Deprecated.
- Check if all of a geometry is more distant than the given distance from this object's geometry.
- Specified by:
beyond
in interface FilterFactory2
contains
Contains contains(Expression geometry1,
Expression geometry2)
- Deprecated.
- Checks if the the first geometric operand contains the second.
- Specified by:
contains
in interface FilterFactory2
crosses
Crosses crosses(Expression geometry1,
Expression geometry2)
- Deprecated.
- Checks if the first geometric operand crosses the second.
- Specified by:
crosses
in interface FilterFactory2
disjoint
Disjoint disjoint(Expression geometry1,
Expression geometry2)
- Deprecated.
- Checks if the first operand is disjoint from the second.
- Specified by:
disjoint
in interface FilterFactory2
dwithin
DWithin dwithin(Expression geometry1,
Expression geometry2,
double distance,
String units)
- Deprecated.
- Checks if any part of the first geometry lies within the given distance of the second geometry.
- Specified by:
dwithin
in interface FilterFactory2
equal
Equals equal(Expression geometry1,
Expression geometry2)
- Deprecated.
- Checks if the geometry of the two operands are equal.
- Specified by:
equal
in interface FilterFactory2
intersects
Intersects intersects(Expression geometry1,
Expression geometry2)
- Deprecated.
- Checks if the two geometric operands intersect.
- Specified by:
intersects
in interface FilterFactory2
overlaps
Overlaps overlaps(Expression geometry1,
Expression geometry2)
- Deprecated.
- Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.
- Specified by:
overlaps
in interface FilterFactory2
touches
Touches touches(Expression propertyName1,
Expression geometry2)
- Deprecated.
- Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.
- Specified by:
touches
in interface FilterFactory2
within
Within within(Expression geometry1,
Expression geometry2)
- Deprecated.
- Checks if the feature's geometry is completely contained by the specified constant geometry.
- Specified by:
within
in interface FilterFactory2
Copyright © 1996-2014 Geotools. All Rights Reserved.