ch.entwine.weblounge.contentrepository.impl.index.elasticsearch.FacetedSuggestRequest.java Source code

Introduction

Here is the source code for ch.entwine.weblounge.contentrepository.impl.index.elasticsearch.FacetedSuggestRequest.java

Source

/*
 *  Weblounge: Web Content Management System
 *  Copyright (c) 2003 - 2011 The Weblounge Team
 *  http://entwinemedia.com/weblounge
 *
 *  This program 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
 *  of the License, or (at your option) any later version.
 *
 *  This program 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 this program; if not, write to the Free Software Foundation
 *  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

package ch.entwine.weblounge.contentrepository.impl.index.elasticsearch;

import ch.entwine.weblounge.common.repository.ContentRepositoryException;

import org.apache.commons.lang.StringUtils;

import java.util.Collections;
import java.util.List;

/**
 * Request for suggestions based on existing values in the search index. This
 * request uses the faceting mechanism of Solr and does not need additional
 * components on <code>solrconnfig.xml</code>.
 */
public class FacetedSuggestRequest {

    /** The dictionaries available for suggestions */
    public enum Dictionary {
        Default, Path, Subject
    }

    /** Name of the dictionary component that we configured above */
    protected String dictionary = null;

    /** Specifies to return up to 5 suggestions */
    protected int count = 10;

    //  /** The connection to the solr database */
    //  private Solr solrConnection = null;

    /**
     * Creates a new suggest request which uses the given connection to solr and a
     * predefined dictionary named <code>dictionary</code> to return suggestions,
     * using facets.
     * 
     * @param connection
     *          the solr connection
     * @param dictionary
     *          name of the dictionary
     * @param count
     *          number of suggestions to return
     */
    //  public FacetedSuggestRequest(Solr connection, String dictionary,
    //      int count) {
    //    this.solrConnection = connection;
    //    this.dictionary = dictionary.toLowerCase();
    //    this.count = count;
    //  }

    /**
     * Returns a list of suggestions based on the seed value.
     * 
     * @param seed
     *          the value to base suggestions on
     * @return the suggestions
     * @throws IllegalArgumentException
     *           if <code>seed</code> is blank
     * @throws SolrServerException
     *           if querying solr fails
     */
    public List<String> getSuggestions(String seed) throws IllegalArgumentException, ContentRepositoryException {
        if (StringUtils.isBlank(seed))
            throw new IllegalArgumentException("Seed cannot be blank");

        // TODO: Implement
        return Collections.EMPTY_LIST;
    }

}