/* * GeoTools - The Open Source Java GIS Toolkit * http://geotools.org * * (C) 2006-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.text.cql2; import java.io.BufferedReader; import java.io.IOException; import java.io.InputStreamReader; import java.util.List; import javax.xml.transform.TransformerException; import org.geotools.filter.FilterTransformer; import org.geotools.filter.text.commons.CompilerUtil; import org.opengis.filter.Filter; import org.opengis.filter.FilterFactory; import org.opengis.filter.expression.Expression; /** * Utility class to parse CQL predicates and expressions to GeoAPI * {@link Filter}s and {@link Expression}s, respectively. * *
* CQL is an acronym for OGC Common Query Language, a query predicate * language whose syntax is similar to a SQL WHERE clause, defined in clause * 6.2.2 of the OGC Catalog Service for Web, version 2.0.1 implementation * specification. *
** This class provides three methods, {@link #toFilter(String)}, * {@link #toExpression(String)} and {@link #toFilterList(String)}; and an * overloaded version of each one for the user to provide a * {@link FilterFactory} implementation to use. *
**
*
* Filter f = CQL.toFilter("ATTR1 < 10 AND ATTR2 < 2 OR ATTR3 > 10");
*
* Filter f = CQL.toFilter("NAME = 'New York' ");
*
* Filter f = CQL.toFilter("NAME LIKE 'New%' ");
*
* Filter f = CQL.toFilter("NAME IS NULL");
*
* Filter f = CQL.toFilter("DATE BEFORE 2006-11-30T01:30:00Z");
*
* Filter f = CQL.toFilter("NAME DOES-NOT-EXIST");
*
* Filter f = CQL.toFilter("QUANTITY BETWEEN 10 AND 20");
*
* Filter f = CQL.toFilter("CROSSES(SHAPE, LINESTRING(1 2, 10 15))");
*
* Filter f = CQL.toFilter("BBOX(SHAPE, 10,20,30,40)");
*
* Expression e = CQL.toExpression("NAME");
*
* Expression e = CQL.toExpression("QUANTITY * 2");
*
* Expression e = CQL.toExpression("strConcat(NAME, 'suffix')");
*
* List filters = CQL.toFilterList("NAME IS NULL;BBOX(SHAPE, 10,20,30,40);INCLUDE");
*
*
*
* @since 2.5
* @author Mauricio Pazos (Axios Engineering)
* @author Gabriel Roldan (Axios Engineering)
* @version $Id$
*
* @source $URL$
*/
public class CQL {
private CQL() {
// do nothing, private constructor
// to indicate it is a pure utility class
}
/**
* Parses the input string in OGC CQL format into a Filter, using the
* systems default FilterFactory implementation.
*
* @param cqlPredicate
* a string containing a query predicate in OGC CQL format.
* @return a {@link Filter} equivalent to the constraint specified in
* cqlPredicate
.
*/
public static Filter toFilter(final String cqlPredicate)
throws CQLException {
Filter filter = CQL.toFilter(cqlPredicate, null);
return filter;
}
/**
* Parses the input string in OGC CQL format into a Filter, using the
* provided FilterFactory.
*
* @param cqlPredicate
* a string containing a query predicate in OGC CQL format.
* @param filterFactory
* the {@link FilterFactory} to use for the creation of the
* Filter. If it is null the method finds the default implementation.
* @return a {@link Filter} equivalent to the constraint specified in
* Predicate
.
*/
public static Filter toFilter(final String cqlPredicate, final FilterFactory filterFactory)
throws CQLException {
CQLCompilerFactory compilerFactory = new CQLCompilerFactory();
Filter result = CompilerUtil.parseFilter(cqlPredicate, compilerFactory, filterFactory);
return result;
}
/**
* Parses the input string in OGC CQL format into an Expression, using the
* systems default {@link FilterFactory} implementation.
*
* @param cqlExpression
* a string containing an OGC CQL expression.
* @return a {@link Expression} equivalent to the one specified in
* cqlExpression
.
*/
public static Expression toExpression(String cqlExpression)
throws CQLException {
return toExpression(cqlExpression, null);
}
/**
* Parses the input string in OGC CQL format into an {@link Expression}, using the
* provided {@link FilterFactory}.
*
* @param cqlExpression
* a string containing a OGC CQL expression.
*
* @param filterFactory
* the {@link FilterFactory} to use for the creation of the
* Expression. If it is null the method finds the default implementation.
* @return a {@link Filter} equivalent to the constraint specified in
* cqlExpression
.
*/
public static Expression toExpression(final String cqlExpression,
final FilterFactory filterFactory) throws CQLException {
CQLCompilerFactory compilerFactory = new CQLCompilerFactory();
Expression expression = CompilerUtil.parseExpression(cqlExpression, compilerFactory, filterFactory);
return expression;
}
/**
* Parses the input string, which has to be a list of OGC CQL predicates
* separated by ;
into a List
of
* Filter
s, using the provided FilterFactory.
*
* @param cqlFilterList
* a list of OGC CQL predicates separated by ";
"
*
* @return a {@link List} of {@link Filter}, one for each input CQL statement
*/
public static List;
" into a List
of
* Filter
s, using the provided FilterFactory.
*
* @param cqlSequencePredicate
* a list of OGC CQL predicates separated by ";
"
*
* @param filterFactory
* the {@link FilterFactory} to use for the creation of the
* Expression. If it is null the method finds the default implementation.
* @return a List of {@link Filter}, one for each input CQL statement
*/
public static List