source: vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/service/solr/impl/SolrDaoImpl.java @ 4661

package eu.clarin.cmdi.vlo.service.solr.impl;

import eu.clarin.cmdi.vlo.config.VloConfig;
import java.util.HashSet;
import java.util.Set;
import org.apache.solr.client.solrj.SolrQuery;
import org.apache.solr.client.solrj.SolrServer;
import org.apache.solr.client.solrj.SolrServerException;
import org.apache.solr.client.solrj.response.QueryResponse;
import org.apache.solr.client.solrj.util.ClientUtils;
import org.apache.solr.common.SolrDocument;
import org.apache.solr.common.SolrDocumentList;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class SolrDaoImpl {
    
    private final static Logger logger = LoggerFactory.getLogger(SolrDaoImpl.class);
    private final SolrServer solrServer;
    private final VloConfig config;

    public SolrDaoImpl(SolrServer solrServer, VloConfig config) {
        this.solrServer = solrServer;
        this.config = config;
    }

    protected SolrServer getSolrserver() {
        return solrServer;
    }

    /**
     * Basic sanitising of Solr queries.
     *
     * TODO: Move this to QueryFacetSelection level??
     * 
     * Query is based on the URL to the VLO web application. Also, explain about
     * the URL and ?fq=language:dutch Assume filters have the form a:b like for
     * example language:dutch
     *
     * @param query
     * @return
     */
    protected SolrQuery sanitise(SolrQuery query) {

        // String [] facetsFromConfig; 
        // try and get the filters facets from the query
        String[] filtersInQuery;
        filtersInQuery = query.getFilterQueries();

        if (filtersInQuery == null) {
            // the query does not contain filters
        } else {
            // get the facets from the configuration file
            // facetsFromConfig = VloConfig.getFacetFields();

            // present the facets from the config file as a list to a new set
            Set<String> facetsDefined;
            facetsDefined = new HashSet<String>(config.getAllFacetFields());

            // check the filters in the query by name
            for (String filter : filtersInQuery) {
                // split up a filter, look at the string preceeding the semicolon 
                String facetInFilter = filter.split(":")[0];

                if (facetsDefined.contains(facetInFilter)) {
                    // facet in the filter is in the set that is defined by the config file
                } else {
                    if (facetInFilter.startsWith("_")) {
                        // this facet is hidden, do not consider it
                    } else {
                        // the filter name does not match a facet in the facet
                        query.removeFilterQuery(filter);
                    }
                }
            }
        }

        // finally, return the sanitised query
        return query;
    }

    protected QueryResponse fireQuery(SolrQuery query) {
        try {
            logger.debug("Executing query: {}", query);
            final QueryResponse response = solrServer.query(query);
            logger.trace("Response: {}", response);
            return response;
        } catch (SolrServerException e) {
            logger.error("Error getting data:", e);
            throw new RuntimeException(e);
        }
    }

    public SolrDocument getSolrDocument(String docId) {
        if (docId == null) {
            throw new NullPointerException("Cannot get SOLR document for null docId");
        }
        SolrDocument result = null;
        SolrQuery query = new SolrQuery();
        query.setQuery("id:" + ClientUtils.escapeQueryChars(docId));
        query.setFields("*");
        SolrDocumentList docs = fireQuery(query).getResults();
        if (docs.getNumFound() > 1) {
            logger.error("Error: found multiple documents for id (will return first one): " + docId + " \nDocuments found: " + docs);
            result = docs.get(0);
        } else if (docs.getNumFound() == 1) {
            result = docs.get(0);
        }
        return result;
    }
}