openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/kernel/TestDateQueries.java

/*
 * TestDateQueries.java
 *
 * Created on October 10, 2006, 1:28 PM
 *
 * To change this template, choose Tools | Template Manager
 * and open the template in the editor.
 */

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.openjpa.persistence.kernel;

import java.sql.Timestamp;
import java.text.SimpleDateFormat;
import java.util.Collection;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;

import org.apache.openjpa.jdbc.conf.JDBCConfiguration;
import org.apache.openjpa.jdbc.sql.DBDictionary;
import org.apache.openjpa.persistence.OpenJPAEntityManager;
import org.apache.openjpa.persistence.OpenJPAQuery;
import org.apache.openjpa.persistence.kernel.common.apps.AllFieldTypesTest;

public class TestDateQueries extends BaseKernelTest {

    private OpenJPAEntityManager _pm = null;
    private Date _date = null;
    private Date _before = null;
    private Date _after = null;
    private final Timestamp referenceTst = new Timestamp(10000000000L);

    /**
     * Creates a new instance of TestDateQueries
     */
    public TestDateQueries() {
    }

    public TestDateQueries(String name) {
        super(name);
    }

    @Override
    public void setUp()
        throws Exception {
        super.setUp(AllFieldTypesTest.class);

        SimpleDateFormat sdf = new SimpleDateFormat("MMMMM dd, yyyy",
            Locale.US);
        _date = sdf.parse("April 26, 1978");
        _before = sdf.parse("April 25, 1978");
        _after = sdf.parse("April 27, 1978");
        _pm = getPM();

        // create some instances to query on
        startTx(_pm);
        AllFieldTypesTest test = new AllFieldTypesTest();
        test.setTestDate(_date);

        // prepare scale test fields
        Timestamp tst = new Timestamp(referenceTst.getTime());

        // we stay under 5 to avoid rounding issues with some databases
        tst.setNanos(123412341);

        test.setTestTstMaxScale(tst);
        test.setTestTstScale0(tst);
        test.setTestTstScale3(tst);
        test.setTestTstScale6(tst);
        test.setTestDateMaxScale(new Date(tst.getTime()));
        test.setTestDateScale0(new Date(tst.getTime()));
        test.setTestDateScale3(new Date(tst.getTime()));

        _pm.persist(test);

        test = new AllFieldTypesTest();
        test.setTestDate(_before);
        _pm.persist(test);

        test = new AllFieldTypesTest();
        test.setTestDate(_after);
        _pm.persist(test);
        endTx(_pm);

        _pm.clear();
    }

    public void testEquals() {
        Collection vals = executeQuery("testDate = :date");
        assertEquals(1, vals.size());
        assertEquals(_date, ((AllFieldTypesTest) vals.iterator().next()).
            getTestDate());
    }

    public void testNotEquals() {
        Collection vals = executeQuery("testDate <> :date");
        assertEquals(2, vals.size());
    }

    public void testDateScale() {
        DBDictionary dbDictionary = ((JDBCConfiguration) _pm.getConfiguration()).getDBDictionaryInstance();
        if (!dbDictionary.fractionalTypeNameSet.contains(dbDictionary.timestampTypeName)) {
            getLog().info("skipping testDateScale because DB doesn't support different fractions in timestamps");
            return;
        }

        Collection vals = executeQuery("testDate = :date");
        AllFieldTypesTest aft = (AllFieldTypesTest) vals.iterator().next();
        assertNotNull(aft);

        long time = aft.getTestTstMaxScale().getTime();
        long nanos = aft.getTestTstMaxScale().getNanos();

        // cut of the ms
        assertEquals(referenceTst.getTime(), time - (time % 1000));

        // we have to do some guessing as not every database
        // is able to store fractions of a second.
        int maxDigitsFromDb = getNonZeroDigits(nanos);
        if (maxDigitsFromDb >= 3) {
            {
                time = aft.getTestTstScale0().getTime();
                nanos = aft.getTestTstScale0().getNanos();
                assertEquals(referenceTst.getTime(), time - (time % 1000));
                assertEquals(0, getNonZeroDigits(nanos));
            }

            {
                time = aft.getTestDateScale0().getTime();
                assertEquals(referenceTst.getTime(), time - (time % 1000));
            }

            {
                time = aft.getTestTstScale3().getTime();
                nanos = aft.getTestTstScale3().getNanos();
                assertEquals(referenceTst.getTime(), time - (time % 1000));
                assertEquals(3, getNonZeroDigits(nanos));
            }

            {
                time = aft.getTestDateMaxScale().getTime();
                assertEquals(referenceTst.getTime() + 123, time);
            }

            {
                time = aft.getTestDateScale3().getTime();
                assertEquals(referenceTst.getTime() + 123, time);
            }

        }

        if (maxDigitsFromDb >= 6) {
            time = aft.getTestTstScale6().getTime();
            nanos = aft.getTestTstScale6().getNanos();
            assertEquals(referenceTst.getTime(), time - (time % 1000));
            assertEquals(6, getNonZeroDigits(nanos));
        }
    }

    private int getNonZeroDigits(long val) {
        String sval = Long.toString(val);
        int digits = 0;
        for (; digits < sval.length() && sval.charAt(digits) != '0'; digits++);

        return digits;
    }

    public void testBefore() {
        Collection vals = executeQuery("testDate < :date");
        assertEquals(1, vals.size());
        assertEquals(_before, ((AllFieldTypesTest) vals.iterator().next()).
            getTestDate());
    }

    public void testAfter() {
        Collection vals = executeQuery("testDate > :date");
        assertEquals(1, vals.size());
        assertEquals(_after, ((AllFieldTypesTest) vals.iterator().next()).
            getTestDate());
    }

    public void testOrderBy() {
        String query =
            "SELECT o FROM AllFieldTypesTest o ORDER BY o.testDate ASC";
        OpenJPAQuery q = _pm.createQuery(query);
        List vals = q.getResultList();
        assertEquals(3, vals.size());

        Iterator i = vals.iterator();
        assertEquals(_before, ((AllFieldTypesTest) i.next()).getTestDate());
        assertEquals(_date, ((AllFieldTypesTest) i.next()).getTestDate());
        assertEquals(_after, ((AllFieldTypesTest) i.next()).getTestDate());
    }

    private List executeQuery(String filter) {
        String query = "SELECT o FROM AllFieldTypesTest o WHERE o." + filter;
        OpenJPAQuery q = _pm.createQuery(query);
        q.setParameter("date", _date);
        return q.getResultList();
    }
}