Package org.geotools.api.filter

Interface FilterVisitor

All Known Implementing Classes:

AbstractFilterToMongo, AbstractFilterVisitor, AbstractFinderFilterVisitor, AbstractSearchFilterVisitor, BBOXExpandingFilterVisitor, BindingFilterVisitor, CapabilitiesFilterSplitter, CollectionFeatureMemberFilterVisitor, ComplexFilterSplitter, DB2FilterToSQL, DefaultCRSFilterVisitor, DefaultFilterVisitor, DuplicatingFilterVisitor, ExtractBoundsFilterVisitor, FilterAttributeExtractor, FilterCompliancePreProcessor, FilterEncodingPreProcessor, FilterToCQL2Json, FilterToMongo, FilterToSQL, FilterTransformer.FilterTranslator, FilterVisitorSupport, FixBBOXFilterVisitor, GeometryDefaulter, GeometryTransformationVisitor, GeoPkgFilterToSQL, H2FilterToSQL, H2GISFilterToSQL, H2GISPSFilterToSql, HanaFilterToSQL, IdCollectorFilterVisitor, IdFinderFilterVisitor, IndexCombinedFilterTransformerVisitor, IndexedFilterDetectorVisitor, IndexUnmappingVisitor, InformixFilterToSQL, InvertAxisFilterVisitor, IsFullySupportedFilterVisitor, IsSupportedFilterVisitor, JdbcMultipleValueEncoder, JoinInfo.JoinQualifier, JsonPointerFilterSplittingVisitor, LiteralDemultiplyingFilterVisitor, MetaBufferEstimator, MongoFilterSplitter, MultipleValueExtractor, MySQLFilterToSQL, NamespaceAwareAttributeRenameVisitor, NestedFilterToSQL, NullFilterVisitor, OperatorNameFilterVisitor, OracleFilterToSQL, PostgisFilterToSQL, PostgisPSFilterToSql, PostPreProcessFilterSplittingVisitor, PreparedFilterToSQL, PropertyNameResolvingVisitor, ReprojectingFilterVisitor, SchemaIndexedFilterDetectorVisitor, SimplifyingFilterVisitor, SpatialFilterVisitor, SQLServerFilterToSQL, StyleAttributeExtractor, StyleAttributeExtractorTruncated, TemporalFilterVisitor, TeradataFilterToSQL, TimeRangeVisitor, UnmappingFilterVisitor, Utils.BBOXFilterExtractor, VectorMosaicPostPreFilterSplitter

public interface FilterVisitor

Visitor with visit methods to be called by Filter.accept(...).

