org.geotools.filter.visitor
Class AbstractFilterVisitor

java.lang.Object
  extended by org.geotools.filter.visitor.AbstractFilterVisitor
All Implemented Interfaces:
org.opengis.filter.FilterVisitor
Direct Known Subclasses:
BoundsExtractor

Deprecated. Please use DefaultFilterVisitor (to stick with only opengis Filter)

public class AbstractFilterVisitor
extends java.lang.Object
implements FilterVisitor, org.opengis.filter.FilterVisitor

A basic implementation of the FilterVisitor interface.

This class implements the full FilterVisitor interface and will visit every member of a Filter object. This class performs no actions and is not intended to be used directly, instead extend it and overide the methods for the expression types you are interested in. Remember to call the super method if you want to ensure that the entier filter tree is still visited.

You may still need to implement FilterVisitor directly if the visit order set out in this class does not meet your needs. This class visits in sequence i.e. Left - Middle - Right for all expressions which have sub-expressions.

Author:
James Macgill, Penn State, Justin Deoliveira, The Open Planning Project

Constructor Summary
AbstractFilterVisitor()
          Deprecated. Empty constructor
AbstractFilterVisitor(org.opengis.filter.expression.ExpressionVisitor expressionVisitor)
          Deprecated. Constructs the filter visitor with an expression visitor.
 
