/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.solr.handler;
import org.apache.solr.common.params.SolrParams;
import org.apache.solr.common.util.NamedList;
import org.apache.solr.search.DisMaxQParserPlugin;
import org.apache.solr.search.QueryParsing;
import org.apache.solr.util.SolrPluginUtils;
import java.net.MalformedURLException;
import java.net.URL;
/**
* <p>
* A Generic query plugin designed to be given a simple query expression
* from a user, which it will then query against a variety of
* pre-configured fields, in a variety of ways, using BooleanQueries,
* DisjunctionMaxQueries, and PhraseQueries.
* </p>
*
* <p>
* All of the following options may be configured for this plugin
* in the solrconfig as defaults, and may be overriden as request parameters
* </p>
*
* <ul>
* <li>q.alt - An alternate query to be used in cases where the main
* query (q) is not specified (or blank). This query should
* be expressed in the Standard SolrQueryParser syntax (you
* can use <code>q.alt=*:*</code> to denote that all documents
* should be returned when no query is specified)
* </li>
* <li>tie - (Tie breaker) float value to use as tiebreaker in
* DisjunctionMaxQueries (should be something much less than 1)
* </li>
* <li> qf - (Query Fields) fields and boosts to use when building
* DisjunctionMaxQueries from the users query. Format is:
* "<code>fieldA^1.0 fieldB^2.2</code>".
* This param can be specified multiple times, and the fields
* are additive.
* </li>
* <li> mm - (Minimum Match) this supports a wide variety of
* complex expressions.
* read {@link SolrPluginUtils#setMinShouldMatch SolrPluginUtils.setMinShouldMatch} and <a href="http://lucene.apache.org/solr/api/org/apache/solr/util/doc-files/min-should-match.html">mm expression format</a> for details.
* </li>
* <li> pf - (Phrase Fields) fields/boosts to make phrase queries out
* of, to boost the users query for exact matches on the specified fields.
* Format is: "<code>fieldA^1.0 fieldB^2.2</code>".
* This param can be specified multiple times, and the fields
* are additive.
* </li>
* <li> ps - (Phrase Slop) amount of slop on phrase queries built for pf
* fields.
* </li>
* <li> qs - (Query Slop) amount of slop on phrase queries explicitly
* specified in the "q" for qf fields.
* </li>
* <li> bq - (Boost Query) a raw lucene query that will be included in the
* users query to influence the score. If this is a BooleanQuery
* with a default boost (1.0f), then the individual clauses will be
* added directly to the main query. Otherwise, the query will be
* included as is.
* This param can be specified multiple times, and the boosts are
* are additive. NOTE: the behaviour listed above is only in effect
* if a single <code>bq</code> paramter is specified. Hence you can
* disable it by specifying an additional, blank, <code>bq</code>
* parameter.
* </li>
* <li> bf - (Boost Functions) functions (with optional boosts) that will be
* included in the users query to influence the score.
* Format is: "<code>funcA(arg1,arg2)^1.2
* funcB(arg3,arg4)^2.2</code>". NOTE: Whitespace is not allowed
* in the function arguments.
* This param can be specified multiple times, and the functions
* are additive.
* </li>
* <li> fq - (Filter Query) a raw lucene query that can be used
* to restrict the super set of products we are interested in - more
* efficient then using bq, but doesn't influence score.
* This param can be specified multiple times, and the filters
* are additive.
* </li>
* </ul>
*
* <p>
* The following options are only available as request params...
* </p>
*
* <ul>
* <li> q - (Query) the raw unparsed, unescaped, query from the user.
* </li>
* <li>sort - (Order By) list of fields and direction to sort on.
* </li>
* </ul>
*
* <pre>
* :TODO: document facet param support
*
* </pre>
* @deprecated use StandardRequestHandler with a "defType=dismax" param
*/
@Deprecated
public class DisMaxRequestHandler extends StandardRequestHandler
{
@Override
public void init(NamedList args) {
super.init( args );
NamedList def = null;
// redo "defaults"
Object o = args.get("defaults");
if (o != null && o instanceof NamedList) {
def = (NamedList)o;
} else {
// no explict defaults list, use all args implicitly
// indexOf so "<null name="defaults"/> is valid indicator of no defaults
def = args;
}
// Make the default query type "dismax" if not specified
if (def.get(QueryParsing.DEFTYPE) == null) {
def = def.clone();
def.add(QueryParsing.DEFTYPE, DisMaxQParserPlugin.NAME);
defaults = SolrParams.toSolrParams( def );
}
}
//////////////////////// SolrInfoMBeans methods //////////////////////
@Override
public String getDescription() {
return "DisjunctionMax Request Handler: Does relevancy based queries "
+ "across a variety of fields using configured boosts";
}
@Override
public String getVersion() {
return "$Revision: 630746 $";
}
@Override
public String getSourceId() {
return "$Id: DisMaxRequestHandler.java 630746 2008-02-25 07:02:09Z hossman $";
}
@Override
public String getSource() {
return "$URL: https://svn.apache.org/repos/asf/lucene/dev/branches/lucene_solr_3_5/solr/core/src/java/org/apache/solr/handler/DisMaxRequestHandler.java $";
}
@Override
public URL[] getDocs() {
try {
return new URL[] { new URL("http://wiki.apache.org/solr/DisMaxRequestHandler") };
}
catch( MalformedURLException ex ) { return null; }
}
}