/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2004-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 org.geotools.filter.text.commons.CompilerUtil;
import org.geotools.filter.text.commons.Language;
import org.junit.Assert;
import org.junit.Test;
import org.opengis.filter.Filter;
import org.opengis.filter.PropertyIsBetween;
import org.opengis.filter.expression.Expression;


/**
 * Unit test for between predicate
 * <p>
 * <pre>
 *  This cql clause is an extension for convenience.
 *  <between predicate > ::=
 *  <attribute name > [ NOT ] BETWEEN  <literal& #62; AND  < literal  >
 * </pre>
 * </p>
 * 
 * @author Mauricio Pazos (Axios Engineering)
 * @since 2.5
 *
 *
 * @source $URL$
 */
public class CQLBetweenPredicateTest {

    
    protected final Language language;

    public CQLBetweenPredicateTest(){
        
        this(Language.CQL);
    }

    public CQLBetweenPredicateTest(final Language language){
        
        assert language != null: "language cannot be null value";
        
        this.language = language;
    }

    /**
     * BETWEEN predicate test
     */
    @Test
    public void propertyBetweenLiterals() throws Exception {
        // between
        Filter expected = FilterCQLSample.getSample( FilterCQLSample.BETWEEN_FILTER );
        
        testBetweenPredicate( FilterCQLSample.BETWEEN_FILTER, expected );
    }
    
    /**
     * NOT BETWEEN predicate test
     */
    @Test
    public void notBetweenPredicate() throws Exception{
        
        // not between
        Filter expected = FilterCQLSample.getSample(FilterCQLSample.NOT_BETWEEN_FILTER);

        testBetweenPredicate(FilterCQLSample.NOT_BETWEEN_FILTER, expected);
    }

    /**
     * test for between predicate with compound attribute
     * 
     * @throws Exception
     */
    @Test
    public void compoundAttributeInBetweenPredicate() throws Exception{
        
        // test compound attribute gmd:aa:bb.gmd:cc.gmd:dd
        final String prop = "gmd:aa:bb.gmd:cc.gmd:dd";
        final String propExpected = "gmd:aa:bb/gmd:cc/gmd:dd";
        Filter resultFilter = CQL.toFilter(prop + " BETWEEN 100 AND 200 ");

        Assert.assertTrue("PropertyIsBetween filter was expected",
            resultFilter instanceof PropertyIsBetween);

        PropertyIsBetween filter = (PropertyIsBetween) resultFilter;
        Expression property = filter.getExpression();

        Assert.assertEquals(propExpected, property.toString());
    }
    
    /**
     * Execute the test with the provided sample
     * 
     * @param samplePredicate
     * @throws Exception
     */
    protected void testBetweenPredicate(final String samplePredicate, Filter expected) throws Exception{
        
        Filter actual = CompilerUtil.parseFilter(this.language, samplePredicate);

        Assert.assertNotNull("expects a not null filter", actual);

        Assert.assertEquals("between filter error", expected, actual);
    }
    
    
}