Method Summary
 java.lang.Object visit(org.opengis.filter.And filter, java.lang.Object data)
          Deprecated. Visits elements of filter.getChildren().
 void visit(AttributeExpression expression)
          Deprecated. Called when accept is called on an attribute expression.
 java.lang.Object visit(org.opengis.filter.spatial.BBOX filter, java.lang.Object data)
          Deprecated. does nothing
 void visit(BetweenFilter filter)
          Deprecated. use visit(PropertyIsBetween, Object)
 java.lang.Object visit(org.opengis.filter.spatial.Beyond filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.
protected  java.lang.Object visit(org.opengis.filter.BinaryComparisonOperator filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.
protected  java.lang.Object visit(org.opengis.filter.BinaryLogicOperator filter, java.lang.Object data)
          Deprecated. Visits elements of filter.getChildren().
protected  java.lang.Object visit(org.opengis.filter.spatial.BinarySpatialOperator filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.
 void visit(CompareFilter filter)
          Deprecated. use one of visit(PropertyIsEqualTo, Object), visit(PropertyIsNotEqualTo, Object), visit(PropertyIsLessThan, Object), visit(PropertyIsLessThanOrEqualTo, Object),visit(PropertyIsGreaterThan, Object), #visit(PropertyIsGreaterThanEqualTo, Object)
 java.lang.Object visit(org.opengis.filter.spatial.Contains filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.
 java.lang.Object visit(org.opengis.filter.spatial.Crosses filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.
 java.lang.Object visit(org.opengis.filter.spatial.Disjoint filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.
 java.lang.Object visit(org.opengis.filter.spatial.DWithin filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.
 java.lang.Object visit(org.opengis.filter.spatial.Equals filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.
 java.lang.Object visit(org.opengis.filter.ExcludeFilter filter, java.lang.Object data)
          Deprecated. Does nothing; will return provided data unmodified.
 void visit(Expression expression)
          Deprecated. This should never be called.
 void visit(FidFilter filter)
          Deprecated. use visit(Id, Object)
 void visit(Filter filter)
          Deprecated.  
 void visit(FunctionExpression expression)
          Deprecated. Called when accept is called on an function expression.
 void visit(GeometryFilter filter)
          Deprecated. Called when accept is called on a Geometry Filter.
 java.lang.Object visit(org.opengis.filter.Id filter, java.lang.Object data)
          Deprecated. Does nothing.
 java.lang.Object visit(org.opengis.filter.IncludeFilter filter, java.lang.Object data)
          Deprecated. Does nothing; will return provided data unmodified.
 java.lang.Object visit(org.opengis.filter.spatial.Intersects filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.
 void visit(LikeFilter filter)
          Deprecated. use visit(PropertyIsLike, Object)
 void visit(LiteralExpression expression)
          Deprecated. Called when accept is called on a literal expression.
 void visit(LogicFilter filter)
          Deprecated. use one of visit(And, Object),visit(Or, Object), visit(Not, Object)
 void visit(MathExpression expression)
          Deprecated. Called when accept is called on an math expression.
 java.lang.Object visit(org.opengis.filter.Not filter, java.lang.Object data)
          Deprecated. Visits filter.getFilter().
 void visit(NullFilter filter)
          Deprecated. use visit(PropertyIsNull, Object)
 java.lang.Object visit(org.opengis.filter.Or filter, java.lang.Object data)
          Deprecated. Visits elements of filter.getChildren().
 java.lang.Object visit(org.opengis.filter.spatial.Overlaps filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.
 java.lang.Object visit(org.opengis.filter.PropertyIsBetween filter, java.lang.Object data)
          Deprecated. Visits filter.getLowerBoundary(),filter.getExpression(),filter.getUpperBoundary() if an expression visitor was set.
 java.lang.Object visit(org.opengis.filter.PropertyIsEqualTo filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.
 java.lang.Object visit(org.opengis.filter.PropertyIsGreaterThan filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.
 java.lang.Object visit(org.opengis.filter.PropertyIsGreaterThanOrEqualTo filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.
 java.lang.Object visit(org.opengis.filter.PropertyIsLessThan filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.
 java.lang.Object visit(org.opengis.filter.PropertyIsLessThanOrEqualTo filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.
 java.lang.Object visit(org.opengis.filter.PropertyIsLike filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression() if an expression visitor was set.
 java.lang.Object visit(org.opengis.filter.PropertyIsNotEqualTo filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.
 java.lang.Object visit(org.opengis.filter.PropertyIsNull filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression() if an expression visitor was set.
 java.lang.Object visit(org.opengis.filter.spatial.Touches filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.
 java.lang.Object visit(org.opengis.filter.spatial.Within filter, java.lang.Object data)
          Deprecated. Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.
 java.lang.Object visitNullFilter(java.lang.Object data)
          Deprecated. Does nothing.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractFilterVisitor

public AbstractFilterVisitor()
Deprecated. 
Empty constructor


AbstractFilterVisitor

public AbstractFilterVisitor(org.opengis.filter.expression.ExpressionVisitor expressionVisitor)
Deprecated. 
Constructs the filter visitor with an expression visitor.

Using this constructor allows expressions of a filter to be visited as well.

Parameters:
expressionVisitor -
Method Detail

visit

public java.lang.Object visit(org.opengis.filter.IncludeFilter filter,
                              java.lang.Object data)
Deprecated. 
Does nothing; will return provided data unmodified.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.ExcludeFilter filter,
                              java.lang.Object data)
Deprecated. 
Does nothing; will return provided data unmodified.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visitNullFilter

public java.lang.Object visitNullFilter(java.lang.Object data)
Deprecated. 
Does nothing.

Specified by:
visitNullFilter in interface org.opengis.filter.FilterVisitor

visit

public void visit(Filter filter)
Deprecated. 

Description copied from interface: FilterVisitor
Called when accept is called on an AbstractFilter. As it is imposible to create an instance of AbstractFilter this should never happen. If it does it means that a subclass of AbstractFilter has failed to implement accept(FilterVisitor) correctly. Implementers of this method should probaly log a warning.

Parameters:
filter - The filter to visit
See Also:
FilterVisitor.visit(org.geotools.filter.Filter)

visit

public void visit(BetweenFilter filter)
Deprecated. use visit(PropertyIsBetween, Object)

Description copied from interface: FilterVisitor
Called when accept is called on a BetweenFilter. Implementers will want to access the left, middle and right expresions.

Parameters:
filter - The filter to visit
See Also:
FilterVisitor.visit(org.geotools.filter.BetweenFilter)

visit

public java.lang.Object visit(org.opengis.filter.PropertyIsBetween filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getLowerBoundary(),filter.getExpression(),filter.getUpperBoundary() if an expression visitor was set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public void visit(CompareFilter filter)
Deprecated. use one of visit(PropertyIsEqualTo, Object), visit(PropertyIsNotEqualTo, Object), visit(PropertyIsLessThan, Object), visit(PropertyIsLessThanOrEqualTo, Object),visit(PropertyIsGreaterThan, Object), #visit(PropertyIsGreaterThanEqualTo, Object)

Description copied from interface: FilterVisitor
Called when accept is called on a Compare Filter. Implementers will want to access the left and right expresions.

Parameters:
filter - The filter to visit
See Also:
FilterVisitor.visit(org.geotools.filter.CompareFilter)

visit

protected java.lang.Object visit(org.opengis.filter.BinaryComparisonOperator filter,
                                 java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.


visit

public java.lang.Object visit(org.opengis.filter.PropertyIsEqualTo filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.PropertyIsNotEqualTo filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.PropertyIsLessThan filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.PropertyIsLessThanOrEqualTo filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.PropertyIsGreaterThan filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.PropertyIsGreaterThanOrEqualTo filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(), and filter.getExpression2() if an expression visitor was set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public void visit(GeometryFilter filter)
Deprecated. 
Description copied from interface: FilterVisitor
Called when accept is called on a Geometry Filter. Implementers will want to access the left and right geometries.

Parameters:
filter - The filter to visit
See Also:
FilterVisitor.visit(org.geotools.filter.GeometryFilter)

visit

public java.lang.Object visit(org.opengis.filter.spatial.BBOX filter,
                              java.lang.Object data)
Deprecated. 
does nothing

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

protected java.lang.Object visit(org.opengis.filter.spatial.BinarySpatialOperator filter,
                                 java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.


visit

public java.lang.Object visit(org.opengis.filter.spatial.Beyond filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.spatial.Contains filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.spatial.Crosses filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.spatial.Disjoint filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.spatial.DWithin filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.spatial.Equals filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.spatial.Intersects filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.spatial.Overlaps filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.spatial.Touches filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.spatial.Within filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression1(),filter.getExpression2() if an expression visitor has been set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public void visit(LikeFilter filter)
Deprecated. use visit(PropertyIsLike, Object)

Description copied from interface: FilterVisitor
Called when accept is called on a Like Filter. Implementers will want to access the pattern and value.

Parameters:
filter - The filter to visit.
See Also:
FilterVisitor.visit(org.geotools.filter.LikeFilter)

visit

public java.lang.Object visit(org.opengis.filter.PropertyIsLike filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression() if an expression visitor was set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public void visit(LogicFilter filter)
Deprecated. use one of visit(And, Object),visit(Or, Object), visit(Not, Object)

Description copied from interface: FilterVisitor
Called when accept is called on a Logic Filter. Implementers will want to access the sub filters.

Parameters:
filter - The filter to visit.
See Also:
FilterVisitor.visit(org.geotools.filter.LogicFilter)

visit

protected java.lang.Object visit(org.opengis.filter.BinaryLogicOperator filter,
                                 java.lang.Object data)
Deprecated. 
Visits elements of filter.getChildren().


visit

public java.lang.Object visit(org.opengis.filter.And filter,
                              java.lang.Object data)
Deprecated. 
Visits elements of filter.getChildren().

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.Or filter,
                              java.lang.Object data)
Deprecated. 
Visits elements of filter.getChildren().

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public java.lang.Object visit(org.opengis.filter.Not filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getFilter().

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public void visit(NullFilter filter)
Deprecated. use visit(PropertyIsNull, Object)

Description copied from interface: FilterVisitor
Called when accept is called on a Null Filter. Implementers will want to access the null check.

Parameters:
filter - The filter to visit.
See Also:
FilterVisitor.visit(org.geotools.filter.NullFilter)

visit

public java.lang.Object visit(org.opengis.filter.PropertyIsNull filter,
                              java.lang.Object data)
Deprecated. 
Visits filter.getExpression() if an expression visitor was set.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public void visit(FidFilter filter)
Deprecated. use visit(Id, Object)

Description copied from interface: FilterVisitor
Called when accept is called on a Fid Filter. Implementers will want to access the fids.

Parameters:
filter - The filter to visit.
See Also:
FilterVisitor.visit(org.geotools.filter.FidFilter)

visit

public java.lang.Object visit(org.opengis.filter.Id filter,
                              java.lang.Object data)
Deprecated. 
Does nothing.

Specified by:
visit in interface org.opengis.filter.FilterVisitor

visit

public void visit(AttributeExpression expression)
Deprecated. 
Description copied from interface: FilterVisitor
Called when accept is called on an attribute expression. Implementors will want to access the attribute.

Parameters:
expression - The expression to visit.
See Also:
FilterVisitor.visit(org.geotools.filter.AttributeExpression)

visit

public void visit(Expression expression)
Deprecated. 
Description copied from interface: FilterVisitor
This should never be called. This can only happen if a subclass of DefaultExpression fails to implement its own version of accept(FilterVisitor);

Parameters:
expression - the expression to visit.
See Also:
FilterVisitor.visit(org.geotools.filter.Expression)

visit

public void visit(LiteralExpression expression)
Deprecated. 
Description copied from interface: FilterVisitor
Called when accept is called on a literal expression. Implementors will want to access the literal.

Parameters:
expression - The expression to visit.
See Also:
FilterVisitor.visit(org.geotools.filter.LiteralExpression)

visit

public void visit(MathExpression expression)
Deprecated. 
Description copied from interface: FilterVisitor
Called when accept is called on an math expression.

Parameters:
expression - The expression to visit.
See Also:
FilterVisitor.visit(org.geotools.filter.MathExpression)

visit

public void visit(FunctionExpression expression)
Deprecated. 
Description copied from interface: FilterVisitor
Called when accept is called on an function expression.

Parameters:
expression - The expression to visit.
See Also:
FilterVisitor.visit(org.geotools.filter.FunctionExpression)


Copyright © 1996-2010 Geotools. All Rights Reserved.