/*
* 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.data.jdbc;
import java.io.IOException;
import java.io.StringWriter;
import java.sql.Connection;
import java.sql.Statement;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.Logger;
import junit.framework.TestCase;
import org.geotools.data.jdbc.fidmapper.FIDMapper;
import org.geotools.factory.CommonFactoryFinder;
import org.geotools.feature.simple.SimpleFeatureTypeBuilder;
import org.opengis.feature.simple.SimpleFeature;
import org.opengis.feature.simple.SimpleFeatureType;
import org.opengis.filter.Filter;
import org.opengis.filter.FilterFactory;
import org.opengis.filter.Id;
import org.opengis.filter.PropertyIsEqualTo;
import org.opengis.filter.expression.Add;
import org.opengis.filter.expression.Expression;
import org.opengis.filter.identity.FeatureId;
/**
* Unit test for sql encoding of filters into where statements.
*
* @author Chris Holmes, TOPP
* @author Saul Farber, MassGIS
*
*
*
* @source $URL$
*/
public class FilterToSQLTest extends TestCase {
private FilterFactory filterFac = CommonFactoryFinder.getFilterFactory(null);
private static Logger LOGGER = org.geotools.util.logging.Logging.getLogger("org.geotools.data.jdbc");
private SimpleFeatureType integerFType;
private SimpleFeatureType stringFType;
private FilterToSQL encoder;
private StringWriter output;
public void setUp() throws Exception {
Level debugLevel = Level.FINE;
Logger log = LOGGER;
while (log != null) {
log.setLevel(debugLevel);
for (int i = 0; i < log.getHandlers().length; i++) {
Handler h = log.getHandlers()[i];
h.setLevel(debugLevel);
}
log = log.getParent();
}
SimpleFeatureTypeBuilder ftb = new SimpleFeatureTypeBuilder();
ftb.setName("testFeatureType");
ftb.add("testAttr", Integer.class);
integerFType = ftb.buildFeatureType();
ftb.setName("testFeatureType");
ftb.add("testAttr", String.class);
stringFType = ftb.buildFeatureType();
output = new StringWriter();
encoder = new FilterToSQL(output);
FIDMapper mapper = new FIDMapper() {
@Override
public boolean returnFIDColumnsAsAttributes() {
// TODO Auto-generated method stub
return false;
}
@Override
public boolean isVolatile() {
// TODO Auto-generated method stub
return false;
}
@Override
public boolean isValid(String fid) {
// TODO Auto-generated method stub
return false;
}
@Override
public boolean isAutoIncrement(int colIndex) {
// TODO Auto-generated method stub
return false;
}
@Override
public void initSupportStructures() {
// TODO Auto-generated method stub
}
@Override
public boolean hasAutoIncrementColumns() {
// TODO Auto-generated method stub
return false;
}
@Override
public Object[] getPKAttributes(String FID) throws IOException {
return new Object[] { FID };
}
@Override
public String getID(Object[] attributes) {
// TODO Auto-generated method stub
return null;
}
@Override
public int getColumnType(int colIndex) {
// TODO Auto-generated method stub
return 0;
}
@Override
public int getColumnSize(int colIndex) {
// TODO Auto-generated method stub
return 0;
}
@Override
public String getColumnName(int colIndex) {
return "id";
}
@Override
public int getColumnDecimalDigits(int colIndex) {
// TODO Auto-generated method stub
return 0;
}
@Override
public int getColumnCount() {
return 1;
}
@Override
public String createID(Connection conn, SimpleFeature feature, Statement statement)
throws IOException {
// TODO Auto-generated method stub
return null;
}
};
encoder.setFIDMapper(mapper);
}
public void testIntegerContext() throws Exception {
Expression literal = filterFac.literal(5);
Expression prop = filterFac.property(integerFType.getAttributeDescriptors().get(0)
.getLocalName());
PropertyIsEqualTo filter = filterFac.equals(prop, literal);
encoder.setFeatureType(integerFType);
encoder.encode(filter);
LOGGER.fine("testAttr is an Integer " + filter + " -> " + output.getBuffer().toString());
assertEquals(output.getBuffer().toString(), "WHERE testAttr = 5");
}
public void testStringContext() throws Exception {
Expression literal = filterFac.literal(5);
Expression prop = filterFac.property(stringFType.getAttributeDescriptors().get(0)
.getLocalName());
PropertyIsEqualTo filter = filterFac.equals(prop, literal);
encoder.setFeatureType(stringFType);
encoder.encode(filter);
LOGGER.fine("testAttr is a String " + filter + " -> " + output.getBuffer().toString());
assertEquals(output.getBuffer().toString(), "WHERE testAttr = '5'");
}
public void testIntegerToNumberContext() throws Exception {
Expression literal = filterFac.literal(5.0);
Expression prop = filterFac.property(integerFType.getAttributeDescriptors().get(0)
.getLocalName());
PropertyIsEqualTo filter = filterFac.equals(prop, literal);
encoder.setFeatureType(integerFType);
encoder.encode(filter);
LOGGER.fine("testAttr is an Integer " + filter + " -> " + output.getBuffer().toString());
assertEquals(output.getBuffer().toString(), "WHERE testAttr = 5.0");
}
public void testInclude() throws Exception {
encoder.encode(Filter.INCLUDE);
assertEquals(output.getBuffer().toString(), "WHERE 1 = 1");
}
public void testExclude() throws Exception {
encoder.encode(Filter.EXCLUDE);
assertEquals(output.getBuffer().toString(), "WHERE 0 = 1");
}
public void testIdFilterMulti() throws Exception {
Set<FeatureId> fids = new LinkedHashSet<FeatureId>();
fids.add(filterFac.featureId("fid1"));
fids.add(filterFac.featureId("fid2"));
Id id = filterFac.id(fids);
encoder.encode(id);
assertEquals("WHERE ((id = 'fid1') OR (id = 'fid2'))", output.toString());
}
public void testIdFilterSingle() throws Exception {
Set<FeatureId> fids = new LinkedHashSet<FeatureId>();
fids.add(filterFac.featureId("fid1"));
Id id = filterFac.id(fids);
encoder.encode(id);
assertEquals("WHERE (id = 'fid1')", output.toString());
}
public void testEscapeQuote() throws FilterToSQLException {
PropertyIsEqualTo equals = filterFac.equals(filterFac.property("attribute"), filterFac.literal("A'A"));
encoder.encode(equals);
assertEquals("WHERE attribute = 'A''A'", output.toString());
}
public void testExpression() throws Exception {
Add a = filterFac.add(filterFac.property("testAttr"), filterFac.literal(5));
encoder.encode(a);
assertEquals("testAttr + 5", output.toString());
}
public void testEscapeQuoteFancy() throws FilterToSQLException {
org.opengis.filter.FilterFactory ff = CommonFactoryFinder.getFilterFactory(null);
Object fancyLiteral = new Object() {
public String toString() {
return "A'A";
}
};
PropertyIsEqualTo equals = ff.equals(ff.property("attribute"), ff.literal(fancyLiteral));
StringWriter output = new StringWriter();
FilterToSQL encoder = new FilterToSQL(output);
encoder.encode(equals);
assertEquals("WHERE attribute = 'A''A'", output.toString());
}
public void testNumberEscapes() throws Exception {
Add a = filterFac.add(filterFac.property("testAttr"), filterFac.literal(5));
PropertyIsEqualTo equal = filterFac.equal(filterFac.property("testAttr"), a, false);
StringWriter output = new StringWriter();
FilterToSQL encoder = new FilterToSQL(output);
// this test must pass even when the target feature type is not known
// encoder.setFeatureType(integerFType);
encoder.encode(equal);
assertEquals("WHERE testAttr = testAttr + 5", output.toString());
}
public void testInline() throws Exception {
PropertyIsEqualTo equal = filterFac.equal(filterFac.property("testAttr"), filterFac.literal(5), false);
StringWriter output = new StringWriter();
FilterToSQL encoder = new FilterToSQL(output);
encoder.setInline(true);
encoder.encode(equal);
assertEquals("testAttr = 5", output.toString());
}
}