org.apache.solr.search.XmlQParserPlugin Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of solr-core Show documentation
Show all versions of solr-core Show documentation
Apache Solr (module: core)
/*
* 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.search;
import java.io.ByteArrayInputStream;
import java.nio.charset.StandardCharsets;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.queryparser.xml.ParserException;
import org.apache.lucene.search.Query;
import org.apache.solr.common.params.CommonParams;
import org.apache.solr.common.params.SolrParams;
import org.apache.solr.common.util.NamedList;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.schema.IndexSchema;
/**
* The {@link XmlQParserPlugin} extends the {@link QParserPlugin} and supports the creation of queries from XML.
*
* Example:
*
<BooleanQuery fieldName="description">
<Clause occurs="must">
<TermQuery>shirt</TermQuery>
</Clause>
<Clause occurs="mustnot">
<TermQuery>plain</TermQuery>
</Clause>
<Clause occurs="should">
<TermQuery>cotton</TermQuery>
</Clause>
<Clause occurs="must">
<BooleanQuery fieldName="size">
<Clause occurs="should">
<TermsQuery>S M L</TermsQuery>
</Clause>
</BooleanQuery>
</Clause>
</BooleanQuery>
* You can configure your own custom query builders for additional XML elements.
* The custom builders need to extend the {@link SolrQueryBuilder} or the
* {@link SolrSpanQueryBuilder} class.
*
* Example solrconfig.xml snippet:
*
<queryParser name="xmlparser" class="XmlQParserPlugin">
<str name="MyCustomQuery">com.mycompany.solr.search.MyCustomQueryBuilder</str>
</queryParser>
*/
public class XmlQParserPlugin extends QParserPlugin {
public static final String NAME = "xmlparser";
private NamedList args;
@Override
public void init( NamedList args ) {
super.init(args);
this.args = args;
}
private class XmlQParser extends QParser {
public XmlQParser(String qstr, SolrParams localParams,
SolrParams params, SolrQueryRequest req) {
super(qstr, localParams, params, req);
}
public Query parse() throws SyntaxError {
final String qstr = getString();
if (qstr == null || qstr.isEmpty()) {
return null;
}
final IndexSchema schema = req.getSchema();
final String defaultField = getParam(CommonParams.DF);
final Analyzer analyzer = schema.getQueryAnalyzer();
final SolrCoreParser solrParser = new SolrCoreParser(defaultField, analyzer, req);
solrParser.init(args);
try {
return solrParser.parse(new ByteArrayInputStream(qstr.getBytes(StandardCharsets.UTF_8)));
} catch (ParserException e) {
throw new SyntaxError(e.getMessage() + " in " + req.toString());
}
}
}
public QParser createParser(String qstr, SolrParams localParams,
SolrParams params, SolrQueryRequest req) {
return new XmlQParser(qstr, localParams, params, req);
}
}