org.sindice.siren.solr.SirenQParserPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of siren-solr Show documentation
The newest version!
/**
 * Copyright (c) 2009-2011 Sindice Limited. All Rights Reserved.
 *
 * Project and contact information: http://www.siren.sindice.com/
 *
 * This file is part of the SIREn project.
 *
 * SIREn is a free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * SIREn 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with SIREn. If not, see .
 */
/**
 * @project siren
 * @author Renaud Delbru [ 29 Oct 2010 ]
 * @link http://renaud.delbru.fr/
 * @copyright Copyright (C) 2010 by Renaud Delbru, All rights reserved.
 */
package org.sindice.siren.solr;

import org.apache.solr.common.params.SolrParams;
import org.apache.solr.common.util.NamedList;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.search.QParser;
import org.apache.solr.search.QParserPlugin;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * 
 * A Generic query plugin designed to support all types of SIREn queries
 * (keyword, ntriple, entity) over multiple fields.

 * Queries of different types are intersected together using a BooleanQuery.
 * E.g., if a keyword query and a NTriple query is defined in the parameter,
 * then the computed results must match the two queries.
 * 
 *
 * 
 * All of the following options may be configured for this plugin
 * in the solrconfig as defaults, and may be overriden as request parameters.
 * The main parameter - q - is reserved for simple keyword queries.
 * 
 *
 * 
 *  qf - (Query Fields) fields and boosts to use when building
 *           simple keyword queries from the users query.  Format is:
 *           "fieldA^1.0 fieldB^2.2".
 *           This param can be specified multiple times, and the fields
 *           are additive. If it is not specified, the default field is used
 *           instead.
 * 
 *  nq - (NTriple Query) a NTriple query from the user. This param can be
 *            specified only one time.
 * 
 *  nqf - (NTriple Query Fields) fields and boosts to use when building
 *            ntriple queries. Format is: "fieldA^1.0 fieldB^2.2".
 *            This param can be specified multiple times, and the fields are
 *            additive. If it is not specified, the default field is used
 *            instead.
 * 
 * 
 *
 * 
 * The following options are only available as request params...
 * 
 *
 * 
 *    q - (Query) the raw unparsed, unescaped, keyword query from the user.
 * 
 * sort - (Order By) list of fields and direction to sort on.
 * 
 * 
 */
public class SirenQParserPlugin extends QParserPlugin {

  public static String NAME = "siren";

  private static final
  Logger logger = LoggerFactory.getLogger(SirenQParserPlugin.class);

  public void init(final NamedList args) {}

  @Override
  public QParser createParser(final String qstr, final SolrParams localParams,
                              final SolrParams params, final SolrQueryRequest req) {
    return new SirenQParser(qstr, localParams, params, req);
  }

}