/*
* 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.List;
import java.util.Set;
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.capability.ArithmeticOperators;
import org.opengis.filter.capability.ComparisonOperators;
import org.opengis.filter.capability.FilterCapabilities;
import org.opengis.filter.capability.FunctionName;
import org.opengis.filter.capability.Functions;
import org.opengis.filter.capability.IdCapabilities;
import org.opengis.filter.capability.ScalarCapabilities;
import org.opengis.filter.capability.SpatialCapabilities;
import org.opengis.filter.capability.SpatialOperators;
import org.opengis.filter.expression.Add;
import org.opengis.filter.expression.Divide;
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.identity.FeatureId;
import org.opengis.filter.identity.Identifier;
import org.opengis.filter.identity.ObjectId;
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;
/**
* This visitor will return Boolean.TRUE if the provided filter
* is completely supported by the FilterCapabilities.
* <p>
* This method will look up the right information in the provided
* FilterCapabilities instance for you depending on the type of filter
* provided. It will do a deep structural search of the provided
* filter ensuring every expression and function is accounted for
* and supported by the provided FilterCapabilities.
* <p>
* Example:<pre><code>
* boolean yes = filter.accepts( IsFullySupportedFilterVisitor( capabilities ), null );
* </code></pre>
*
* @author Jody Garnett (Refractions Research)
*
* @source $URL$
*/
public class IsFullySupportedFilterVisitor implements FilterVisitor, ExpressionVisitor {
private FilterCapabilities capabilities;
public IsFullySupportedFilterVisitor( FilterCapabilities capabilities ){
this.capabilities = capabilities;
}
/** INCLUDE and EXCLUDE are never supported */
public Object visit( ExcludeFilter filter, Object extraData ) {
return false;
}
/** INCLUDE and EXCLUDE are never supported */
public Object visit( IncludeFilter filter, Object extraData ) {
return false;
}
public Object visit( And filter, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null || !scalar.hasLogicalOperators() ){
return false;
}
List<Filter> children = filter.getChildren();
if( children == null ) return false;
for( Filter child : children ){
boolean yes = (Boolean) child.accept( this, null );
if( !yes ) return false;
}
return true;
}
public Object visit( Id filter, Object extraData ) {
IdCapabilities idCapabilities = capabilities.getIdCapabilities();
if( idCapabilities == null ) return false;
Set<Identifier> identifiers = filter.getIdentifiers();
if( identifiers == null ) return null;
for (Identifier identifier : identifiers ){
if( identifier instanceof FeatureId &&
capabilities.getIdCapabilities().hasFID() ){
continue;
}
else if( identifier instanceof ObjectId &&
capabilities.getIdCapabilities().hasEID() ){
continue;
}
else {
return false;
}
}
return true;
}
public Object visit( Not filter, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null || !scalar.hasLogicalOperators() ){
return false;
}
return (Boolean) filter.getFilter().accept( this, null );
}
public Object visit( Or filter, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null || !scalar.hasLogicalOperators() ){
return false;
}
List<Filter> children = filter.getChildren();
if( children == null ) return false;
for( Filter child : children ){
boolean yes = (Boolean) child.accept( this, null );
if( !yes ) return false;
}
return true;
}
public Object visit( PropertyIsBetween filter, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ComparisonOperators operators = scalar.getComparisonOperators();
if( operators == null ) return false;
if( operators.getOperator( PropertyIsBetween.NAME ) == null ) return false;
return (Boolean) filter.getLowerBoundary().accept(this, null) &&
(Boolean) filter.getExpression().accept(this, null) &&
(Boolean) filter.getUpperBoundary().accept(this, null);
}
public Object visit( PropertyIsEqualTo filter, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ComparisonOperators operators = scalar.getComparisonOperators();
if( operators == null ) return false;
if( operators.getOperator( PropertyIsEqualTo.NAME ) == null ) return false;
return (Boolean) filter.getExpression1().accept(this,null) &&
(Boolean) filter.getExpression2().accept(this,null);
}
public Object visit( PropertyIsNotEqualTo filter, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ComparisonOperators operators = scalar.getComparisonOperators();
if( operators == null ) return false;
if( operators.getOperator( PropertyIsNotEqualTo.NAME ) == null ) return false;
return (Boolean) filter.getExpression1().accept(this,null) &&
(Boolean) filter.getExpression2().accept(this,null);
}
public Object visit( PropertyIsGreaterThan filter, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ComparisonOperators operators = scalar.getComparisonOperators();
if( operators == null ) return false;
if( operators.getOperator( PropertyIsGreaterThan.NAME ) == null ) return false;
return (Boolean) filter.getExpression1().accept(this,null) &&
(Boolean) filter.getExpression2().accept(this,null);
}
public Object visit( PropertyIsGreaterThanOrEqualTo filter, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ComparisonOperators operators = scalar.getComparisonOperators();
if( operators == null ) return false;
return operators.getOperator( PropertyIsGreaterThanOrEqualTo.NAME ) != null;
}
public Object visit( PropertyIsLessThan filter, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ComparisonOperators operators = scalar.getComparisonOperators();
if( operators == null ) return false;
return operators.getOperator( PropertyIsLessThan.NAME ) != null;
}
public Object visit( PropertyIsLessThanOrEqualTo filter, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ComparisonOperators operators = scalar.getComparisonOperators();
if( operators == null ) return false;
return operators.getOperator( PropertyIsLessThanOrEqualTo.NAME ) != null;
}
public Object visit( PropertyIsLike filter, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ComparisonOperators operators = scalar.getComparisonOperators();
if( operators == null ) return false;
return operators.getOperator( PropertyIsLike.NAME ) != null;
}
public Object visit( PropertyIsNull filter, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ComparisonOperators operators = scalar.getComparisonOperators();
if( operators == null ) return false;
return operators.getOperator( PropertyIsNull.NAME ) != null;
}
public Object visit( BBOX filter, Object extraData ) {
SpatialCapabilities spatial = capabilities.getSpatialCapabilities();
if( spatial == null ) return false;
SpatialOperators operators = spatial.getSpatialOperators();
if( operators == null ) return false;
return operators.getOperator( BBOX.NAME ) != null;
}
public Object visit( Beyond filter, Object extraData ) {
SpatialCapabilities spatial = capabilities.getSpatialCapabilities();
if( spatial == null ) return false;
SpatialOperators operators = spatial.getSpatialOperators();
if( operators == null ) return false;
return operators.getOperator( Beyond.NAME ) != null;
}
public Object visit( Contains filter, Object extraData ) {
SpatialCapabilities spatial = capabilities.getSpatialCapabilities();
if( spatial == null ) return false;
SpatialOperators operators = spatial.getSpatialOperators();
if( operators == null ) return false;
return operators.getOperator( Contains.NAME ) != null;
}
public Object visit( Crosses filter, Object extraData ) {
SpatialCapabilities spatial = capabilities.getSpatialCapabilities();
if( spatial == null ) return false;
SpatialOperators operators = spatial.getSpatialOperators();
if( operators == null ) return false;
return operators.getOperator( Crosses.NAME ) != null;
}
public Object visit( Disjoint filter, Object extraData ) {
SpatialCapabilities spatial = capabilities.getSpatialCapabilities();
if( spatial == null ) return false;
SpatialOperators operators = spatial.getSpatialOperators();
if( operators == null ) return false;
return operators.getOperator( Disjoint.NAME ) != null;
}
public Object visit( DWithin filter, Object extraData ) {
SpatialCapabilities spatial = capabilities.getSpatialCapabilities();
if( spatial == null ) return false;
SpatialOperators operators = spatial.getSpatialOperators();
if( operators == null ) return false;
return operators.getOperator( DWithin.NAME ) != null;
}
public Object visit( Equals filter, Object extraData ) {
SpatialCapabilities spatial = capabilities.getSpatialCapabilities();
if( spatial == null ) return false;
SpatialOperators operators = spatial.getSpatialOperators();
if( operators == null ) return false;
return operators.getOperator( Equals.NAME ) != null;
}
public Object visit( Intersects filter, Object extraData ) {
SpatialCapabilities spatial = capabilities.getSpatialCapabilities();
if( spatial == null ) return false;
SpatialOperators operators = spatial.getSpatialOperators();
if( operators == null ) return false;
return operators.getOperator( Intersects.NAME ) != null;
}
public Object visit( Overlaps filter, Object extraData ) {
SpatialCapabilities spatial = capabilities.getSpatialCapabilities();
if( spatial == null ) return false;
SpatialOperators operators = spatial.getSpatialOperators();
if( operators == null ) return false;
return operators.getOperator( Overlaps.NAME ) != null;
}
public Object visit( Touches filter, Object extraData ) {
SpatialCapabilities spatial = capabilities.getSpatialCapabilities();
if( spatial == null ) return false;
SpatialOperators operators = spatial.getSpatialOperators();
if( operators == null ) return false;
return operators.getOperator( Touches.NAME ) != null;
}
public Object visit( Within filter, Object extraData ) {
SpatialCapabilities spatial = capabilities.getSpatialCapabilities();
if( spatial == null ) return false;
SpatialOperators operators = spatial.getSpatialOperators();
if( operators == null ) return false;
return operators.getOperator( Within.NAME ) != null;
}
public Object visitNullFilter( Object extraData ) {
return false;
}
//
// Expressions
//
/** NilExpression is a placeholder and is never supported */
public Object visit( NilExpression expression, Object extraData ) {
return false;
}
public Object visit( Add expression, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ArithmeticOperators operators = scalar.getArithmeticOperators();
if( operators == null ) return false;
return operators.hasSimpleArithmetic();
}
public Object visit( Divide expression, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ArithmeticOperators operators = scalar.getArithmeticOperators();
if( operators == null ) return false;
return operators.hasSimpleArithmetic();
}
public Object visit( Function function, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ArithmeticOperators operators = scalar.getArithmeticOperators();
if( operators == null ) return false;
Functions functions = operators.getFunctions();
if( functions == null ) return false;
// Note that only function name is checked here
FunctionName found = functions.getFunctionName( function.getName() );
// And that's enough to assess if the function is supported
return found != null;
}
public Object visit( Literal expression, Object extraData ) {
return true;
}
public Object visit( Multiply expression, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ArithmeticOperators operators = scalar.getArithmeticOperators();
if( operators == null ) return false;
return operators.hasSimpleArithmetic();
}
/**
* You can override this to perform a sanity check against a provided
* FeatureType.
*/
public Object visit( PropertyName expression, Object extraData ) {
return true;
}
public Object visit( Subtract expression, Object extraData ) {
ScalarCapabilities scalar = capabilities.getScalarCapabilities();
if( scalar == null ) return false;
ArithmeticOperators operators = scalar.getArithmeticOperators();
if( operators == null ) return false;
return operators.hasSimpleArithmetic();
}
}