/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 * 
 *    (C) 2005-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 junit.framework.TestCase;

import org.geotools.factory.CommonFactoryFinder;
import org.geotools.factory.GeoTools;
import org.geotools.filter.IllegalFilterException;
import org.opengis.filter.And;
import org.opengis.filter.Filter;
import org.opengis.filter.FilterFactory2;
import org.opengis.filter.Not;
import org.opengis.filter.PropertyIsGreaterThan;
import org.opengis.filter.PropertyIsLessThan;
import org.opengis.filter.PropertyIsLike;
import org.opengis.filter.expression.Add;
import org.opengis.filter.expression.Expression;
import org.opengis.filter.expression.Literal;


/**
 * Unit test for DuplicatorFilterVisitor.
 *
 * @author Cory Horner, Refractions Research Inc.
 * @source $URL$
 */
public class DuplicateFilterVisitorTest extends TestCase {

    private org.opengis.filter.FilterFactory2 fac;

	public DuplicateFilterVisitorTest(String testName) {
        super(testName);
    }

    protected void setUp() throws Exception {
        fac = CommonFactoryFinder.getFilterFactory2(GeoTools.getDefaultHints());
    }
    
    public void testLogicFilterDuplication() throws IllegalFilterException {
    	//create a filter
    	PropertyIsGreaterThan greater = fac.greater(fac.literal(2), fac.literal(1));
    	PropertyIsLessThan less = fac.less(fac.literal(3), fac.literal(4));
    	And and = fac.and(greater, less);
    	
    	//duplicate it
    	DuplicatingFilterVisitor visitor = new DuplicatingFilterVisitor();
    	Filter newFilter = (Filter) and.accept(visitor, fac);

    	//compare it
    	assertNotNull(newFilter);
    	assertEquals( and, newFilter );
    }    
    
    public void testOptimizationExample(){
        Expression add = fac.add(fac.literal(1), fac.literal(2));
        class Optimization extends DuplicatingFilterVisitor {
            public Object visit( Add expression, Object extraData ) {
                Expression expr1 = expression.getExpression1();
                Expression expr2 = expression.getExpression2();
                if( expr1 instanceof Literal && expr2 instanceof Literal){
                    Double number1 = (Double) expr1.evaluate(null,Double.class);
                    Double number2 = (Double) expr2.evaluate(null,Double.class);
                    
                    return ff.literal( number1.doubleValue() + number2.doubleValue() );
                }
                return super.visit(expression, extraData);
            }
        };
        Expression modified = (Expression) add.accept( new Optimization(), null );
        assertTrue( modified instanceof Literal );
    }
    
    public void testNotFilter() {
        // set GEOT-1566
        PropertyIsLike like = fac.like(fac.property("stringProperty"), "ab*");
        Not not = fac.not(like);
        DuplicatingFilterVisitor visitor = new DuplicatingFilterVisitor(fac);
        Not clone = (Not) not.accept(visitor, null);
        assertEquals(not, clone);
        assertNotSame(not, clone);
        assertNotSame(like, clone.getFilter());
    }
}