CharacterCountTerm.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.util.Arrays;
import java.util.List;

/**
 * This class implements the character count comparison.
 *
 * @author Eirik Bjorsnos <bjorsnos@underdusken.no>
 * @version $Revision$, $Date$
 */
public class CharacterCountTerm extends ComparisonTerm {


    /**
     * The number of characters of the article
     */
    private int characterCount;

    /**
     * Constructor that takes the comparison type and the number of characters
     *
     * @param comparison     Comparison type defined in ComparisonTerm.
     * @param characterCount The number of characters to compare to.
     */
    public CharacterCountTerm(Comparison comparison, int characterCount) {
        super(comparison);
        this.characterCount = characterCount;
    }

    /**
     * Generates the WHERE part of this SearchTerm.
     *
     * @return WHERE part of the SQL query
     */
    public String whereClause() {
        return "Article.characterCount " + getComparison().getOperator() + ' ' + characterCount;
    }

    /**
     * Returns an array of tables involved in this SearchTerm.
     * CharacterCountTerm involves only the Article table.
     *
     * @return Array of table names
     */
    public List<String> getTables() {
        return Arrays.asList("Article");
    }

}