org.locationtech.geowave.core.geotime.util

Class ExtractGeometryFilterVisitor

java.lang.Object

org.geotools.filter.visitor.NullFilterVisitor

org.locationtech.geowave.core.geotime.util.ExtractGeometryFilterVisitor

All Implemented Interfaces:

org.opengis.filter.expression.ExpressionVisitor, org.opengis.filter.FilterVisitor

public class ExtractGeometryFilterVisitor
extends org.geotools.filter.visitor.NullFilterVisitor

This class is used to exact single query geometry and its associated predicate from a CQL expression. There are three possible outcomes based on the extracted results. 1) If CQL expression is simple then we are able to extract query geometry and predicate successfully. 2) If CQL expression combines multiple dissimilar geometric relationships (i.e. "BBOX(geom,...) AND TOUCHES(geom,...)") then we wont be able combine that into a single query geometry and predicate. In which case, we will only return query geometry for the purpose of creating linear constraints and predicate value will be null. However, we are able to combine multiple geometric relationships into one query/predicate if their predicates are same (i.e. "INTERSECTS(geom,...) AND INTERSECTS(geom,...)") 3) In some case, we won't be able to extract query geometry and predicate at all. In that case, we simply return null. This occurs if CQL expression doesn't contain any geometric constraints or CQL expression has non-inclusive filter (i.e. NOT or DISJOINT(...)).

Field Summary

Fields inherited from class org.geotools.filter.visitor.NullFilterVisitor

NULL_VISITOR

Constructor Summary

Constructors

Constructor and Description
ExtractGeometryFilterVisitor(org.opengis.referencing.crs.CoordinateReferenceSystem crs, String attributeOfInterest) This FilterVisitor is stateless - use ExtractGeometryFilterVisitor.BOUNDS_VISITOR.

Method Summary

Modifier and Type	Method and Description
static ExtractGeometryFilterVisitorResult	getConstraints(org.opengis.filter.Filter filter, org.opengis.referencing.crs.CoordinateReferenceSystem crs, String attributeOfInterest)
Object	visit(org.opengis.filter.expression.Add expression, Object data)
Object	visit(org.opengis.filter.And filter, Object data)
Object	visit(org.opengis.filter.spatial.BBOX filter, Object data)
Object	visit(org.opengis.filter.spatial.Beyond filter, Object data)
Object	visit(org.opengis.filter.spatial.Contains filter, Object data)
Object	visit(org.opengis.filter.spatial.Crosses filter, Object data)
Object	visit(org.opengis.filter.spatial.Disjoint filter, Object data)
Object	visit(org.opengis.filter.expression.Divide expression, Object data)
Object	visit(org.opengis.filter.spatial.DWithin filter, Object data)
Object	visit(org.opengis.filter.spatial.Equals filter, Object data)
Object	visit(org.opengis.filter.ExcludeFilter filter, Object data)
Object	visit(org.opengis.filter.expression.Function expression, Object data)
Object	visit(org.opengis.filter.Id filter, Object data)
Object	visit(org.opengis.filter.IncludeFilter filter, Object data)
Object	visit(org.opengis.filter.spatial.Intersects filter, Object data)
Object	visit(org.opengis.filter.expression.Literal expression, Object data) Please note we are only visiting literals involved in spatial operations.
Object	visit(org.opengis.filter.expression.Multiply expression, Object data)
Object	visit(org.opengis.filter.expression.NilExpression expression, Object data)
Object	visit(org.opengis.filter.Not filter, Object data)
Object	visit(org.opengis.filter.Or filter, Object data)
Object	visit(org.opengis.filter.spatial.Overlaps filter, Object data)
Object	visit(org.opengis.filter.PropertyIsBetween filter, Object data)
Object	visit(org.opengis.filter.PropertyIsEqualTo filter, Object data)
Object	visit(org.opengis.filter.PropertyIsGreaterThan filter, Object data)
Object	visit(org.opengis.filter.PropertyIsGreaterThanOrEqualTo filter, Object data)
Object	visit(org.opengis.filter.PropertyIsLessThan filter, Object data)
Object	visit(org.opengis.filter.PropertyIsLessThanOrEqualTo filter, Object data)
Object	visit(org.opengis.filter.PropertyIsLike filter, Object data)
Object	visit(org.opengis.filter.PropertyIsNotEqualTo filter, Object data)
Object	visit(org.opengis.filter.PropertyIsNull filter, Object data)
Object	visit(org.opengis.filter.expression.PropertyName expression, Object data)
Object	visit(org.opengis.filter.expression.Subtract expression, Object data)
Object	visit(org.opengis.filter.spatial.Touches filter, Object data)
Object	visit(org.opengis.filter.spatial.Within filter, Object data)
Object	visitNullFilter(Object data)

