org.geotools.filter
Class FilterFactoryImpl

java.lang.Object
  extended by org.geotools.filter.FilterFactoryImpl
All Implemented Interfaces:
Factory, org.opengis.filter.FilterFactory, org.opengis.filter.FilterFactory2
Direct Known Subclasses:
FilterFactoryImplNamespaceAware

public class FilterFactoryImpl
extends java.lang.Object
implements FilterFactory

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

Version:
$Id: FilterFactoryImpl.java 34797 2010-01-15 09:42:08Z ang05a $
Author:
Ian Turton, CCG

Constructor Summary
FilterFactoryImpl()
          Creates a new instance of FilterFactoryImpl
FilterFactoryImpl(Hints hints)
           
 
Method Summary
 org.opengis.filter.expression.Add add(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2)
           
 org.opengis.filter.And and(org.opengis.filter.Filter f, org.opengis.filter.Filter g)
           
 Filter and(Filter filter1, Filter filter2)
           
 org.opengis.filter.And and(java.util.List filters)
           
 org.opengis.filter.capability.ArithmeticOperators arithmeticOperators(boolean simple, org.opengis.filter.capability.Functions functions)
           
 org.opengis.filter.spatial.BBOX bbox(org.opengis.filter.expression.Expression geometry, org.opengis.geometry.BoundingBox bounds)
           
 org.opengis.filter.spatial.BBOX bbox(org.opengis.filter.expression.Expression e, double minx, double miny, double maxx, double maxy, java.lang.String srs)
          Checks if the geometry expression overlaps the specified bounding box.
 org.opengis.filter.spatial.BBOX bbox(org.opengis.filter.expression.Expression geometry, org.opengis.filter.expression.Expression bounds)
           
 org.opengis.filter.spatial.BBOX bbox(java.lang.String propertyName, double minx, double miny, double maxx, double maxy, java.lang.String srs)
          Checks if the bounding box of the feature's geometry overlaps the specified bounding box.
 org.opengis.filter.PropertyIsBetween between(org.opengis.filter.expression.Expression expr, org.opengis.filter.expression.Expression lower, org.opengis.filter.expression.Expression upper)
           
 org.opengis.filter.spatial.Beyond beyond(org.opengis.filter.expression.Expression geometry1, org.opengis.filter.expression.Expression geometry2, double distance, java.lang.String units)
          Check if all of a geometry is more distant than the given distance from this object's geometry.
 org.opengis.filter.spatial.Beyond beyond(org.opengis.filter.expression.Expression geometry1, org.opengis.geometry.Geometry geometry2, double distance, java.lang.String units)
           
 org.opengis.filter.spatial.Beyond beyond(java.lang.String propertyName, org.opengis.geometry.Geometry geometry, double distance, java.lang.String units)
           
 org.opengis.filter.capability.FilterCapabilities capabilities(java.lang.String version, org.opengis.filter.capability.ScalarCapabilities scalar, org.opengis.filter.capability.SpatialCapabilities spatial, org.opengis.filter.capability.IdCapabilities id)
           
 org.opengis.filter.capability.ComparisonOperators comparisonOperators(org.opengis.filter.capability.Operator[] comparisonOperators)
           
 org.opengis.filter.spatial.Contains contains(org.opengis.filter.expression.Expression geometry1, org.opengis.filter.expression.Expression geometry2)
          Checks if the the first geometric operand contains the second.
 org.opengis.filter.spatial.Contains contains(java.lang.String propertyName, org.opengis.geometry.Geometry geometry)
           
 AttributeExpression createAttributeExpression(org.opengis.feature.type.AttributeDescriptor at)
          Shortcut the process - will only grab values matching AttributeType.
 AttributeExpression createAttributeExpression(org.opengis.feature.simple.SimpleFeatureType schema)
          Creates a Attribute Expression with an initial schema.
 AttributeExpression createAttributeExpression(org.opengis.feature.simple.SimpleFeatureType schema, java.lang.String path)
          Creates a Attribute Expression given a schema and attribute path.
 AttributeExpression createAttributeExpression(java.lang.String xpath)
          Creates an AttributeExpression using the supplied xpath.
 BBoxExpression createBBoxExpression(com.vividsolutions.jts.geom.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(java.lang.String name)
          Creates an Environment Variable
 FidFilter createFidFilter()
          Creates a new Fid Filter with no initial fids.
 FidFilter createFidFilter(java.lang.String fid)
          Creates a Fid Filter with an initial fid.
 FunctionExpression createFunctionExpression(java.lang.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(java.lang.Object o)
          Creates a Literal Expression from an Object.
 LiteralExpression createLiteralExpression(java.lang.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.
 org.opengis.filter.spatial.Crosses crosses(org.opengis.filter.expression.Expression geometry1, org.opengis.filter.expression.Expression geometry2)
          Checks if the first geometric operand crosses the second.
 org.opengis.filter.spatial.Crosses crosses(java.lang.String propertyName, org.opengis.geometry.Geometry geometry)
           
 org.opengis.filter.spatial.Disjoint disjoint(org.opengis.filter.expression.Expression geometry1, org.opengis.filter.expression.Expression geometry2)
          Checks if the first operand is disjoint from the second.
 org.opengis.filter.spatial.Disjoint disjoint(java.lang.String propertyName, org.opengis.geometry.Geometry geometry)
           
 org.opengis.filter.expression.Divide divide(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2)
           
 org.opengis.filter.spatial.DWithin dwithin(org.opengis.filter.expression.Expression geometry1, org.opengis.filter.expression.Expression geometry2, double distance, java.lang.String units)
          Checks if any part of the first geometry lies within the given distance of the second geometry.
 org.opengis.filter.spatial.DWithin dwithin(java.lang.String propertyName, org.opengis.geometry.Geometry geometry, double distance, java.lang.String units)
           
 org.opengis.filter.spatial.Equals equal(org.opengis.filter.expression.Expression geometry1, org.opengis.filter.expression.Expression geometry2)
          Checks if the geometry of the two operands are equal.
 org.opengis.filter.PropertyIsEqualTo equal(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2, boolean matchCase)
           
 org.opengis.filter.PropertyIsEqualTo equals(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2)
           
 org.opengis.filter.spatial.Equals equals(java.lang.String propertyName, org.opengis.geometry.Geometry geometry)
           
 org.opengis.filter.identity.FeatureId featureId(java.lang.String id)
           
 org.opengis.filter.expression.Function function(java.lang.String name, org.opengis.filter.expression.Expression arg1)
           
 org.opengis.filter.expression.Function function(java.lang.String name, org.opengis.filter.expression.Expression[] args)
           
 org.opengis.filter.expression.Function function(java.lang.String name, org.opengis.filter.expression.Expression arg1, org.opengis.filter.expression.Expression arg2)
           
 org.opengis.filter.expression.Function function(java.lang.String name, org.opengis.filter.expression.Expression arg1, org.opengis.filter.expression.Expression arg2, org.opengis.filter.expression.Expression arg3)
           
 org.opengis.filter.expression.Function function(java.lang.String name, java.util.List<org.opengis.filter.expression.Expression> parameters, org.opengis.filter.expression.Literal fallback)
          Deprecated. Pending see org.opengis.filter.Factory2
 org.opengis.filter.capability.FunctionName functionName(java.lang.String name, int nargs)
           
 org.opengis.filter.capability.Functions functions(org.opengis.filter.capability.FunctionName[] functionNames)
           
 java.util.Map getImplementationHints()
          Map of hints (maybe unmodifiable) used by this factory to customize its use.
 org.opengis.filter.identity.GmlObjectId gmlObjectId(java.lang.String id)
           
 org.opengis.filter.PropertyIsGreaterThan greater(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2)
           
 org.opengis.filter.PropertyIsGreaterThan greater(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2, boolean matchCase)
           
 org.opengis.filter.PropertyIsGreaterThanOrEqualTo greaterOrEqual(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2)
           
 org.opengis.filter.PropertyIsGreaterThanOrEqualTo greaterOrEqual(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2, boolean matchCase)
           
 org.opengis.filter.Id id(java.util.Set id)
           
 org.opengis.filter.capability.IdCapabilities idCapabilities(boolean eid, boolean fid)
           
 org.opengis.filter.spatial.Intersects intersects(org.opengis.filter.expression.Expression geometry1, org.opengis.filter.expression.Expression geometry2)
          Checks if the two geometric operands intersect.
 org.opengis.filter.spatial.Intersects intersects(java.lang.String propertyName, org.opengis.geometry.Geometry geometry)
           
 org.opengis.filter.PropertyIsNull isNull(org.opengis.filter.expression.Expression expr)
          XXX Java 5 type narrowing used to make generated class explicit for chaining
 org.opengis.filter.PropertyIsLessThan less(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2)
           
 org.opengis.filter.PropertyIsLessThan less(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2, boolean matchCase)
           
 org.opengis.filter.PropertyIsLessThanOrEqualTo lessOrEqual(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2)
           
 org.opengis.filter.PropertyIsLessThanOrEqualTo lessOrEqual(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2, boolean matchCase)
           
 org.opengis.filter.PropertyIsLike like(org.opengis.filter.expression.Expression expr, java.lang.String pattern)
           
 org.opengis.filter.PropertyIsLike like(org.opengis.filter.expression.Expression expr, java.lang.String pattern, java.lang.String wildcard, java.lang.String singleChar, java.lang.String escape)
           
 org.opengis.filter.PropertyIsLike like(org.opengis.filter.expression.Expression expr, java.lang.String pattern, java.lang.String wildcard, java.lang.String singleChar, java.lang.String escape, boolean matchCase)
           
 org.opengis.filter.expression.Literal literal(boolean b)
           
 org.opengis.filter.expression.Literal literal(byte b)
           
 org.opengis.filter.expression.Literal literal(char c)
           
 org.opengis.filter.expression.Literal literal(double d)
           
 org.opengis.filter.expression.Literal literal(float f)
           
 org.opengis.filter.expression.Literal literal(int i)
           
 org.opengis.filter.expression.Literal literal(long l)
           
 org.opengis.filter.expression.Literal literal(java.lang.Object obj)
           
 org.opengis.filter.expression.Literal literal(short s)
           
 org.opengis.filter.expression.Multiply multiply(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2)
           
 org.opengis.filter.Not not(org.opengis.filter.Filter filter)
          Java 5 type narrowing used to advertise explicit implementation for chaining
 Filter not(Filter filter)
           
 org.opengis.filter.PropertyIsNotEqualTo notEqual(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2)
           
 org.opengis.filter.PropertyIsNotEqualTo notEqual(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2, boolean matchCase)
           
 org.opengis.filter.capability.Operator operator(java.lang.String name)
           
 org.opengis.filter.Or or(org.opengis.filter.Filter f, org.opengis.filter.Filter g)
           
 Filter or(Filter filter1, Filter filter2)
           
 org.opengis.filter.Or or(java.util.List filters)
           
 org.opengis.filter.spatial.Overlaps overlaps(org.opengis.filter.expression.Expression geometry1, org.opengis.filter.expression.Expression geometry2)
          Checks if the interior of the first geometry somewhere overlaps the interior of the second geometry.
 org.opengis.filter.spatial.Overlaps overlaps(java.lang.String propertyName, org.opengis.geometry.Geometry geometry)
           
 org.opengis.filter.expression.PropertyName property(org.opengis.feature.type.Name name)
           
 org.opengis.filter.expression.PropertyName property(java.lang.String name)
           
 org.opengis.filter.capability.ScalarCapabilities scalarCapabilities(org.opengis.filter.capability.ComparisonOperators comparison, org.opengis.filter.capability.ArithmeticOperators arithmetic, boolean logicalOperators)
           
 org.opengis.filter.sort.SortBy sort(java.lang.String propertyName, org.opengis.filter.sort.SortOrder order)
           
 org.opengis.filter.capability.SpatialCapabilities spatialCapabilities(org.opengis.filter.capability.GeometryOperand[] geometryOperands, org.opengis.filter.capability.SpatialOperators spatial)
           
 org.opengis.filter.capability.SpatialOperator spatialOperator(java.lang.String name, org.opengis.filter.capability.GeometryOperand[] geometryOperands)
           
 org.opengis.filter.capability.SpatialOperators spatialOperators(org.opengis.filter.capability.SpatialOperator[] spatialOperators)
           
 org.opengis.filter.expression.Subtract subtract(org.opengis.filter.expression.Expression expr1, org.opengis.filter.expression.Expression expr2)
           
 org.opengis.filter.spatial.Touches touches(org.opengis.filter.expression.Expression geometry1, org.opengis.filter.expression.Expression geometry2)
          Checks if the feature's geometry touches, but does not overlap with the geometry held by this object.
 org.opengis.filter.spatial.Touches touches(java.lang.String propertyName, org.opengis.geometry.Geometry geometry)
           
 org.opengis.filter.spatial.Within within(org.opengis.filter.expression.Expression geometry1, org.opengis.filter.expression.Expression geometry2)
          Checks if the feature's geometry is completely contained by the specified constant geometry.
 org.opengis.filter.spatial.Within within(org.opengis.filter.expression.Expression geometry1, org.opengis.geometry.Geometry geometry2)
           
 org.opengis.filter.spatial.Within within(java.lang.String propertyName, org.opengis.geometry.Geometry geometry)
           
 
Methods inherited from class java.lang.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 org.opengis.filter.identity.FeatureId featureId(java.lang.String id)
Specified by:
featureId in interface org.opengis.filter.FilterFactory

gmlObjectId

public org.opengis.filter.identity.GmlObjectId gmlObjectId(java.lang.String id)
Specified by:
gmlObjectId in interface org.opengis.filter.FilterFactory

and

public org.opengis.filter.And and(org.opengis.filter.Filter f,
                                  org.opengis.filter.Filter g)
Specified by:
and in interface org.opengis.filter.FilterFactory

and

public org.opengis.filter.And and(java.util.List filters)
Specified by:
and in interface org.opengis.filter.FilterFactory

or

public org.opengis.filter.Or or(org.opengis.filter.Filter f,
                                org.opengis.filter.Filter g)
Specified by:
or in interface org.opengis.filter.FilterFactory

or

public org.opengis.filter.Or or(java.util.List filters)
Specified by:
or in interface org.opengis.filter.FilterFactory

not

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

Specified by:
not in interface org.opengis.filter.FilterFactory

id

public org.opengis.filter.Id id(java.util.Set id)
Specified by:
id in interface org.opengis.filter.FilterFactory

property

public org.opengis.filter.expression.PropertyName property(java.lang.String name)
Specified by:
property in interface org.opengis.filter.FilterFactory

between

public org.opengis.filter.PropertyIsBetween between(org.opengis.filter.expression.Expression expr,
                                                    org.opengis.filter.expression.Expression lower,
                                                    org.opengis.filter.expression.Expression upper)
Specified by:
between in interface org.opengis.filter.FilterFactory

equals

public org.opengis.filter.PropertyIsEqualTo equals(org.opengis.filter.expression.Expression expr1,
                                                   org.opengis.filter.expression.Expression expr2)
Specified by:
equals in interface org.opengis.filter.FilterFactory

equal

public org.opengis.filter.PropertyIsEqualTo equal(org.opengis.filter.expression.Expression expr1,
                                                  org.opengis.filter.expression.Expression expr2,
                                                  boolean matchCase)
Specified by:
equal in interface org.opengis.filter.FilterFactory

notEqual

public org.opengis.filter.PropertyIsNotEqualTo notEqual(org.opengis.filter.expression.Expression expr1,
                                                        org.opengis.filter.expression.Expression expr2)
Specified by:
notEqual in interface org.opengis.filter.FilterFactory

notEqual

public org.opengis.filter.PropertyIsNotEqualTo notEqual(org.opengis.filter.expression.Expression expr1,
                                                        org.opengis.filter.expression.Expression expr2,
                                                        boolean matchCase)
Specified by:
notEqual in interface org.opengis.filter.FilterFactory

greater

public org.opengis.filter.PropertyIsGreaterThan greater(org.opengis.filter.expression.Expression expr1,
                                                        org.opengis.filter.expression.Expression expr2)
Specified by:
greater in interface org.opengis.filter.FilterFactory

greater

public org.opengis.filter.PropertyIsGreaterThan greater(org.opengis.filter.expression.Expression expr1,
                                                        org.opengis.filter.expression.Expression expr2,
                                                        boolean matchCase)
Specified by:
greater in interface org.opengis.filter.FilterFactory

greaterOrEqual

public org.opengis.filter.PropertyIsGreaterThanOrEqualTo greaterOrEqual(org.opengis.filter.expression.Expression expr1,
                                                                        org.opengis.filter.expression.Expression expr2)
Specified by:
greaterOrEqual in interface org.opengis.filter.FilterFactory

greaterOrEqual

public org.opengis.filter.PropertyIsGreaterThanOrEqualTo greaterOrEqual(org.opengis.filter.expression.Expression expr1,
                                                                        org.opengis.filter.expression.Expression expr2,
                                                                        boolean matchCase)
Specified by:
greaterOrEqual in interface org.opengis.filter.FilterFactory

less

public org.opengis.filter.PropertyIsLessThan less(org.opengis.filter.expression.Expression expr1,
                                                  org.opengis.filter.expression.Expression expr2)
Specified by:
less in interface org.opengis.filter.FilterFactory

less

public org.opengis.filter.PropertyIsLessThan less(org.opengis.filter.expression.Expression expr1,
                                                  org.opengis.filter.expression.Expression expr2,
                                                  boolean matchCase)
Specified by:
less in interface org.opengis.filter.FilterFactory

lessOrEqual

public org.opengis.filter.PropertyIsLessThanOrEqualTo lessOrEqual(org.opengis.filter.expression.Expression expr1,
                                                                  org.opengis.filter.expression.Expression expr2)
Specified by:
lessOrEqual in interface org.opengis.filter.FilterFactory

lessOrEqual

public org.opengis.filter.PropertyIsLessThanOrEqualTo lessOrEqual(org.opengis.filter.expression.Expression expr1,
                                                                  org.opengis.filter.expression.Expression expr2,
                                                                  boolean matchCase)
Specified by:
lessOrEqual in interface org.opengis.filter.FilterFactory

like

public org.opengis.filter.PropertyIsLike like(org.opengis.filter.expression.Expression expr,
                                              java.lang.String pattern)
Specified by:
like in interface org.opengis.filter.FilterFactory

like

public org.opengis.filter.PropertyIsLike like(org.opengis.filter.expression.Expression expr,
                                              java.lang.String pattern,
                                              java.lang.String wildcard,
                                              java.lang.String singleChar,
                                              java.lang.String escape)
Specified by:
like in interface org.opengis.filter.FilterFactory

like

public org.opengis.filter.PropertyIsLike like(org.opengis.filter.expression.Expression expr,
                                              java.lang.String pattern,
                                              java.lang.String wildcard,
                                              java.lang.String singleChar,
                                              java.lang.String escape,
                                              boolean matchCase)
Specified by:
like in interface org.opengis.filter.FilterFactory
Specified by:
like in interface org.opengis.filter.FilterFactory2

isNull

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

Specified by:
isNull in interface org.opengis.filter.FilterFactory

bbox

public org.opengis.filter.spatial.BBOX bbox(java.lang.String propertyName,
                                            double minx,
                                            double miny,
                                            double maxx,
                                            double maxy,
                                            java.lang.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 org.opengis.filter.FilterFactory

bbox

public org.opengis.filter.spatial.BBOX bbox(org.opengis.filter.expression.Expression geometry,
                                            org.opengis.filter.expression.Expression bounds)

bbox

public org.opengis.filter.spatial.BBOX bbox(org.opengis.filter.expression.Expression geometry,
                                            org.opengis.geometry.BoundingBox bounds)
Specified by:
bbox in interface org.opengis.filter.FilterFactory2

bbox

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

Specified by:
bbox in interface org.opengis.filter.FilterFactory2

beyond

public org.opengis.filter.spatial.Beyond beyond(java.lang.String propertyName,
                                                org.opengis.geometry.Geometry geometry,
                                                double distance,
                                                java.lang.String units)
Specified by:
beyond in interface org.opengis.filter.FilterFactory

beyond

public org.opengis.filter.spatial.Beyond beyond(org.opengis.filter.expression.Expression geometry1,
                                                org.opengis.filter.expression.Expression geometry2,
                                                double distance,
                                                java.lang.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 org.opengis.filter.FilterFactory2

contains

public org.opengis.filter.spatial.Contains contains(java.lang.String propertyName,
                                                    org.opengis.geometry.Geometry geometry)
Specified by:
contains in interface org.opengis.filter.FilterFactory

contains

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

Specified by:
contains in interface org.opengis.filter.FilterFactory2

crosses

public org.opengis.filter.spatial.Crosses crosses(java.lang.String propertyName,
                                                  org.opengis.geometry.Geometry geometry)
Specified by:
crosses in interface org.opengis.filter.FilterFactory

crosses

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

Specified by:
crosses in interface org.opengis.filter.FilterFactory2

disjoint

public org.opengis.filter.spatial.Disjoint disjoint(java.lang.String propertyName,
                                                    org.opengis.geometry.Geometry geometry)
Specified by:
disjoint in interface org.opengis.filter.FilterFactory

disjoint

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

Specified by:
disjoint in interface org.opengis.filter.FilterFactory2

dwithin

public org.opengis.filter.spatial.DWithin dwithin(java.lang.String propertyName,
                                                  org.opengis.geometry.Geometry geometry,
                                                  double distance,
                                                  java.lang.String units)
Specified by:
dwithin in interface org.opengis.filter.FilterFactory

dwithin

public org.opengis.filter.spatial.DWithin dwithin(org.opengis.filter.expression.Expression geometry1,
                                                  org.opengis.filter.expression.Expression geometry2,
                                                  double distance,
                                                  java.lang.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 org.opengis.filter.FilterFactory2

equals

public org.opengis.filter.spatial.Equals equals(java.lang.String propertyName,
                                                org.opengis.geometry.Geometry geometry)
Specified by:
equals in interface org.opengis.filter.FilterFactory

equal

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

Specified by:
equal in interface org.opengis.filter.FilterFactory2

intersects

public org.opengis.filter.spatial.Intersects intersects(java.lang.String propertyName,
                                                        org.opengis.geometry.Geometry geometry)
Specified by:
intersects in interface org.opengis.filter.FilterFactory

intersects

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

Specified by:
intersects in interface org.opengis.filter.FilterFactory2

overlaps

public org.opengis.filter.spatial.Overlaps overlaps(java.lang.String propertyName,
                                                    org.opengis.geometry.Geometry geometry)
Specified by:
overlaps in interface org.opengis.filter.FilterFactory

overlaps

public org.opengis.filter.spatial.Overlaps overlaps(org.opengis.filter.expression.Expression geometry1,
                                                    org.opengis.filter.expression.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 org.opengis.filter.FilterFactory2

touches

public org.opengis.filter.spatial.Touches touches(java.lang.String propertyName,
                                                  org.opengis.geometry.Geometry geometry)
Specified by:
touches in interface org.opengis.filter.FilterFactory

touches

public org.opengis.filter.spatial.Touches touches(org.opengis.filter.expression.Expression geometry1,
                                                  org.opengis.filter.expression.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 org.opengis.filter.FilterFactory2

within

public org.opengis.filter.spatial.Within within(java.lang.String propertyName,
                                                org.opengis.geometry.Geometry geometry)
Specified by:
within in interface org.opengis.filter.FilterFactory

within

public org.opengis.filter.spatial.Within within(org.opengis.filter.expression.Expression geometry1,
                                                org.opengis.filter.expression.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 org.opengis.filter.FilterFactory2

add

public org.opengis.filter.expression.Add add(org.opengis.filter.expression.Expression expr1,
                                             org.opengis.filter.expression.Expression expr2)
Specified by:
add in interface org.opengis.filter.FilterFactory

divide

public org.opengis.filter.expression.Divide divide(org.opengis.filter.expression.Expression expr1,
                                                   org.opengis.filter.expression.Expression expr2)
Specified by:
divide in interface org.opengis.filter.FilterFactory

multiply

public org.opengis.filter.expression.Multiply multiply(org.opengis.filter.expression.Expression expr1,
                                                       org.opengis.filter.expression.Expression expr2)
Specified by:
multiply in interface org.opengis.filter.FilterFactory

subtract

public org.opengis.filter.expression.Subtract subtract(org.opengis.filter.expression.Expression expr1,
                                                       org.opengis.filter.expression.Expression expr2)
Specified by:
subtract in interface org.opengis.filter.FilterFactory

function

public org.opengis.filter.expression.Function function(java.lang.String name,
                                                       org.opengis.filter.expression.Expression[] args)
Specified by:
function in interface org.opengis.filter.FilterFactory

function

public org.opengis.filter.expression.Function function(java.lang.String name,
                                                       org.opengis.filter.expression.Expression arg1)

function

public org.opengis.filter.expression.Function function(java.lang.String name,
                                                       org.opengis.filter.expression.Expression arg1,
                                                       org.opengis.filter.expression.Expression arg2)

function

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


function

public org.opengis.filter.expression.Function function(java.lang.String name,
                                                       org.opengis.filter.expression.Expression arg1,
                                                       org.opengis.filter.expression.Expression arg2,
                                                       org.opengis.filter.expression.Expression arg3)

literal

public org.opengis.filter.expression.Literal literal(java.lang.Object obj)
Specified by:
literal in interface org.opengis.filter.FilterFactory

literal

public org.opengis.filter.expression.Literal literal(byte b)
Specified by:
literal in interface org.opengis.filter.FilterFactory

literal

public org.opengis.filter.expression.Literal literal(short s)
Specified by:
literal in interface org.opengis.filter.FilterFactory

literal

public org.opengis.filter.expression.Literal literal(int i)
Specified by:
literal in interface org.opengis.filter.FilterFactory

literal

public org.opengis.filter.expression.Literal literal(long l)
Specified by:
literal in interface org.opengis.filter.FilterFactory

literal

public org.opengis.filter.expression.Literal literal(float f)
Specified by:
literal in interface org.opengis.filter.FilterFactory

literal

public org.opengis.filter.expression.Literal literal(double d)
Specified by:
literal in interface org.opengis.filter.FilterFactory

literal

public org.opengis.filter.expression.Literal literal(char c)
Specified by:
literal in interface org.opengis.filter.FilterFactory

literal

public org.opengis.filter.expression.Literal literal(boolean b)
Specified by:
literal in interface org.opengis.filter.FilterFactory

createAttributeExpression

public AttributeExpression createAttributeExpression(java.lang.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(org.opengis.feature.simple.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(org.opengis.feature.simple.SimpleFeatureType schema,
                                                     java.lang.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(org.opengis.feature.type.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(com.vividsolutions.jts.geom.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String name)
Description copied from interface: FilterFactory
Creates an Environment Variable

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

getImplementationHints

public java.util.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 org.opengis.filter.sort.SortBy sort(java.lang.String propertyName,
                                           org.opengis.filter.sort.SortOrder order)
Specified by:
sort in interface org.opengis.filter.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 org.opengis.filter.spatial.Beyond beyond(org.opengis.filter.expression.Expression geometry1,
                                                org.opengis.geometry.Geometry geometry2,
                                                double distance,
                                                java.lang.String units)

property

public org.opengis.filter.expression.PropertyName property(org.opengis.feature.type.Name name)
Specified by:
property in interface org.opengis.filter.FilterFactory2

within

public org.opengis.filter.spatial.Within within(org.opengis.filter.expression.Expression geometry1,
                                                org.opengis.geometry.Geometry geometry2)

operator

public org.opengis.filter.capability.Operator operator(java.lang.String name)
Specified by:
operator in interface org.opengis.filter.FilterFactory

spatialOperator

public org.opengis.filter.capability.SpatialOperator spatialOperator(java.lang.String name,
                                                                     org.opengis.filter.capability.GeometryOperand[] geometryOperands)
Specified by:
spatialOperator in interface org.opengis.filter.FilterFactory

functionName

public org.opengis.filter.capability.FunctionName functionName(java.lang.String name,
                                                               int nargs)
Specified by:
functionName in interface org.opengis.filter.FilterFactory

functions

public org.opengis.filter.capability.Functions functions(org.opengis.filter.capability.FunctionName[] functionNames)
Specified by:
functions in interface org.opengis.filter.FilterFactory

spatialOperators

public org.opengis.filter.capability.SpatialOperators spatialOperators(org.opengis.filter.capability.SpatialOperator[] spatialOperators)
Specified by:
spatialOperators in interface org.opengis.filter.FilterFactory

arithmeticOperators

public org.opengis.filter.capability.ArithmeticOperators arithmeticOperators(boolean simple,
                                                                             org.opengis.filter.capability.Functions functions)
Specified by:
arithmeticOperators in interface org.opengis.filter.FilterFactory

comparisonOperators

public org.opengis.filter.capability.ComparisonOperators comparisonOperators(org.opengis.filter.capability.Operator[] comparisonOperators)
Specified by:
comparisonOperators in interface org.opengis.filter.FilterFactory

capabilities

public org.opengis.filter.capability.FilterCapabilities capabilities(java.lang.String version,
                                                                     org.opengis.filter.capability.ScalarCapabilities scalar,
                                                                     org.opengis.filter.capability.SpatialCapabilities spatial,
                                                                     org.opengis.filter.capability.IdCapabilities id)
Specified by:
capabilities in interface org.opengis.filter.FilterFactory

scalarCapabilities

public org.opengis.filter.capability.ScalarCapabilities scalarCapabilities(org.opengis.filter.capability.ComparisonOperators comparison,
                                                                           org.opengis.filter.capability.ArithmeticOperators arithmetic,
                                                                           boolean logicalOperators)
Specified by:
scalarCapabilities in interface org.opengis.filter.FilterFactory

spatialCapabilities

public org.opengis.filter.capability.SpatialCapabilities spatialCapabilities(org.opengis.filter.capability.GeometryOperand[] geometryOperands,
                                                                             org.opengis.filter.capability.SpatialOperators spatial)
Specified by:
spatialCapabilities in interface org.opengis.filter.FilterFactory

idCapabilities

public org.opengis.filter.capability.IdCapabilities idCapabilities(boolean eid,
                                                                   boolean fid)
Specified by:
idCapabilities in interface org.opengis.filter.FilterFactory


Copyright © 1996-2010 Geotools. All Rights Reserved.