source: vlo/branches/vlo-3.3-oeaw/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/service/solr/SolrFacetQueryFactory.java @ 6456

/*
 * Copyright (C) 2014 CLARIN
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package eu.clarin.cmdi.vlo.service.solr;

import eu.clarin.cmdi.vlo.pojo.QueryFacetsSelection;
import java.util.List;
import org.apache.solr.client.solrj.SolrQuery;

/**
 * A factory that constructs SOLR queries to be used in various services for
 * data providers etc.
 *
 * @author twagoo
 */
public interface SolrFacetQueryFactory {

    /**
     *
     * @param selection selection to get facets and value counts for
     * @param facets facets to include in request
     * @param valueLimit limits the number of values to retrieve per facet,
     * negative for unlimited (see {@link SolrQuery#getFacetLimit() })
     * @return query for retrieving the facets
     */
    SolrQuery createFacetQuery(QueryFacetsSelection selection, List<String> facets, int valueLimit);

    /**
     * 
     * @param facets facets to include in request
     * @return query for retrieving the number of facets
     */
    SolrQuery createCountFacetsQuery(List<String> facets);

    /* query that returns complete list of values for specified facet */
        SolrQuery createExludedFacetQuery(QueryFacetsSelection selection, String facet, int valueLimit);

}