|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
FilterFactory
public interface FilterFactory
This specifies the interface to create filters.
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 Factory |
---|
getImplementationHints |
Methods inherited from interface FilterFactory2 |
---|
bbox, like, property |
Methods inherited from interface FilterFactory |
---|
add, and, and, arithmeticOperators, bbox, between, beyond, capabilities, comparisonOperators, contains, crosses, disjoint, divide, dwithin, equal, equals, equals, featureId, function, function, function, function, functionName, functions, gmlObjectId, greater, greater, greaterOrEqual, greaterOrEqual, id, idCapabilities, intersects, isNull, less, less, lessOrEqual, lessOrEqual, like, like, literal, literal, literal, literal, literal, literal, literal, literal, literal, multiply, not, notEqual, notEqual, operator, or, or, overlaps, property, scalarCapabilities, sort, spatialCapabilities, spatialOperator, spatialOperators, subtract, touches, within |
Method Detail |
---|
LogicFilter createLogicFilter(Filter filter1, Filter filter2, short filterType) throws IllegalFilterException
FilterFactory.and(Filter, Filter)
FilterFactory.or(Filter, Filter)
FilterFactory.not(Filter)
filter1
- the first filter to join.filter2
- the second filter to join.filterType
- must be a logic type.
IllegalFilterException
- If there were any problems creating the
filter, including wrong type.LogicFilter createLogicFilter(short filterType) throws IllegalFilterException
FilterFactory.and(Filter, Filter)
FilterFactory.or(Filter, Filter)
FilterFactory.not(Filter)
filterType
- must be a logic type.
IllegalFilterException
- If there were any problems creating the
filter, including wrong type.LogicFilter createLogicFilter(Filter filter, short filterType) throws IllegalFilterException
FilterFactory.and(Filter, Filter)
FilterFactory.or(Filter, Filter)
FilterFactory.not(Filter)
filter
- the initial filter to set.filterType
- Must be a logic type.
IllegalFilterException
- If there were any problems creating the
filter, including wrong type.BBoxExpression createBBoxExpression(Envelope env) throws IllegalFilterException
env
- the envelope to use for this bounding box.
IllegalFilterException
- if there were creation problems.LiteralExpression createLiteralExpression(int i)
i
- the int to serve as literal.
MathExpression createMathExpression() throws IllegalFilterException
FilterFactory.add(Expression, Expression)
FilterFactory.subtract(Expression, Expression)
FilterFactory.multiply(Expression, Expression)
FilterFactory.divide(Expression, Expression)
IllegalFilterException
- if there were creation problems.FidFilter createFidFilter()
AttributeExpression createAttributeExpression(String xpath)
The supplied xpath can be used to query a varity of content - most notably Features.
xpath
- XPath used to retrive value
AttributeExpression createAttributeExpression(SimpleFeatureType schema, String xpath) throws IllegalFilterException
If you supply a schema, it will be used as a sanitch check for the provided path.
schema
- the schema to get the attribute from, or nullxpath
- the xPath of the attribute to compare.
IllegalFilterException
- if there were creation problems.AttributeExpression createAttributeExpression(AttributeDescriptor at) throws IllegalFilterException
at
-
IllegalFilterException
- if there were creation problemsLiteralExpression createLiteralExpression(Object o) throws IllegalFilterException
o
- the object to serve as the literal.
IllegalFilterException
- if there were creation problems.CompareFilter createCompareFilter(short type) throws IllegalFilterException
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)
type
- the type of comparison - must be a compare type.
IllegalFilterException
- if there were creation problems.LiteralExpression createLiteralExpression()
LiteralExpression createLiteralExpression(String s)
s
- the string to serve as the literal.
LiteralExpression createLiteralExpression(double d)
d
- the double to serve as the literal.
AttributeExpression createAttributeExpression(SimpleFeatureType schema)
createAttributeExpression(String)
instead.
schema
- the schema to create with.
MathExpression createMathExpression(short expressionType) throws IllegalFilterException
FilterFactory.add(Expression, Expression)
FilterFactory.subtract(Expression, Expression)
FilterFactory.multiply(Expression, Expression)
FilterFactory.divide(Expression, Expression)
expressionType
- must be a math expression type.
IllegalFilterException
- if there were creation problems.NullFilter createNullFilter()
BetweenFilter createBetweenFilter() throws IllegalFilterException
IllegalFilterException
- if there were creation problems.GeometryFilter createGeometryFilter(short filterType) throws IllegalFilterException
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)
filterType
- the type to create, must be a geometry type.
IllegalFilterException
- if the filterType is not a geometry.GeometryDistanceFilter createGeometryDistanceFilter(short filterType) throws IllegalFilterException
FilterFactory.beyond(String, Geometry, double, String)
FilterFactory.dwithin(String, Geometry, double, String)
filterType
- the type to create, must be beyond or dwithin.
IllegalFilterException
- if the filterType is not a geometry
distance type.FidFilter createFidFilter(String fid)
fid
- the feature ID to create with.
LikeFilter createLikeFilter()
FunctionExpression createFunctionExpression(String name)
name
- the function name.
EnvironmentVariable createEnvironmentVariable(String name)
name
- the function name.
Filter or(Filter f1, Filter f2)
FilterFactory.or(org.opengis.filter.Filter, org.opengis.filter.Filter)
Filter and(Filter f1, Filter f2)
FilterFactory.and(org.opengis.filter.Filter, org.opengis.filter.Filter)
Filter not(Filter f)
FilterFactory.not(org.opengis.filter.Filter)
BBOX bbox(Expression geometry, double minx, double miny, double maxx, double maxy, String srs)
bbox
in interface FilterFactory2
Beyond beyond(Expression geometry1, Expression geometry2, double distance, String units)
beyond
in interface FilterFactory2
Contains contains(Expression geometry1, Expression geometry2)
contains
in interface FilterFactory2
Crosses crosses(Expression geometry1, Expression geometry2)
crosses
in interface FilterFactory2
Disjoint disjoint(Expression geometry1, Expression geometry2)
disjoint
in interface FilterFactory2
DWithin dwithin(Expression geometry1, Expression geometry2, double distance, String units)
dwithin
in interface FilterFactory2
Equals equal(Expression geometry1, Expression geometry2)
equal
in interface FilterFactory2
Intersects intersects(Expression geometry1, Expression geometry2)
intersects
in interface FilterFactory2
Overlaps overlaps(Expression geometry1, Expression geometry2)
overlaps
in interface FilterFactory2
Touches touches(Expression propertyName1, Expression geometry2)
touches
in interface FilterFactory2
Within within(Expression geometry1, Expression geometry2)
within
in interface FilterFactory2
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |