PublicationTerm.java

/**
 * Copyright 1999-2009 The Pegadi Team
 *
 * Licensed 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.pegadi.articlesearch;

import org.pegadi.sqlsearch.ComparisonTerm;

import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Date;
import java.util.List;

/**
 * This class implements a search based on a publication.
 *
 * @author Eirik Bjorsnos <bjorsnos@underdusken.no>
 * @version $Revision$, $Date$
 */
public class PublicationTerm extends ComparisonTerm {


    /**
     * Search by publication reference flag
     */
    public static final int TYPE_REF = 1;

    /**
     * Search by a publication date flag
     */
    public static final int TYPE_DATE = 2;


    /**
     * Actual search type
     */
    private int type;

    /**
     * The ID of the publication to search for
     */

    private int publicationRef;

    /**
     * The date of the publication to search for
     */
    private Date publicationDate;

    /**
     * Constructor taking a publication reference as
     * parameter.
     *
     * @param publicationRef publication reference
     */
    public PublicationTerm(int publicationRef) {
        super(Comparison.EQ);
        this.type = TYPE_REF;
        this.publicationRef = publicationRef;
    }

    /**
     * Constructor taking a comparison type and publication date as
     * parameters.
     *
     * @param comparison      comparison type
     * @param publicationDate publication release date
     */
    public PublicationTerm(Comparison comparison, Date publicationDate) {
        super(comparison);
        this.type = TYPE_DATE;
        this.publicationDate = publicationDate;
    }

    /**
     * Generates the WHERE part of the SQL query (without including the string
     * "WHERE").
     *
     * @return The WHERE clause
     */
    public String whereClause() {

        if (type == TYPE_REF) {
            return "Article.refPublication = " + publicationRef;
        } else { // type == TYPE_DATE

            SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");


            String dateString = format.format(publicationDate);
            StringBuilder where = new StringBuilder("(Article.refPublication = Publication.ID AND Publication.releaseDate ");
            where.append(getComparison().getOperator());
            where.append(" '").append(dateString).append("')");

            return where.toString();

        }
    }


    /**
     * Returns the names of the tables involved in this search.
     *
     * @return A String[] containing the involved tables.
     */
    public List<String> getTables() {
        if (type == TYPE_REF) {
            return Arrays.asList("Article");
        } else {
            return Arrays.asList("Article", "Publication");
        }
    }

}