org.geotools.filter
Class FilterFactoryImpl

Object
  extended by FilterFactoryImpl
All Implemented Interfaces:
Factory, FilterFactory, FilterFactory2
Direct Known Subclasses:
FilterFactoryImplNamespaceAware, FilterFactoryImplReportInvalidProperty

public class FilterFactoryImpl
extends Object
implements FilterFactory

Implementation of the FilterFactory, generates the filter implementations in defaultcore.

Author:
Ian Turton, CCG

Constructor Summary
FilterFactoryImpl()
          Creates a new instance of FilterFactoryImpl
FilterFactoryImpl(Hints hints)
           
 
Method Summary
 Add add(Expression expr1, Expression expr2)
          Computes the numeric addition of the first and second operand.
 After after(Expression expr1, Expression expr2)
          Checks if one expression is temporally after another
 After after(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression is temporally after another
 And and(Filter f, Filter g)
          AND filter between two filters.
 Filter and(Filter filter1, Filter filter2)
           
 And and(List filters)
          AND filter between a list of filters.
 AnyInteracts anyInteracts(Expression expr1, Expression expr2)
          Checks if one expression temporally interacts in any way with another
 AnyInteracts anyInteracts(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression temporally interacts in any way with another
 ArithmeticOperators arithmeticOperators(boolean simple, Functions functions)
          arithmetic operators
 BBOX bbox(Expression geometry, BoundingBox bounds)
          Checks if the bounding box of the feature's geometry overlaps the indicated bounds.
 BBOX3D bbox(Expression geometry, BoundingBox3D env)
          Checks if the geometry expression overlaps the specified bounding box.
 BBOX3D bbox(Expression e, BoundingBox3D env, MultiValuedFilter.MatchAction matchAction)
          Checks if the geometry expression overlaps the specified bounding box.
 BBOX bbox(Expression geometry, BoundingBox bounds, MultiValuedFilter.MatchAction matchAction)
          Checks if the bounding box of the feature's geometry overlaps the indicated bounds.
 BBOX bbox(Expression geometry, double minx, double miny, double maxx, double maxy, String srs)
          Checks if the geometry expression overlaps the specified bounding box.
 BBOX bbox(Expression e, double minx, double miny, double maxx, double maxy, String srs, MultiValuedFilter.MatchAction matchAction)
          Checks if the geometry expression overlaps the specified bounding box.
 BBOX bbox(Expression geometry, Expression bounds)
           
 BBOX3D bbox(String propertyName, BoundingBox3D env)
           
 BBOX3D bbox(String propertyName, BoundingBox3D env, MultiValuedFilter.MatchAction matchAction)
           
 BBOX bbox(String propertyName, double minx, double miny, double maxx, double maxy, String srs)
          Checks if the bounding box of the feature's geometry overlaps the specified bounding box.
 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.
 Before before(Expression expr1, Expression expr2)
          Checks if one expression is temporally before another
 Before before(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression is temporally before another
 Begins begins(Expression expr1, Expression expr2)
          Checks if one expression temporally begins another
 Begins begins(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression temporally begins another
 BegunBy begunBy(Expression expr1, Expression expr2)
          Checks if one expression is temporally begun by another
 BegunBy begunBy(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression is temporally begun by another
 PropertyIsBetween between(Expression expr, Expression lower, Expression upper)
          A compact way of encoding a range check.
 PropertyIsBetween between(Expression expr, Expression lower, Expression upper, MultiValuedFilter.MatchAction matchAction)
          A compact way of encoding a range check.
 Beyond 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 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.
 Beyond beyond(Expression geometry1, Geometry geometry2, double distance, String units)
           
 Beyond beyond(String propertyName, Geometry geometry, double distance, String units)
          Check if all of a feature's geometry is more distant than the given distance from this object's geometry.
 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.
 FilterCapabilities capabilities(String version, ScalarCapabilities scalar, SpatialCapabilities spatial, IdCapabilities id)
          filter capabilities
 FilterCapabilities capabilities(String version, ScalarCapabilities scalar, SpatialCapabilities spatial, IdCapabilities id, TemporalCapabilities temporal)
          filter capabilities
 ComparisonOperators comparisonOperators(Operator[] comparisonOperators)
          comparison operators
 Contains contains(Expression geometry1, Expression geometry2)
          Checks if the the first geometric operand contains the second.
 Contains contains(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the the first geometric operand contains the second.
 Contains contains(String propertyName, Geometry geometry)
          Checks if the the first geometric operand contains the second.
 Contains contains(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction)
          Checks if the the first geometric operand contains the second.
 AttributeExpression createAttributeExpression(AttributeDescriptor at)
          Shortcut the process - will only grab values matching AttributeType.
 AttributeExpression createAttributeExpression(SimpleFeatureType schema)
          Creates a Attribute Expression with an initial schema.
 AttributeExpression createAttributeExpression(SimpleFeatureType schema, String path)
          Creates a Attribute Expression given a schema and attribute path.
 AttributeExpression createAttributeExpression(String xpath)
          Creates an AttributeExpression using the supplied xpath.
 BBoxExpression createBBoxExpression(Envelope env)
          Creates a BBox Expression from an envelope.
 BetweenFilter createBetweenFilter()
          Creates an empty Between Filter.
 CompareFilter createCompareFilter(short type)
          Deprecated. @see org.geotools.filter.FilterFactory#createCompareFilter(short)
 EnvironmentVariable createEnvironmentVariable(String name)
          Creates an Environment Variable
 FidFilter createFidFilter()
          Creates a new Fid Filter with no initial fids.
 FidFilter createFidFilter(String fid)
          Creates a Fid Filter with an initial fid.
 FunctionExpression createFunctionExpression(String name)
          Creates a Function Expression.
 GeometryDistanceFilter createGeometryDistanceFilter(short filterType)
          Creates a Geometry Distance Filter
 GeometryFilter createGeometryFilter(short filterType)
          Creates a Geometry Filter.
 LikeFilter createLikeFilter()
          Creates a Like Filter.
 LiteralExpression createLiteralExpression()
          Creates an empty Literal Expression
 LiteralExpression createLiteralExpression(double d)
          Creates a Double Literal Expression
 LiteralExpression createLiteralExpression(int i)
          Creates an Integer Literal Expression.
 LiteralExpression createLiteralExpression(Object o)
          Creates a Literal Expression from an Object.
 LiteralExpression createLiteralExpression(String s)
          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)
          Creates a Math Expression of the given type.
 NullFilter createNullFilter()
          Creates an empty Null Filter.
 Crosses crosses(Expression geometry1, Expression geometry2)
          Checks if the first geometric operand crosses the second.
 Crosses crosses(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the first geometric operand crosses the second.
 Crosses crosses(String propertyName, Geometry geometry)
          Checks if the first geometric operand crosses the second.
 Crosses crosses(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction)
          Checks if the first geometric operand crosses the second.
 Disjoint disjoint(Expression geometry1, Expression geometry2)
          Checks if the first operand is disjoint from the second.
 Disjoint disjoint(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the first operand is disjoint from the second.
 Disjoint disjoint(String propertyName, Geometry geometry)
          Checks if the first operand is disjoint from the second.
 Disjoint disjoint(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction)
          Checks if the first operand is disjoint from the second.
 Divide divide(Expression expr1, Expression expr2)
          Computes the numeric quotient resulting from dividing the first operand by the second.
 During during(Expression expr1, Expression expr2)
          Checks if one expression is temporally during another
 During during(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression is temporally during another
 DWithin 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 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.
 DWithin dwithin(String propertyName, Geometry geometry, double distance, String units)
          Checks if any part of the first geometry lies within the given distance of the second geometry.
 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.
 EndedBy endedBy(Expression expr1, Expression expr2)
          Checks if one expression is temporally ended by another
 EndedBy endedBy(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression is temporally ended by another
 Ends ends(Expression expr1, Expression expr2)
          Checks if one expression temporally ends by another
 Ends ends(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression temporally ends by another
 Equals equal(Expression geometry1, Expression geometry2)
          Checks if the geometry of the two operands are equal.
 PropertyIsEqualTo equal(Expression expr1, Expression expr2, boolean matchCase)
          Compares that two sub-expressions are equal to eacher other
 PropertyIsEqualTo equal(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction)
          Compares that two sub-expressions are equal to eacher other
 Equals equal(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the geometry of the two operands are equal.
 PropertyIsEqualTo equals(Expression expr1, Expression expr2)
          Compares that two sub-expressions are equal to each other.
 Equals equals(String propertyName, Geometry geometry)
          Checks if the geometry of the two operands are equal.
 Equals equals(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction)
          Checks if the geometry of the two operands are equal.
 FeatureId featureId(String id)
          Creates a new feautre id from a string
 FeatureId featureId(String fid, String featureVersion)
          Creates a new feature id with version information
 Function function(Name name, Expression... args)
          Call into some implementation-specific function.
 Function function(String name, Expression arg1)
           
 Function function(String name, Expression[] args)
          Call into some implementation-specific function.
 Function function(String name, Expression arg1, Expression arg2)
           
 Function function(String name, Expression arg1, Expression arg2, Expression arg3)
           
 Function function(String name, List<Expression> parameters, Literal fallback)
          Deprecated. Pending see org.opengis.filter.Factory2
 FunctionName functionName(Name name, int nargs)
          function name
 FunctionName functionName(Name name, int nargs, List<String> argNames)
          FunctionName used to describe an available function.
 FunctionName functionName(Name name, List<Parameter<?>> args, Parameter<?> ret)
          FunctionName used to describe an available function.
 FunctionName functionName(String name, int nargs)
          function name
 FunctionName functionName(String name, int nargs, List<String> argNames)
          FunctionName used to describe an available function.
 FunctionName functionName(String name, List<Parameter<?>> args, Parameter<?> ret)
          FunctionName used to describe an available function.
 Functions functions(FunctionName[] functionNames)
          functions
 Map getImplementationHints()
          Map of hints (maybe unmodifiable) used by this factory to customize its use.
 GmlObjectId gmlObjectId(String id)
          Creates a new gml object id from a string
 PropertyIsGreaterThan greater(Expression expr1, Expression expr2)
          Checks that the first sub-expression is greater than the second subexpression.
 PropertyIsGreaterThan greater(Expression expr1, Expression expr2, boolean matchCase)
          Checks that the first sub-expression is greater than the second subexpression.
 PropertyIsGreaterThan greater(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction)
          Checks that the first sub-expression is greater than the second subexpression.
 PropertyIsGreaterThanOrEqualTo greaterOrEqual(Expression expr1, Expression expr2)
          Checks that the first sub-expression is greater or equal to the second subexpression.
 PropertyIsGreaterThanOrEqualTo greaterOrEqual(Expression expr1, Expression expr2, boolean matchCase)
          Checks that the first sub-expression is greater or equal to the second subexpression.
 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.
 Id id(FeatureId... fids)
           
 Id id(Set id)
          Passes only for objects that have one of the IDs given to this object.
 IdCapabilities idCapabilities(boolean eid, boolean fid)
          id capabilities
 Intersects intersects(Expression geometry1, Expression geometry2)
          Checks if the two geometric operands intersect.
 Intersects intersects(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the two geometric operands intersect.
 Intersects intersects(String propertyName, Geometry geometry)
          Checks if the two geometric operands intersect.
 Intersects intersects(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction)
          Checks if the two geometric operands intersect.
 PropertyIsNil isNil(Expression expr, Object nilReason)
          Checks if an expression's value is nil.
 PropertyIsNull isNull(Expression expr)
          XXX Java 5 type narrowing used to make generated class explicit for chaining
 PropertyIsLessThan less(Expression expr1, Expression expr2)
          Checks that its first sub-expression is less than its second subexpression.
 PropertyIsLessThan less(Expression expr1, Expression expr2, boolean matchCase)
           
 PropertyIsLessThan less(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction)
           
 PropertyIsLessThanOrEqualTo lessOrEqual(Expression expr1, Expression expr2)
          Checks that its first sub-expression is less than or equal to its second subexpression.
 PropertyIsLessThanOrEqualTo lessOrEqual(Expression expr1, Expression expr2, boolean matchCase)
           
 PropertyIsLessThanOrEqualTo lessOrEqual(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction)
           
 PropertyIsLike like(Expression expr, String pattern)
          Character string comparison operator with pattern matching and default wildcards.
 PropertyIsLike like(Expression expr, String pattern, String wildcard, String singleChar, String escape)
          Character string comparison operator with pattern matching and specified wildcards.
 PropertyIsLike like(Expression expr, String pattern, String wildcard, String singleChar, String escape, boolean matchCase)
          Character string comparison operator with pattern matching and specified wildcards.
 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.
 Literal literal(boolean b)
          A constant, literal Boolean value that can be used in expressions.
 Literal literal(byte b)
          A constant, literal Byte value that can be used in expressions.
 Literal literal(char c)
          A constant, literal Character value that can be used in expressions.
 Literal literal(double d)
          A constant, literal Double value that can be used in expressions.
 Literal literal(float f)
          A constant, literal Float value that can be used in expressions.
 Literal literal(int i)
          A constant, literal Integer value that can be used in expressions.
 Literal literal(long l)
          A constant, literal Long value that can be used in expressions.
 Literal literal(Object obj)
          A constant, literal value that can be used in expressions.
 Literal literal(short s)
          A constant, literal Short value that can be used in expressions.
 Meets meets(Expression expr1, Expression expr2)
          Checks if one expression temporally meets another
 Meets meets(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression temporally meets another
 MetBy metBy(Expression expr1, Expression expr2)
          Checks if one expression is temporally met by another
 MetBy metBy(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression is temporally met by another
 Multiply multiply(Expression expr1, Expression expr2)
          Computes the numeric product of their first and second operand.
 Not not(Filter filter)
          Java 5 type narrowing used to advertise explicit implementation for chaining
 Filter not(Filter filter)
           
 PropertyIsNotEqualTo notEqual(Expression expr1, Expression expr2)
          Checks that the first sub-expression is not equal to the second subexpression.
 PropertyIsNotEqualTo notEqual(Expression expr1, Expression expr2, boolean matchCase)
          Checks that the first sub-expression is not equal to the second subexpression.
 PropertyIsNotEqualTo notEqual(Expression expr1, Expression expr2, boolean matchCase, MultiValuedFilter.MatchAction matchAction)
          Checks that the first sub-expression is not equal to the second subexpression.
 Operator operator(String name)
          operators
 Or or(Filter f, Filter g)
          OR filter between two filters.
 Filter or(Filter filter1, Filter filter2)
           
 Or or(List filters)
          OR filter between a list of filters.
 OverlappedBy overlappedBy(Expression expr1, Expression expr2)
          Checks if one expression is temporally overlapped by another
 OverlappedBy overlappedBy(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression is temporally overlapped by another
 Overlaps overlaps(Expression geometry1, Expression geometry2)
          Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.
 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.
 Overlaps overlaps(String propertyName, Geometry geometry)
          Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.
 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.
<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.
 PropertyName property(Name name)
          Retrieves the value of a feature's property.
 PropertyName property(String name)
          Retrieves the value of a feature's property.
 PropertyName property(String name, NamespaceSupport namespaceContext)
          Retrieves the value of a feature's property.
 ResourceId resourceId(String fid, Date startTime, Date endTime)
          ResourceId for time based query
 ResourceId resourceId(String fid, String featureVersion, Version version)
          ResouceId for identifier based query
 ScalarCapabilities scalarCapabilities(ComparisonOperators comparison, ArithmeticOperators arithmetic, boolean logicalOperators)
          scalar capabilities
 SortBy sort(String propertyName, SortOrder order)
          Indicates an property by which contents should be sorted, along with intended order.
 SpatialCapabilities spatialCapabilities(GeometryOperand[] geometryOperands, SpatialOperators spatial)
          spatial capabilities
 SpatialOperator spatialOperator(String name, GeometryOperand[] geometryOperands)
          spatial operator
 SpatialOperators spatialOperators(SpatialOperator[] spatialOperators)
          spatial operators
 Subtract subtract(Expression expr1, Expression expr2)
          Computes the numeric difference between the first and second operand.
 TContains tcontains(Expression expr1, Expression expr2)
          Checks if one expression temporally contains another
 TContains tcontains(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression temporally contains another
 TemporalCapabilities temporalCapabilities(TemporalOperator[] temporalOperators)
          temporal capabilities
 TemporalOperator temporalOperator(String name)
          temporal operator
 TEquals tequals(Expression expr1, Expression expr2)
          Checks if one expression temporally equals another
 TEquals tequals(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression temporally equals another
 Touches touches(Expression geometry1, Expression geometry2)
          Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.
 Touches touches(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.
 Touches touches(String propertyName, Geometry geometry)
          Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.
 Touches 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.
 TOverlaps toverlaps(Expression expr1, Expression expr2)
          Checks if one expression temporally overlaps another
 TOverlaps toverlaps(Expression expr1, Expression expr2, MultiValuedFilter.MatchAction matchAction)
          Checks if one expression temporally overlaps another
 Within within(Expression geometry1, Expression geometry2)
          Checks if the feature's geometry is completely contained by the specified constant geometry.
 Within within(Expression geometry1, Expression geometry2, MultiValuedFilter.MatchAction matchAction)
          Checks if the feature's geometry is completely contained by the specified constant geometry.
 Within within(Expression geometry1, Geometry geometry2)
           
 Within within(String propertyName, Geometry geometry)
          Checks if the feature's geometry is completely contained by the specified constant geometry.
 Within within(String propertyName, Geometry geometry, MultiValuedFilter.MatchAction matchAction)
          Checks if the feature's geometry is completely contained by the specified constant geometry.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterFactoryImpl

public FilterFactoryImpl()
Creates a new instance of FilterFactoryImpl


FilterFactoryImpl

public FilterFactoryImpl(Hints hints)
Method Detail

featureId

public FeatureId featureId(String id)
Description copied from interface: FilterFactory
Creates a new feautre id from a string

Specified by:
featureId in interface FilterFactory

gmlObjectId

public GmlObjectId gmlObjectId(String id)
Description copied from interface: FilterFactory
Creates a new gml object id from a string

Specified by:
gmlObjectId in interface FilterFactory

featureId

public FeatureId featureId(String fid,
                           String featureVersion)
Creates a new feature id with version information

Specified by:
featureId in interface FilterFactory

resourceId

public ResourceId resourceId(String fid,
                             String featureVersion,
                             Version version)
ResouceId for identifier based query

Specified by:
resourceId in interface FilterFactory

resourceId

public ResourceId resourceId(String fid,
                             Date startTime,
                             Date endTime)
ResourceId for time based query

Specified by:
resourceId in interface FilterFactory
Parameters:
fid - feature id, non null;

and

public And and(Filter f,
               Filter g)
Description copied from interface: FilterFactory
AND filter between two filters.

Specified by:
and in interface FilterFactory

and

public And and(List filters)
Description copied from interface: FilterFactory
AND filter between a list of filters.

Specified by:
and in interface FilterFactory

or

public Or or(Filter f,
             Filter g)
Description copied from interface: FilterFactory
OR filter between two filters.

Specified by:
or in interface FilterFactory

or

public Or or(List filters)
Description copied from interface: FilterFactory
OR filter between a list of filters.

Specified by:
or in interface FilterFactory

not

public Not not(Filter filter)
Java 5 type narrowing used to advertise explicit implementation for chaining

Specified by:
not in interface FilterFactory

id

public Id id(Set id)
Description copied from interface: FilterFactory
Passes only for objects that have one of the IDs given to this object.

Specified by:
id in interface FilterFactory

id

public Id id(FeatureId... fids)
Specified by:
id in interface FilterFactory2

property

public PropertyName property(String name)
Description copied from interface: FilterFactory
Retrieves the value of a feature's property.

Specified by:
property in interface FilterFactory

between

public PropertyIsBetween between(Expression expr,
                                 Expression lower,
                                 Expression upper)
Description copied from interface: FilterFactory
A compact way of encoding a range check.

Specified by:
between in interface FilterFactory

between

public PropertyIsBetween between(Expression expr,
                                 Expression lower,
                                 Expression upper,
                                 MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
A compact way of encoding a range check.

Specified by:
between in interface FilterFactory

equals

public PropertyIsEqualTo equals(Expression expr1,
                                Expression expr2)
Description copied from interface: FilterFactory
Compares that two sub-expressions are equal to each other.

Specified by:
equals in interface FilterFactory

equal

public PropertyIsEqualTo equal(Expression expr1,
                               Expression expr2,
                               boolean matchCase)
Description copied from interface: FilterFactory
Compares that two sub-expressions are equal to eacher other

Specified by:
equal in interface FilterFactory

equal

public PropertyIsEqualTo equal(Expression expr1,
                               Expression expr2,
                               boolean matchCase,
                               MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Compares that two sub-expressions are equal to eacher other

Specified by:
equal in interface FilterFactory

notEqual

public PropertyIsNotEqualTo notEqual(Expression expr1,
                                     Expression expr2)
Description copied from interface: FilterFactory
Checks that the first sub-expression is not equal to the second subexpression.

Specified by:
notEqual in interface FilterFactory

notEqual

public PropertyIsNotEqualTo notEqual(Expression expr1,
                                     Expression expr2,
                                     boolean matchCase)
Description copied from interface: FilterFactory
Checks that the first sub-expression is not equal to the second subexpression.

Specified by:
notEqual in interface FilterFactory
Parameters:
expr1 - first expression
expr2 - second expression
matchCase - true if the comparison should be case insensitive
Returns:
evaluates to true of expr1 not equal to expr2

notEqual

public PropertyIsNotEqualTo notEqual(Expression expr1,
                                     Expression expr2,
                                     boolean matchCase,
                                     MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks that the first sub-expression is not equal to the second subexpression.

Specified by:
notEqual in interface FilterFactory
Parameters:
expr1 - first expression
expr2 - second expression
matchCase - true if the comparison should be case insensitive
matchAction - action for multi-valued properties
Returns:
evaluates to true of expr1 not equal to expr2

greater

public PropertyIsGreaterThan greater(Expression expr1,
                                     Expression expr2)
Description copied from interface: FilterFactory
Checks that the first sub-expression is greater than the second subexpression.

Specified by:
greater in interface FilterFactory

greater

public PropertyIsGreaterThan greater(Expression expr1,
                                     Expression expr2,
                                     boolean matchCase)
Description copied from interface: FilterFactory
Checks that the first sub-expression is greater than the second subexpression.

Specified by:
greater in interface FilterFactory
Parameters:
expr1 - first expression
expr2 - second expression
matchCase - true if the comparison should be case insensitive
Returns:
evaluates to true of expr1 is greater than expr2

greater

public PropertyIsGreaterThan greater(Expression expr1,
                                     Expression expr2,
                                     boolean matchCase,
                                     MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks that the first sub-expression is greater than the second subexpression.

Specified by:
greater in interface FilterFactory
Parameters:
expr1 - first expression
expr2 - second expression
matchCase - true if the comparison should be case insensitive
Returns:
evaluates to true of expr1 is greater than expr2

greaterOrEqual

public PropertyIsGreaterThanOrEqualTo greaterOrEqual(Expression expr1,
                                                     Expression expr2)
Description copied from interface: FilterFactory
Checks that the first sub-expression is greater or equal to the second subexpression.

Specified by:
greaterOrEqual in interface FilterFactory

greaterOrEqual

public PropertyIsGreaterThanOrEqualTo greaterOrEqual(Expression expr1,
                                                     Expression expr2,
                                                     boolean matchCase)
Description copied from interface: FilterFactory
Checks that the first sub-expression is greater or equal to the second subexpression.

Specified by:
greaterOrEqual in interface FilterFactory

greaterOrEqual

public PropertyIsGreaterThanOrEqualTo greaterOrEqual(Expression expr1,
                                                     Expression expr2,
                                                     boolean matchCase,
                                                     MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks that the first sub-expression is greater or equal to the second subexpression.

Specified by:
greaterOrEqual in interface FilterFactory

less

public PropertyIsLessThan less(Expression expr1,
                               Expression expr2)
Description copied from interface: FilterFactory
Checks that its first sub-expression is less than its second subexpression.

Specified by:
less in interface FilterFactory

less

public PropertyIsLessThan less(Expression expr1,
                               Expression expr2,
                               boolean matchCase)
Specified by:
less in interface FilterFactory

less

public PropertyIsLessThan less(Expression expr1,
                               Expression expr2,
                               boolean matchCase,
                               MultiValuedFilter.MatchAction matchAction)
Specified by:
less in interface FilterFactory

lessOrEqual

public PropertyIsLessThanOrEqualTo lessOrEqual(Expression expr1,
                                               Expression expr2)
Description copied from interface: FilterFactory
Checks that its first sub-expression is less than or equal to its second subexpression.

Specified by:
lessOrEqual in interface FilterFactory

lessOrEqual

public PropertyIsLessThanOrEqualTo lessOrEqual(Expression expr1,
                                               Expression expr2,
                                               boolean matchCase)
Specified by:
lessOrEqual in interface FilterFactory

lessOrEqual

public PropertyIsLessThanOrEqualTo lessOrEqual(Expression expr1,
                                               Expression expr2,
                                               boolean matchCase,
                                               MultiValuedFilter.MatchAction matchAction)
Specified by:
lessOrEqual in interface FilterFactory

like

public PropertyIsLike like(Expression expr,
                           String pattern)
Description copied from interface: FilterFactory
Character string comparison operator with pattern matching and default wildcards.

Specified by:
like in interface FilterFactory

like

public PropertyIsLike like(Expression expr,
                           String pattern,
                           String wildcard,
                           String singleChar,
                           String escape)
Description copied from interface: FilterFactory
Character string comparison operator with pattern matching and specified wildcards.

Specified by:
like in interface FilterFactory

like

public PropertyIsLike like(Expression expr,
                           String pattern,
                           String wildcard,
                           String singleChar,
                           String escape,
                           boolean matchCase)
Description copied from interface: FilterFactory2
Character string comparison operator with pattern matching and specified wildcards.

Specified by:
like in interface FilterFactory
Specified by:
like in interface FilterFactory2

like

public PropertyIsLike like(Expression expr,
                           String pattern,
                           String wildcard,
                           String singleChar,
                           String escape,
                           boolean matchCase,
                           MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
Character string comparison operator with pattern matching and specified wildcards.

Specified by:
like in interface FilterFactory
Specified by:
like in interface FilterFactory2

isNull

public PropertyIsNull isNull(Expression expr)
XXX Java 5 type narrowing used to make generated class explicit for chaining

Specified by:
isNull in interface FilterFactory

isNil

public PropertyIsNil isNil(Expression expr,
                           Object nilReason)
Description copied from interface: FilterFactory
Checks if an expression's value is nil.

Specified by:
isNil in interface FilterFactory

bbox

public BBOX bbox(String propertyName,
                 double minx,
                 double miny,
                 double maxx,
                 double maxy,
                 String srs)
Checks if the bounding box of the feature's geometry overlaps the specified bounding box.

Similar to: geom().disjoint( geom( bbox )).not()

Specified by:
bbox in interface FilterFactory
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 CoordianteReferenceSystem to use for a literal BoundingBox

bbox

public BBOX bbox(Expression geometry,
                 Expression bounds)

bbox

public BBOX bbox(Expression geometry,
                 BoundingBox bounds)
Description copied from interface: FilterFactory2
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.

Specified by:
bbox in interface FilterFactory2
Parameters:
geometry - Expression used to access a Geometry, in order to check for interaction with bounds
bounds - Indicates the bounds to check geometry against

bbox

public BBOX bbox(Expression geometry,
                 BoundingBox bounds,
                 MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
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.

Specified by:
bbox in interface FilterFactory2
Parameters:
geometry - Expression used to access a Geometry, in order to check for interaction with bounds
bounds - Indicates the bounds to check geometry against
matchAction - Match Action

bbox

public BBOX bbox(String propertyName,
                 double minx,
                 double miny,
                 double maxx,
                 double maxy,
                 String srs,
                 MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
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 FilterFactory2.bbox(Expression, BoundingBox) to be easier to use.

Specified by:
bbox in interface FilterFactory
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 CoordianteReferenceSystem to use for a literal BoundingBox

bbox

public BBOX bbox(Expression geometry,
                 double minx,
                 double miny,
                 double maxx,
                 double maxy,
                 String srs)
Description copied from interface: FilterFactory
Checks if the geometry expression overlaps the specified bounding box.

Specified by:
bbox in interface FilterFactory2

bbox

public BBOX bbox(Expression e,
                 double minx,
                 double miny,
                 double maxx,
                 double maxy,
                 String srs,
                 MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
Checks if the geometry expression overlaps the specified bounding box.

Specified by:
bbox in interface FilterFactory2

bbox

public BBOX3D bbox(String propertyName,
                   BoundingBox3D env)
Specified by:
bbox in interface FilterFactory

bbox

public BBOX3D bbox(String propertyName,
                   BoundingBox3D env,
                   MultiValuedFilter.MatchAction matchAction)
Specified by:
bbox in interface FilterFactory

bbox

public BBOX3D bbox(Expression geometry,
                   BoundingBox3D env)
Description copied from interface: FilterFactory2
Checks if the geometry expression overlaps the specified bounding box.

Specified by:
bbox in interface FilterFactory2

bbox

public BBOX3D bbox(Expression e,
                   BoundingBox3D env,
                   MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
Checks if the geometry expression overlaps the specified bounding box.

Specified by:
bbox in interface FilterFactory2

beyond

public Beyond beyond(String propertyName,
                     Geometry geometry,
                     double distance,
                     String units)
Description copied from interface: FilterFactory
Check if all of a feature's geometry is more distant than the given distance from this object's geometry.

Specified by:
beyond in interface FilterFactory

beyond

public Beyond beyond(String propertyName,
                     Geometry geometry,
                     double distance,
                     String units,
                     MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Check if all of a feature's geometry is more distant than the given distance from this object's geometry.

Specified by:
beyond in interface FilterFactory

beyond

public Beyond beyond(Expression geometry1,
                     Expression geometry2,
                     double distance,
                     String units)
Description copied from interface: FilterFactory
Check if all of a geometry is more distant than the given distance from this object's geometry.

Specified by:
beyond in interface FilterFactory2

beyond

public Beyond beyond(Expression geometry1,
                     Expression geometry2,
                     double distance,
                     String units,
                     MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
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

public Contains contains(String propertyName,
                         Geometry geometry)
Description copied from interface: FilterFactory
Checks if the the first geometric operand contains the second.

Specified by:
contains in interface FilterFactory

contains

public Contains contains(Expression geometry1,
                         Expression geometry2)
Description copied from interface: FilterFactory
Checks if the the first geometric operand contains the second.

Specified by:
contains in interface FilterFactory2

contains

public Contains contains(Expression geometry1,
                         Expression geometry2,
                         MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
Checks if the the first geometric operand contains the second.

Specified by:
contains in interface FilterFactory2

contains

public Contains contains(String propertyName,
                         Geometry geometry,
                         MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if the the first geometric operand contains the second.

Specified by:
contains in interface FilterFactory

crosses

public Crosses crosses(String propertyName,
                       Geometry geometry)
Description copied from interface: FilterFactory
Checks if the first geometric operand crosses the second.

Specified by:
crosses in interface FilterFactory

crosses

public Crosses crosses(String propertyName,
                       Geometry geometry,
                       MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if the first geometric operand crosses the second.

Specified by:
crosses in interface FilterFactory

crosses

public Crosses crosses(Expression geometry1,
                       Expression geometry2)
Description copied from interface: FilterFactory
Checks if the first geometric operand crosses the second.

Specified by:
crosses in interface FilterFactory2

crosses

public Crosses crosses(Expression geometry1,
                       Expression geometry2,
                       MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
Checks if the first geometric operand crosses the second.

Specified by:
crosses in interface FilterFactory2

disjoint

public Disjoint disjoint(String propertyName,
                         Geometry geometry)
Description copied from interface: FilterFactory
Checks if the first operand is disjoint from the second.

Specified by:
disjoint in interface FilterFactory

disjoint

public Disjoint disjoint(String propertyName,
                         Geometry geometry,
                         MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if the first operand is disjoint from the second.

Specified by:
disjoint in interface FilterFactory

disjoint

public Disjoint disjoint(Expression geometry1,
                         Expression geometry2,
                         MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
Checks if the first operand is disjoint from the second.

Specified by:
disjoint in interface FilterFactory2

disjoint

public Disjoint disjoint(Expression geometry1,
                         Expression geometry2)
Description copied from interface: FilterFactory
Checks if the first operand is disjoint from the second.

Specified by:
disjoint in interface FilterFactory2

dwithin

public DWithin dwithin(String propertyName,
                       Geometry geometry,
                       double distance,
                       String units)
Description copied from interface: FilterFactory
Checks if any part of the first geometry lies within the given distance of the second geometry.

Specified by:
dwithin in interface FilterFactory

dwithin

public DWithin dwithin(String propertyName,
                       Geometry geometry,
                       double distance,
                       String units,
                       MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if any part of the first geometry lies within the given distance of the second geometry.

Specified by:
dwithin in interface FilterFactory

dwithin

public DWithin dwithin(Expression geometry1,
                       Expression geometry2,
                       double distance,
                       String units,
                       MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
Checks if any part of the first geometry lies within the given distance of the second geometry.

Specified by:
dwithin in interface FilterFactory2

dwithin

public DWithin dwithin(Expression geometry1,
                       Expression geometry2,
                       double distance,
                       String units)
Description copied from interface: FilterFactory
Checks if any part of the first geometry lies within the given distance of the second geometry.

Specified by:
dwithin in interface FilterFactory2

equals

public Equals equals(String propertyName,
                     Geometry geometry)
Description copied from interface: FilterFactory
Checks if the geometry of the two operands are equal.

Specified by:
equals in interface FilterFactory

equals

public Equals equals(String propertyName,
                     Geometry geometry,
                     MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if the geometry of the two operands are equal.

Specified by:
equals in interface FilterFactory

equal

public Equals equal(Expression geometry1,
                    Expression geometry2)
Description copied from interface: FilterFactory
Checks if the geometry of the two operands are equal.

Specified by:
equal in interface FilterFactory2

equal

public Equals equal(Expression geometry1,
                    Expression geometry2,
                    MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
Checks if the geometry of the two operands are equal.

Specified by:
equal in interface FilterFactory2

intersects

public Intersects intersects(String propertyName,
                             Geometry geometry)
Description copied from interface: FilterFactory
Checks if the two geometric operands intersect.

Specified by:
intersects in interface FilterFactory

intersects

public Intersects intersects(String propertyName,
                             Geometry geometry,
                             MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if the two geometric operands intersect.

Specified by:
intersects in interface FilterFactory

intersects

public Intersects intersects(Expression geometry1,
                             Expression geometry2)
Description copied from interface: FilterFactory
Checks if the two geometric operands intersect.

Specified by:
intersects in interface FilterFactory2

intersects

public Intersects intersects(Expression geometry1,
                             Expression geometry2,
                             MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
Checks if the two geometric operands intersect.

Specified by:
intersects in interface FilterFactory2

overlaps

public Overlaps overlaps(String propertyName,
                         Geometry geometry)
Description copied from interface: FilterFactory
Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.

Specified by:
overlaps in interface FilterFactory

overlaps

public Overlaps overlaps(String propertyName,
                         Geometry geometry,
                         MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.

Specified by:
overlaps in interface FilterFactory

overlaps

public Overlaps overlaps(Expression geometry1,
                         Expression geometry2)
Description copied from interface: FilterFactory
Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.

Specified by:
overlaps in interface FilterFactory2

overlaps

public Overlaps overlaps(Expression geometry1,
                         Expression geometry2,
                         MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.

Specified by:
overlaps in interface FilterFactory2

touches

public Touches touches(String propertyName,
                       Geometry geometry)
Description copied from interface: FilterFactory
Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.

Specified by:
touches in interface FilterFactory

touches

public Touches touches(String propertyName,
                       Geometry geometry,
                       MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.

Specified by:
touches in interface FilterFactory

touches

public Touches touches(Expression geometry1,
                       Expression geometry2)
Description copied from interface: FilterFactory
Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.

Specified by:
touches in interface FilterFactory2

touches

public Touches touches(Expression geometry1,
                       Expression geometry2,
                       MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
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

public Within within(String propertyName,
                     Geometry geometry)
Description copied from interface: FilterFactory
Checks if the feature's geometry is completely contained by the specified constant geometry.

Specified by:
within in interface FilterFactory

within

public Within within(String propertyName,
                     Geometry geometry,
                     MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if the feature's geometry is completely contained by the specified constant geometry.

Specified by:
within in interface FilterFactory

within

public Within within(Expression geometry1,
                     Expression geometry2)
Description copied from interface: FilterFactory
Checks if the feature's geometry is completely contained by the specified constant geometry.

Specified by:
within in interface FilterFactory2

within

public Within within(Expression geometry1,
                     Expression geometry2,
                     MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory2
Checks if the feature's geometry is completely contained by the specified constant geometry.

Specified by:
within in interface FilterFactory2

add

public Add add(Expression expr1,
               Expression expr2)
Description copied from interface: FilterFactory
Computes the numeric addition of the first and second operand.

Specified by:
add in interface FilterFactory

divide

public Divide divide(Expression expr1,
                     Expression expr2)
Description copied from interface: FilterFactory
Computes the numeric quotient resulting from dividing the first operand by the second.

Specified by:
divide in interface FilterFactory

multiply

public Multiply multiply(Expression expr1,
                         Expression expr2)
Description copied from interface: FilterFactory
Computes the numeric product of their first and second operand.

Specified by:
multiply in interface FilterFactory

subtract

public Subtract subtract(Expression expr1,
                         Expression expr2)
Description copied from interface: FilterFactory
Computes the numeric difference between the first and second operand.

Specified by:
subtract in interface FilterFactory

function

public Function function(String name,
                         Expression[] args)
Description copied from interface: FilterFactory
Call into some implementation-specific function.

Specified by:
function in interface FilterFactory

function

public Function function(Name name,
                         Expression... args)
Description copied from interface: FilterFactory
Call into some implementation-specific function.

Specified by:
function in interface FilterFactory

function

public Function function(String name,
                         Expression arg1)

function

public Function function(String name,
                         Expression arg1,
                         Expression arg2)

function

public Function function(String name,
                         List<Expression> parameters,
                         Literal fallback)
Deprecated. Pending see org.opengis.filter.Factory2


function

public Function function(String name,
                         Expression arg1,
                         Expression arg2,
                         Expression arg3)

literal

public Literal literal(Object obj)
Description copied from interface: FilterFactory
A constant, literal value that can be used in expressions.

Specified by:
literal in interface FilterFactory

literal

public Literal literal(byte b)
Description copied from interface: FilterFactory
A constant, literal Byte value that can be used in expressions.

Specified by:
literal in interface FilterFactory

literal

public Literal literal(short s)
Description copied from interface: FilterFactory
A constant, literal Short value that can be used in expressions.

Specified by:
literal in interface FilterFactory

literal

public Literal literal(int i)
Description copied from interface: FilterFactory
A constant, literal Integer value that can be used in expressions.

Specified by:
literal in interface FilterFactory

literal

public Literal literal(long l)
Description copied from interface: FilterFactory
A constant, literal Long value that can be used in expressions.

Specified by:
literal in interface FilterFactory

literal

public Literal literal(float f)
Description copied from interface: FilterFactory
A constant, literal Float value that can be used in expressions.

Specified by:
literal in interface FilterFactory

literal

public Literal literal(double d)
Description copied from interface: FilterFactory
A constant, literal Double value that can be used in expressions.

Specified by:
literal in interface FilterFactory

literal

public Literal literal(char c)
Description copied from interface: FilterFactory
A constant, literal Character value that can be used in expressions.

Specified by:
literal in interface FilterFactory

literal

public Literal literal(boolean b)
Description copied from interface: FilterFactory
A constant, literal Boolean value that can be used in expressions.

Specified by:
literal in interface FilterFactory

createAttributeExpression

public AttributeExpression createAttributeExpression(String xpath)
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

public AttributeExpression createAttributeExpression(SimpleFeatureType schema)
Creates a Attribute Expression with an initial schema.

Parameters:
schema - the schema to create with.
Returns:
The new Attribute Expression.

createAttributeExpression

public AttributeExpression createAttributeExpression(SimpleFeatureType schema,
                                                     String path)
                                              throws IllegalFilterException
Creates a Attribute Expression given a schema and attribute path.

Parameters:
schema - the schema to get the attribute from.
path - the xPath of the attribute to compare.
Returns:
The new Attribute Expression.
Throws:
IllegalFilterException - if there were creation problems.

createAttributeExpression

public AttributeExpression createAttributeExpression(AttributeDescriptor at)
                                              throws IllegalFilterException
Description copied from interface: FilterFactory
Shortcut the process - will only grab values matching AttributeType.

Returns:
The new Attribtue Expression
Throws:
IllegalFilterException - if there were creation problems

createBBoxExpression

public BBoxExpression createBBoxExpression(Envelope env)
                                    throws IllegalFilterException
Creates a BBox 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.

createBetweenFilter

public BetweenFilter createBetweenFilter()
                                  throws IllegalFilterException
Creates an empty Between Filter.

Returns:
The new Between Filter.
Throws:
IllegalFilterException - if there were creation problems.

createCompareFilter

public CompareFilter createCompareFilter(short type)
                                  throws IllegalFilterException
Deprecated. @see org.geotools.filter.FilterFactory#createCompareFilter(short)

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.

createFidFilter

public FidFilter createFidFilter()
Creates a new Fid Filter with no initial fids.

Returns:
The new Fid Filter.

createFidFilter

public FidFilter createFidFilter(String fid)
Creates a Fid Filter with an initial fid.

Parameters:
fid - the feature ID to create with.
Returns:
The new FidFilter.

createGeometryFilter

public GeometryFilter createGeometryFilter(short filterType)
                                    throws IllegalFilterException
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

public GeometryDistanceFilter createGeometryDistanceFilter(short filterType)
                                                    throws IllegalFilterException
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.

createLikeFilter

public LikeFilter createLikeFilter()
Creates a Like Filter.

Returns:
The new Like Filter.

createLiteralExpression

public LiteralExpression createLiteralExpression()
Creates an empty Literal Expression

Returns:
The new Literal Expression.

createLiteralExpression

public LiteralExpression createLiteralExpression(Object o)
                                          throws IllegalFilterException
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.

createLiteralExpression

public LiteralExpression createLiteralExpression(int i)
Creates an Integer Literal Expression.

Parameters:
i - the int to serve as literal.
Returns:
The new Literal Expression

createLiteralExpression

public LiteralExpression createLiteralExpression(double d)
Creates a Double Literal Expression

Parameters:
d - the double to serve as the literal.
Returns:
The new Literal Expression

createLiteralExpression

public LiteralExpression createLiteralExpression(String s)
Creates a String Literal Expression

Parameters:
s - the string to serve as the literal.
Returns:
The new Literal Expression

createLogicFilter

public 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

public 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.

createLogicFilter

public 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.

createMathExpression

public MathExpression createMathExpression()
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

createMathExpression

public MathExpression createMathExpression(short expressionType)
                                    throws IllegalFilterException
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.

createFunctionExpression

public FunctionExpression createFunctionExpression(String name)
Creates a Function Expression.

Parameters:
name - the function name.
Returns:
The new Function Expression.

createNullFilter

public NullFilter createNullFilter()
Creates an empty Null Filter.

Returns:
The new Null Filter.

createEnvironmentVariable

public EnvironmentVariable createEnvironmentVariable(String name)
Description copied from interface: FilterFactory
Creates an Environment Variable

Parameters:
name - the function name.
Returns:
The new Function Expression.

getImplementationHints

public Map getImplementationHints()
Description copied from interface: Factory
Map of hints (maybe unmodifiable) used by this factory to customize its use. This map is not guaranteed to contains all the hints supplied by the user; it may be only a subset. Consequently, hints provided here are usually not suitable for creating new factories, unless the implementation make some additional garantees (e.g. FactoryUsingVolatileDependencies).

The primary purpose of this method is to determine if an existing factory instance can be reused for a set of user-supplied hints. This method is invoked by FactoryRegistry in order to compare this factory's hints against user's hints. This is dependency introspection only; FactoryRegistry never invokes this method for creating new factories.

Keys are usually static constants from the Hints class, while values are instances of some key-dependent class. The key set must contains at least all hints impacting functionality. While the key set may contains all hints supplied by the user, it is recommended to limit the set to only the hints used by this particular factory instance. A minimal set will helps FactoryRegistry to compare only hints that matter and avoid the creation of unnecessary instances of this factory.

The hint values may be different than the one supplied by the user. If a user supplied a hint as a Class object, this method shall replace it by the actual instance used, if possible.

Implementations of this method are usually quite simple. For example if a datum authority factory uses an ordinary datum factory, its method could be implemented as below (note that we should not check if the datum factory is null, since key with null value is the expected behaviour in this case). Example:


 Map hints = new HashMap();
 hints.put(Hints.DATUM_FACTORY, datumFactory);
 return hints;
 

Specified by:
getImplementationHints in interface Factory
Returns:
The map of hints, or an empty map if none.

sort

public SortBy sort(String propertyName,
                   SortOrder order)
Description copied from interface: FilterFactory
Indicates an property by which contents should be sorted, along with intended order.

Specified by:
sort in interface FilterFactory

after

public After after(Expression expr1,
                   Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression is temporally after another

Specified by:
after in interface FilterFactory

after

public After after(Expression expr1,
                   Expression expr2,
                   MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression is temporally after another

Specified by:
after in interface FilterFactory

anyInteracts

public AnyInteracts anyInteracts(Expression expr1,
                                 Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression temporally interacts in any way with another

Specified by:
anyInteracts in interface FilterFactory

anyInteracts

public AnyInteracts anyInteracts(Expression expr1,
                                 Expression expr2,
                                 MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression temporally interacts in any way with another

Specified by:
anyInteracts in interface FilterFactory

before

public Before before(Expression expr1,
                     Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression is temporally before another

Specified by:
before in interface FilterFactory

before

public Before before(Expression expr1,
                     Expression expr2,
                     MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression is temporally before another

Specified by:
before in interface FilterFactory

begins

public Begins begins(Expression expr1,
                     Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression temporally begins another

Specified by:
begins in interface FilterFactory

begins

public Begins begins(Expression expr1,
                     Expression expr2,
                     MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression temporally begins another

Specified by:
begins in interface FilterFactory

begunBy

public BegunBy begunBy(Expression expr1,
                       Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression is temporally begun by another

Specified by:
begunBy in interface FilterFactory

begunBy

public BegunBy begunBy(Expression expr1,
                       Expression expr2,
                       MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression is temporally begun by another

Specified by:
begunBy in interface FilterFactory

during

public During during(Expression expr1,
                     Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression is temporally during another

Specified by:
during in interface FilterFactory

during

public During during(Expression expr1,
                     Expression expr2,
                     MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression is temporally during another

Specified by:
during in interface FilterFactory

endedBy

public EndedBy endedBy(Expression expr1,
                       Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression is temporally ended by another

Specified by:
endedBy in interface FilterFactory

endedBy

public EndedBy endedBy(Expression expr1,
                       Expression expr2,
                       MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression is temporally ended by another

Specified by:
endedBy in interface FilterFactory

ends

public Ends ends(Expression expr1,
                 Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression temporally ends by another

Specified by:
ends in interface FilterFactory

ends

public Ends ends(Expression expr1,
                 Expression expr2,
                 MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression temporally ends by another

Specified by:
ends in interface FilterFactory

meets

public Meets meets(Expression expr1,
                   Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression temporally meets another

Specified by:
meets in interface FilterFactory

meets

public Meets meets(Expression expr1,
                   Expression expr2,
                   MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression temporally meets another

Specified by:
meets in interface FilterFactory

metBy

public MetBy metBy(Expression expr1,
                   Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression is temporally met by another

Specified by:
metBy in interface FilterFactory

metBy

public MetBy metBy(Expression expr1,
                   Expression expr2,
                   MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression is temporally met by another

Specified by:
metBy in interface FilterFactory

overlappedBy

public OverlappedBy overlappedBy(Expression expr1,
                                 Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression is temporally overlapped by another

Specified by:
overlappedBy in interface FilterFactory

overlappedBy

public OverlappedBy overlappedBy(Expression expr1,
                                 Expression expr2,
                                 MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression is temporally overlapped by another

Specified by:
overlappedBy in interface FilterFactory

tcontains

public TContains tcontains(Expression expr1,
                           Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression temporally contains another

Specified by:
tcontains in interface FilterFactory

tcontains

public TContains tcontains(Expression expr1,
                           Expression expr2,
                           MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression temporally contains another

Specified by:
tcontains in interface FilterFactory

tequals

public TEquals tequals(Expression expr1,
                       Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression temporally equals another

Specified by:
tequals in interface FilterFactory

tequals

public TEquals tequals(Expression expr1,
                       Expression expr2,
                       MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression temporally equals another

Specified by:
tequals in interface FilterFactory

toverlaps

public TOverlaps toverlaps(Expression expr1,
                           Expression expr2)
Description copied from interface: FilterFactory
Checks if one expression temporally overlaps another

Specified by:
toverlaps in interface FilterFactory

toverlaps

public TOverlaps toverlaps(Expression expr1,
                           Expression expr2,
                           MultiValuedFilter.MatchAction matchAction)
Description copied from interface: FilterFactory
Checks if one expression temporally overlaps another

Specified by:
toverlaps in interface FilterFactory

and

public Filter and(Filter filter1,
                  Filter filter2)

not

public Filter not(Filter filter)

or

public Filter or(Filter filter1,
                 Filter filter2)

beyond

public Beyond beyond(Expression geometry1,
                     Geometry geometry2,
                     double distance,
                     String units)

property

public PropertyName property(Name name)
Description copied from interface: FilterFactory2
Retrieves the value of a feature's property.

Specified by:
property in interface FilterFactory2
Parameters:
name - Name of attribute referenced
Returns:
PropertyName

property

public PropertyName property(String name,
                             NamespaceSupport namespaceContext)
Description copied from interface: FilterFactory2
Retrieves the value of a feature's property.

Specified by:
property in interface FilterFactory2
Parameters:
name - XPath expression (subject to the restrictions of filter specificaiton)
namespaceContext - Used to interpret any namespace prefixs in above xpath expression
Returns:
PropertyName

within

public Within within(Expression geometry1,
                     Geometry geometry2)

operator

public Operator operator(String name)
Description copied from interface: FilterFactory
operators

Specified by:
operator in interface FilterFactory

spatialOperator

public SpatialOperator spatialOperator(String name,
                                       GeometryOperand[] geometryOperands)
Description copied from interface: FilterFactory
spatial operator

Specified by:
spatialOperator in interface FilterFactory

temporalOperator

public TemporalOperator temporalOperator(String name)
Description copied from interface: FilterFactory
temporal operator

Specified by:
temporalOperator in interface FilterFactory

parameter

public <T> Parameter<T> parameter(String name,
                                  Class<T> type,
                                  InternationalString title,
                                  InternationalString description,
                                  boolean required,
                                  int minOccurs,
                                  int maxOccurs,
                                  T defaultValue)
Description copied from interface: FilterFactory2
Creates a parameter of a function.

Specified by:
parameter in interface FilterFactory2
Parameters:
name - Parameter name
type - Parameter type/class
title - Human readable title of the parameter
description - Extended description of the parameter
required - Flag indicating if the parameter is required or not
minOccurs - The minimum number of occurrences of the parameter
maxOccurs - The maximum number of occurrences of the parameter
defaultValue - Default value for the parameter

functionName

public FunctionName functionName(String name,
                                 int nargs)
Description copied from interface: FilterFactory
function name

Specified by:
functionName in interface FilterFactory

functionName

public FunctionName functionName(Name name,
                                 int nargs)
Description copied from interface: FilterFactory
function name

Specified by:
functionName in interface FilterFactory

functionName

public FunctionName functionName(String name,
                                 int nargs,
                                 List<String> argNames)
Description copied from interface: FilterFactory2
FunctionName used to describe an available function.

Specified by:
functionName in interface FilterFactory2
Parameters:
name - name of function
nargs - number of arguments, use a negative number to indicate a minimum if the function supports an open ended number of arguments
argNames - Optional list of argument names

functionName

public FunctionName functionName(Name name,
                                 int nargs,
                                 List<String> argNames)
Description copied from interface: FilterFactory2
FunctionName used to describe an available function.

Specified by:
functionName in interface FilterFactory2
Parameters:
name - qualified name of function
nargs - number of arguments, use a negative number to indicate a minimum if the function supports an open ended number of arguments
argNames - Optional list of argument names

functionName

public FunctionName functionName(String name,
                                 List<Parameter<?>> args,
                                 Parameter<?> ret)
Description copied from interface: FilterFactory2
FunctionName used to describe an available function.

Specified by:
functionName in interface FilterFactory2
Parameters:
name - name of function
args - Parameters describing function arguments.
ret - Parameter describing function return.

functionName

public FunctionName functionName(Name name,
                                 List<Parameter<?>> args,
                                 Parameter<?> ret)
Description copied from interface: FilterFactory2
FunctionName used to describe an available function.

Specified by:
functionName in interface FilterFactory2
Parameters:
name - qualified name of function
args - Parameters describing function arguments.
ret - Parameter describing function return.

functions

public Functions functions(FunctionName[] functionNames)
Description copied from interface: FilterFactory
functions

Specified by:
functions in interface FilterFactory

spatialOperators

public SpatialOperators spatialOperators(SpatialOperator[] spatialOperators)
Description copied from interface: FilterFactory
spatial operators

Specified by:
spatialOperators in interface FilterFactory

arithmeticOperators

public ArithmeticOperators arithmeticOperators(boolean simple,
                                               Functions functions)
Description copied from interface: FilterFactory
arithmetic operators

Specified by:
arithmeticOperators in interface FilterFactory

comparisonOperators

public ComparisonOperators comparisonOperators(Operator[] comparisonOperators)
Description copied from interface: FilterFactory
comparison operators

Specified by:
comparisonOperators in interface FilterFactory

capabilities

public FilterCapabilities capabilities(String version,
                                       ScalarCapabilities scalar,
                                       SpatialCapabilities spatial,
                                       IdCapabilities id)
Description copied from interface: FilterFactory
filter capabilities

Specified by:
capabilities in interface FilterFactory

capabilities

public FilterCapabilities capabilities(String version,
                                       ScalarCapabilities scalar,
                                       SpatialCapabilities spatial,
                                       IdCapabilities id,
                                       TemporalCapabilities temporal)
Description copied from interface: FilterFactory
filter capabilities

Specified by:
capabilities in interface FilterFactory

scalarCapabilities

public ScalarCapabilities scalarCapabilities(ComparisonOperators comparison,
                                             ArithmeticOperators arithmetic,
                                             boolean logicalOperators)
Description copied from interface: FilterFactory
scalar capabilities

Specified by:
scalarCapabilities in interface FilterFactory

spatialCapabilities

public SpatialCapabilities spatialCapabilities(GeometryOperand[] geometryOperands,
                                               SpatialOperators spatial)
Description copied from interface: FilterFactory
spatial capabilities

Specified by:
spatialCapabilities in interface FilterFactory

idCapabilities

public IdCapabilities idCapabilities(boolean eid,
                                     boolean fid)
Description copied from interface: FilterFactory
id capabilities

Specified by:
idCapabilities in interface FilterFactory

temporalCapabilities

public TemporalCapabilities temporalCapabilities(TemporalOperator[] temporalOperators)
Description copied from interface: FilterFactory
temporal capabilities

Specified by:
temporalCapabilities in interface FilterFactory


Copyright © 1996-2014 Geotools. All Rights Reserved.