com.stratio.cassandra.lucene.search.condition.SingleColumnCondition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cassandra-lucene-index-plugin Show documentation
Cassandra Lucene Index plugin
The newest version!
/*
 * Copyright (C) 2014 Stratio (http://stratio.com)
 *
 * 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 com.stratio.cassandra.lucene.search.condition;

import com.stratio.cassandra.lucene.IndexException;
import com.stratio.cassandra.lucene.schema.Schema;
import com.stratio.cassandra.lucene.schema.mapping.Mapper;
import com.stratio.cassandra.lucene.schema.mapping.SingleColumnMapper;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.search.Query;

/**
 * The abstract base class for queries.
 *
 * Known subclasses are:   {@link FuzzyCondition} 
 {@link MatchCondition} 
 {@link PhraseCondition} 

 * {@link PrefixCondition} 
 {@link RangeCondition} 
 {@link WildcardCondition} 
 *
 * @author Andres de la Pena {@literal }
 */
public abstract class SingleColumnCondition extends SingleFieldCondition {

    /**
     * Abstract {@link SingleColumnCondition} builder receiving the boost to be used.
     *
     * @param boost The boost for this query clause. Documents matching this clause will (in addition to the normal
     * weightings) have their score multiplied by {@code boost}.
     * @param field the name of the field to be matched
     */
    public SingleColumnCondition(Float boost, String field) {
        super(boost, field);
    }

    /** {@inheritDoc} */
    @Override
    @SuppressWarnings("unchecked")
    public final Query doQuery(Schema schema) {
        Mapper mapper = schema.mapper(field);
        if (mapper == null) {
            throw new IndexException("No mapper found for field '{}'", field);
        } else if (!SingleColumnMapper.class.isAssignableFrom(mapper.getClass())) {
            throw new IndexException("Field '{}' requires a mapper of type '{}' but found '{}'",
                                     field,
                                     SingleColumnMapper.class.getSimpleName(),
                                     mapper);
        }
        return doQuery((SingleColumnMapper) mapper, schema.analyzer);
    }

    /**
     * Returns the Lucene {@link Query} representation of this condition.
     *
     * @param mapper the mapper to be used
     * @param analyzer the {@link Schema} analyzer
     * @return the Lucene query
     */
    public abstract Query doQuery(SingleColumnMapper mapper, Analyzer analyzer);
}