com.avaje.ebeaninternal.api.SpiLuceneExpr Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation

Ebean

There is a newer version: 2.8.1

/**
 * Copyright (C) 2009 Authors
 * 
 * This file is part of Ebean.
 * 
 * Ebean 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; either version 2.1 of the License, or
 * (at your option) any later version.
 *  
 * Ebean 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.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Ebean; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA  
 */
package com.avaje.ebeaninternal.api;

import org.apache.lucene.search.Query;

public interface SpiLuceneExpr {

    /**
     * Maps to Lucene Occur options.
     */
    public static enum ExprOccur {
        
        /**
         * Expression MUST occur.
         */
        MUST, 
        
        /**
         * Expression SHOULD occur.
         */
        SHOULD, 
        
        /**
         * Expression MUST NOT occur.
         */
        MUST_NOT
    }

    /**
     * Returns a Lucene Query for this expression. This is not strongly typed so
     * that Lucene is an optional dependency.
     */
    public Query mergeLuceneQuery();
    
    /**
     * Return a description of this expression.
     */
    public String getDescription();

}