/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2002-2008, Open Source Geospatial Foundation (OSGeo)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.geotools.filter.visitor;
import java.util.Iterator;
import java.util.List;
import org.opengis.filter.And;
import org.opengis.filter.ExcludeFilter;
import org.opengis.filter.Filter;
import org.opengis.filter.FilterVisitor;
import org.opengis.filter.Id;
import org.opengis.filter.IncludeFilter;
import org.opengis.filter.Not;
import org.opengis.filter.Or;
import org.opengis.filter.PropertyIsBetween;
import org.opengis.filter.PropertyIsEqualTo;
import org.opengis.filter.PropertyIsGreaterThan;
import org.opengis.filter.PropertyIsGreaterThanOrEqualTo;
import org.opengis.filter.PropertyIsLessThan;
import org.opengis.filter.PropertyIsLessThanOrEqualTo;
import org.opengis.filter.PropertyIsLike;
import org.opengis.filter.PropertyIsNotEqualTo;
import org.opengis.filter.PropertyIsNull;
import org.opengis.filter.expression.Add;
import org.opengis.filter.expression.Divide;
import org.opengis.filter.expression.Expression;
import org.opengis.filter.expression.ExpressionVisitor;
import org.opengis.filter.expression.Function;
import org.opengis.filter.expression.Literal;
import org.opengis.filter.expression.Multiply;
import org.opengis.filter.expression.NilExpression;
import org.opengis.filter.expression.PropertyName;
import org.opengis.filter.expression.Subtract;
import org.opengis.filter.spatial.BBOX;
import org.opengis.filter.spatial.Beyond;
import org.opengis.filter.spatial.Contains;
import org.opengis.filter.spatial.Crosses;
import org.opengis.filter.spatial.DWithin;
import org.opengis.filter.spatial.Disjoint;
import org.opengis.filter.spatial.Equals;
import org.opengis.filter.spatial.Intersects;
import org.opengis.filter.spatial.Overlaps;
import org.opengis.filter.spatial.Touches;
import org.opengis.filter.spatial.Within;
import org.opengis.filter.temporal.After;
import org.opengis.filter.temporal.AnyInteracts;
import org.opengis.filter.temporal.Before;
import org.opengis.filter.temporal.Begins;
import org.opengis.filter.temporal.BegunBy;
import org.opengis.filter.temporal.During;
import org.opengis.filter.temporal.EndedBy;
import org.opengis.filter.temporal.Ends;
import org.opengis.filter.temporal.Meets;
import org.opengis.filter.temporal.MetBy;
import org.opengis.filter.temporal.OverlappedBy;
import org.opengis.filter.temporal.TContains;
import org.opengis.filter.temporal.TEquals;
import org.opengis.filter.temporal.TOverlaps;
/**
* Abstract implementation of FilterVisitor that simply walks the data structure.
* <p>
* This class implements the full FilterVisitor interface and will visit every Filter 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 Filter type you are interested in. Remember to call the
* super method if you want to ensure that the entire filter tree is still visited.
*
* <pre><code>
* FilterVisitor allFids = new DefaultFilterVisitor(){
* public Object visit( Id filter, Object data ) {
* Set set = (Set) data;
* set.addAll(filter.getIDs());
* return set;
* }
* };
* Set set = (Set) myFilter.accept(allFids, new HashSet());
* </code></pre>
*
* @author Jody
*
*
* @source $URL$
*/
public abstract class DefaultFilterVisitor implements FilterVisitor, ExpressionVisitor {
public DefaultFilterVisitor() {
}
public Object visit( ExcludeFilter filter, Object data ) {
return data;
}
public Object visit( IncludeFilter filter, Object data ) {
return data;
}
public Object visit( And filter, Object data ) {
List<Filter> childList = filter.getChildren();
if (childList != null) {
for( Filter child : childList) {
if( child == null ) continue;
data = child.accept(this, data);
}
}
return data;
}
public Object visit( Id filter, Object data ) {
return data;
}
public Object visit( Not filter, Object data ) {
Filter child = filter.getFilter();
if (child != null) {
data = child.accept(this, data);
}
return data;
}
public Object visit( Or filter, Object data ) {
List<Filter> childList = filter.getChildren();
if (childList != null) {
for( Filter child : childList) {
if( child == null ) continue;
data = child.accept(this, data);
}
}
return data;
}
public Object visit( PropertyIsBetween filter, Object data ) {
data = filter.getLowerBoundary().accept(this, data);
data = filter.getExpression().accept(this, data);
data = filter.getUpperBoundary().accept(this, data);
return data;
}
public Object visit( PropertyIsEqualTo filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( PropertyIsNotEqualTo filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( PropertyIsGreaterThan filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( PropertyIsGreaterThanOrEqualTo filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( PropertyIsLessThan filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( PropertyIsLessThanOrEqualTo filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( PropertyIsLike filter, Object data ) {
data = filter.getExpression().accept(this, data);
return data;
}
public Object visit( PropertyIsNull filter, Object data ) {
data = filter.getExpression().accept(this, data);
return data;
}
public Object visit( final BBOX filter, Object data ) {
data = filter.getExpression1().accept( this, data );
data = filter.getExpression2().accept( this, data );
return data;
}
public Object visit( Beyond filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( Contains filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( Crosses filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( Disjoint filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( DWithin filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( Equals filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( Intersects filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( Overlaps filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( Touches filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visit( Within filter, Object data ) {
data = filter.getExpression1().accept(this, data);
data = filter.getExpression2().accept(this, data);
return data;
}
public Object visitNullFilter( Object data ) {
return data;
}
public Object visit( NilExpression expression, Object data ) {
return data;
}
public Object visit( Add expression, Object data ) {
data = expression.getExpression1().accept( this, data);
data = expression.getExpression2().accept( this, data);
return data;
}
public Object visit( Divide expression, Object data ) {
data = expression.getExpression1().accept( this, data);
data = expression.getExpression2().accept( this, data);
return data;
}
public Object visit( Function expression, Object data ) {
if( expression.getParameters() != null ){
for( Expression parameter : expression.getParameters() ){
data = parameter.accept( this, data);
}
}
return data;
}
public Object visit( Literal expression, Object data ) {
return data;
}
public Object visit( Multiply expression, Object data ) {
data = expression.getExpression1().accept( this, data);
data = expression.getExpression2().accept( this, data);
return data;
}
public Object visit( PropertyName expression, Object data ) {
return data;
}
public Object visit( Subtract expression, Object data ) {
data = expression.getExpression1().accept( this, data);
data = expression.getExpression2().accept( this, data);
return data;
}
public Object visit(After after, Object data) {
data = after.getExpression1().accept(this, data);
data = after.getExpression2().accept(this, data);
return data;
}
public Object visit(AnyInteracts anyInteracts, Object data) {
data = anyInteracts.getExpression1().accept(this, data);
data = anyInteracts.getExpression2().accept(this, data);
return data;
}
public Object visit(Before before, Object data) {
data = before.getExpression1().accept(this, data);
data = before.getExpression2().accept(this, data);
return data;
}
public Object visit(Begins begins, Object data) {
data = begins.getExpression1().accept(this, data);
data = begins.getExpression2().accept(this, data);
return data;
}
public Object visit(BegunBy begunBy, Object data) {
data = begunBy.getExpression1().accept(this, data);
data = begunBy.getExpression2().accept(this, data);
return data;
}
public Object visit(During during, Object data) {
data = during.getExpression1().accept(this, data);
data = during.getExpression2().accept(this, data);
return data;
}
public Object visit(EndedBy endedBy, Object data) {
data = endedBy.getExpression1().accept(this, data);
data = endedBy.getExpression2().accept(this, data);
return data;
}
public Object visit(Ends ends, Object data) {
data = ends.getExpression1().accept(this, data);
data = ends.getExpression2().accept(this, data);
return data;
}
public Object visit(Meets meets, Object data) {
data = meets.getExpression1().accept(this, data);
data = meets.getExpression2().accept(this, data);
return data;
}
public Object visit(MetBy metBy, Object data) {
data = metBy.getExpression1().accept(this, data);
data = metBy.getExpression2().accept(this, data);
return data;
}
public Object visit(OverlappedBy overlappedBy, Object data) {
data = overlappedBy.getExpression1().accept(this, data);
data = overlappedBy.getExpression2().accept(this, data);
return data;
}
public Object visit(TContains contains, Object data) {
data = contains.getExpression1().accept(this, data);
data = contains.getExpression2().accept(this, data);
return data;
}
public Object visit(TEquals equals, Object data) {
data = equals.getExpression1().accept(this, data);
data = equals.getExpression2().accept(this, data);
return data;
}
public Object visit(TOverlaps contains, Object data) {
data = contains.getExpression1().accept(this, data);
data = contains.getExpression2().accept(this, data);
return data;
}
}