Consider: It is unclear if this visitor should be applied directly to Filter, or should be walked accross the data structure by hand. The standard complient structure is well defined, and this should negate the need for a formal visitor (we don't have internal structure we are hiding).

There is still a very valid use for FilterVisitor, a instance may implement both FilterVisitor and ExpressionVisitor and ExpressionVisitory in one direction, and a FilterVisitor and a StyleVisitor in the other. The ability to directly focus on transforming data within a larger structure is something a normal data walk can not accomplish in a scalable manner.

Since:

GeoAPI 2.0

Author:

Chris Dillard (SYS Technologies)

Method Summary

Modifier and Type	Method	Description
Object	visit(And filter, Object extraData)
Object	visit(ExcludeFilter filter, Object extraData)	Visit Filter.EXCLUDE (often used during data structure transformations).
Object	visit(Id filter, Object extraData)
Object	visit(IncludeFilter filter, Object extraData)	Visit Filter.INCLUDE (often used during data structure transformations).
default Object	visit(NativeFilter nativeFilter, Object extraData)
Object	visit(Not filter, Object extraData)
Object	visit(Or filter, Object extraData)
Object	visit(PropertyIsBetween filter, Object extraData)
Object	visit(PropertyIsEqualTo filter, Object extraData)
Object	visit(PropertyIsGreaterThanOrEqualTo filter, Object extraData)
Object	visit(PropertyIsGreaterThan filter, Object extraData)
Object	visit(PropertyIsLessThanOrEqualTo filter, Object extraData)
Object	visit(PropertyIsLessThan filter, Object extraData)
Object	visit(PropertyIsLike filter, Object extraData)
Object	visit(PropertyIsNil filter, Object extraData)
Object	visit(PropertyIsNotEqualTo filter, Object extraData)
Object	visit(PropertyIsNull filter, Object extraData)
Object	visit(BBOX filter, Object extraData)
Object	visit(Beyond filter, Object extraData)
Object	visit(Contains filter, Object extraData)
Object	visit(Crosses filter, Object extraData)
Object	visit(Disjoint filter, Object extraData)
Object	visit(DWithin filter, Object extraData)
Object	visit(Equals filter, Object extraData)
Object	visit(Intersects filter, Object extraData)
Object	visit(Overlaps filter, Object extraData)
Object	visit(Touches filter, Object extraData)
Object	visit(Within filter, Object extraData)
Object	visit(After after, Object extraData)
Object	visit(AnyInteracts anyInteracts, Object extraData)
Object	visit(Before before, Object extraData)
Object	visit(Begins begins, Object extraData)
Object	visit(BegunBy begunBy, Object extraData)
Object	visit(During during, Object extraData)
Object	visit(EndedBy endedBy, Object extraData)
Object	visit(Ends ends, Object extraData)
Object	visit(Meets meets, Object extraData)
Object	visit(MetBy metBy, Object extraData)
Object	visit(OverlappedBy overlappedBy, Object extraData)
Object	visit(TContains contains, Object extraData)
Object	visit(TEquals equals, Object extraData)
Object	visit(TOverlaps contains, Object extraData)
Object	visitNullFilter(Object extraData)	Used to account for a null filter value.

Method Detail

visitNullFilter

Object visitNullFilter(Object extraData)

Used to account for a null filter value.

This is particularly used during data structure transofrmations, however the use of null is not recommended. Please make use of Filter.NONE and Filter.ALL as placeholder objects that communicate intent.

Parameters:

extraData - Value object provided to visitor

Returns:

subclass defined

visit

Object visit(ExcludeFilter filter,
             Object extraData)

Visit Filter.EXCLUDE (often used during data structure transformations).

Parameters:

filter - Filter.EXCLUDE.

extraData - Value object provided to visitor

Returns:

subclass supplied

visit

Object visit(IncludeFilter filter,
             Object extraData)

Visit Filter.INCLUDE (often used during data structure transformations).

Parameters:

filter - Filter.INCLUDE.

extraData - Value object provided to visitor

Returns:

subclass supplied

visit

Object visit(And filter,
             Object extraData)

visit

Object visit(Id filter,
             Object extraData)

visit

Object visit(Not filter,
             Object extraData)

visit

Object visit(Or filter,
             Object extraData)

visit

Object visit(PropertyIsBetween filter,
             Object extraData)

visit

Object visit(PropertyIsEqualTo filter,
             Object extraData)

visit

Object visit(PropertyIsNotEqualTo filter,
             Object extraData)

visit

Object visit(PropertyIsGreaterThan filter,
             Object extraData)

visit

Object visit(PropertyIsGreaterThanOrEqualTo filter,
             Object extraData)

visit

Object visit(PropertyIsLessThan filter,
             Object extraData)

visit

Object visit(PropertyIsLessThanOrEqualTo filter,
             Object extraData)

visit

Object visit(PropertyIsLike filter,
             Object extraData)

visit

Object visit(PropertyIsNull filter,
             Object extraData)

visit

Object visit(PropertyIsNil filter,
             Object extraData)

visit

Object visit(BBOX filter,
             Object extraData)

visit

Object visit(Beyond filter,
             Object extraData)

visit

Object visit(Contains filter,
             Object extraData)

visit

Object visit(Crosses filter,
             Object extraData)

visit

Object visit(Disjoint filter,
             Object extraData)

visit

Object visit(DWithin filter,
             Object extraData)

visit

Object visit(Equals filter,
             Object extraData)

visit

Object visit(Intersects filter,
             Object extraData)

visit

Object visit(Overlaps filter,
             Object extraData)

visit

Object visit(Touches filter,
             Object extraData)

visit

Object visit(Within filter,
             Object extraData)

visit

Object visit(After after,
             Object extraData)

visit

Object visit(AnyInteracts anyInteracts,
             Object extraData)

visit

Object visit(Before before,
             Object extraData)

visit

Object visit(Begins begins,
             Object extraData)

visit

Object visit(BegunBy begunBy,
             Object extraData)

visit

Object visit(During during,
             Object extraData)

visit

Object visit(EndedBy endedBy,
             Object extraData)

visit

Object visit(Ends ends,
             Object extraData)

visit

Object visit(Meets meets,
             Object extraData)

visit

Object visit(MetBy metBy,
             Object extraData)

visit

Object visit(OverlappedBy overlappedBy,
             Object extraData)

visit

Object visit(TContains contains,
             Object extraData)

visit

Object visit(TEquals equals,
             Object extraData)

visit

Object visit(TOverlaps contains,
             Object extraData)

visit

default Object visit(NativeFilter nativeFilter,
                     Object extraData)