Methods inherited from class org.geotools.filter.visitor.NullFilterVisitor

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtractGeometryFilterVisitor

public ExtractGeometryFilterVisitor(org.opengis.referencing.crs.CoordinateReferenceSystem crs,
                                    String attributeOfInterest)

This FilterVisitor is stateless - use ExtractGeometryFilterVisitor.BOUNDS_VISITOR. You may also subclass in order to reuse this functionality in your own FilterVisitor implementation.

Method Detail

getConstraints

public static ExtractGeometryFilterVisitorResult getConstraints(org.opengis.filter.Filter filter,
                                                                org.opengis.referencing.crs.CoordinateReferenceSystem crs,
                                                                String attributeOfInterest)

Parameters:

filter -

crs -

Returns:

null if empty constraint (infinite not supported)

visit

public Object visit(org.opengis.filter.ExcludeFilter filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.IncludeFilter filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.spatial.BBOX filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.expression.Literal expression,
                    Object data)

Please note we are only visiting literals involved in spatial operations.

Specified by:

visit in interface org.opengis.filter.expression.ExpressionVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

Parameters:

expression - hopefully a Geometry or Envelope

data - Incoming BoundingBox (or Envelope or CRS)

Returns:

ReferencedEnvelope updated to reflect literal

visit

public Object visit(org.opengis.filter.And filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.Not filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.Or filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.spatial.Beyond filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.spatial.Contains filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.spatial.Crosses filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.spatial.Disjoint filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.spatial.DWithin filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.spatial.Equals filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.spatial.Intersects filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.spatial.Overlaps filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.spatial.Touches filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.spatial.Within filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.expression.Add expression,
                    Object data)

Specified by:

visit in interface org.opengis.filter.expression.ExpressionVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.expression.Divide expression,
                    Object data)

Specified by:

visit in interface org.opengis.filter.expression.ExpressionVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.expression.Function expression,
                    Object data)

Specified by:

visit in interface org.opengis.filter.expression.ExpressionVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.Id filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.expression.Multiply expression,
                    Object data)

Specified by:

visit in interface org.opengis.filter.expression.ExpressionVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.expression.NilExpression expression,
                    Object data)

Specified by:

visit in interface org.opengis.filter.expression.ExpressionVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.PropertyIsBetween filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.PropertyIsEqualTo filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.PropertyIsGreaterThan filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.PropertyIsGreaterThanOrEqualTo filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.PropertyIsLessThan filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.PropertyIsLessThanOrEqualTo filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.PropertyIsLike filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.PropertyIsNotEqualTo filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.PropertyIsNull filter,
                    Object data)

Specified by:

visit in interface org.opengis.filter.FilterVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.expression.PropertyName expression,
                    Object data)

Specified by:

visit in interface org.opengis.filter.expression.ExpressionVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visit

public Object visit(org.opengis.filter.expression.Subtract expression,
                    Object data)

Specified by:

visit in interface org.opengis.filter.expression.ExpressionVisitor

Overrides:

visit in class org.geotools.filter.visitor.NullFilterVisitor

visitNullFilter

public Object visitNullFilter(Object data)

Specified by:

visitNullFilter in interface org.opengis.filter.FilterVisitor

Overrides:

visitNullFilter in class org.geotools.filter.visitor.NullFilterVisitor