org.craftercms.search.service.impl.SolrQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of crafter-search-api Show documentation
The newest version!
/*
 * Copyright (C) 2007-2013 Crafter Software Corporation.
 *
 * 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 .
 */
package org.craftercms.search.service.impl;

/**
 * Search query for Solr.
 *
 * @author Alfonso Vásquez
 */
public class SolrQuery extends QueryParams {

    public static final String FIELDS_TO_RETURN = "fl";
    public static final String HIGHLIGHT_PARAM = "hl";
    public static final String HIGHLIGHT_FIELDS_PARAM = "hl.fl";
    public static final String HIGHLIGHT_SNIPPETS_PARAM = "hl.snippets";
    public static final String HIGHLIGHT_SNIPPET_SIZE_PARAM = "hl.fragsize";
    public static final String QUERY_PARAM = "q";
    public static final String START_PARAM = "start";
    public static final String ROWS_PARAM = "rows";

    public SolrQuery setFieldsToReturn(String... fields) {
        addParam(FIELDS_TO_RETURN, fields);

        return this;
    }

    public SolrQuery setHighlight(boolean highlight) {
        addParam(HIGHLIGHT_PARAM, Boolean.toString(highlight));

        return this;
    }

    public SolrQuery setHighlightFields(String... fields) {
        if (!hasParam(HIGHLIGHT_PARAM)) {
            addParam(HIGHLIGHT_PARAM, "true");
        }

        addParam(HIGHLIGHT_FIELDS_PARAM, fields);

        return this;
    }

    public SolrQuery setHighlightSnippets(int snippets) {
        if (!hasParam(HIGHLIGHT_PARAM)) {
            addParam(HIGHLIGHT_PARAM, "true");
        }

        addParam(HIGHLIGHT_SNIPPETS_PARAM, Integer.toString(snippets));

        return this;
    }

    public SolrQuery setHighlightSnippetSize(int size) {
        if (!hasParam(HIGHLIGHT_PARAM)) {
            addParam(HIGHLIGHT_PARAM, "true");
        }

        addParam(HIGHLIGHT_SNIPPET_SIZE_PARAM, Integer.toString(size));

        return this;
    }

    public SolrQuery setQuery(String query) {
        addParam(QUERY_PARAM, query);

        return this;
    }

    public SolrQuery setStart(int start) {
        addParam(START_PARAM, Integer.toString(start));

        return this;
    }

    public SolrQuery setRows(int rows) {
        addParam(ROWS_PARAM, Integer.toString(rows));

        return this;
    }

}