/*
 * 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;

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);
  }

}

@@ -1289,16 +1289,1207 @@
 chema;%0A%0A
+/**%0A * The %7B@link XmlQParserPlugin%7D extends the %7B@link QParserPlugin%7D and supports the creation of queries from XML.%0A *%3Cp%3E%0A * Example:%0A * %3Cpre%3E%0A&lt;BooleanQuery fieldName=%22description%22&gt;%0A   &lt;Clause occurs=%22must%22&gt;%0A      &lt;TermQuery&gt;shirt&lt;/TermQuery&gt;%0A   &lt;/Clause&gt;%0A   &lt;Clause occurs=%22mustnot%22&gt;%0A      &lt;TermQuery&gt;plain&lt;/TermQuery&gt;%0A   &lt;/Clause&gt;%0A   &lt;Clause occurs=%22should%22&gt;%0A      &lt;TermQuery&gt;cotton&lt;/TermQuery&gt;%0A   &lt;/Clause&gt;%0A   &lt;Clause occurs=%22must%22&gt;%0A      &lt;BooleanQuery fieldName=%22size%22&gt;%0A         &lt;Clause occurs=%22should%22&gt;%0A            &lt;TermsQuery&gt;S M L&lt;/TermsQuery&gt;%0A         &lt;/Clause&gt;%0A      &lt;/BooleanQuery&gt;%0A   &lt;/Clause&gt;%0A&lt;/BooleanQuery&gt;%0A%3C/pre%3E%0A * You can configure your own custom query builders for additional XML elements.%0A * The custom builders need to extend the %7B@link SolrQueryBuilder%7D or the%0A * %7B@link SolrSpanQueryBuilder%7D class.%0A *%3Cp%3E%0A * Example solrconfig.xml snippet:%0A * %3Cpre%3E&lt;queryParser name=%22xmlparser%22 class=%22XmlQParserPlugin%22&gt;%0A  &lt;str name=%22MyCustomQuery%22&gt;com.mycompany.solr.search.MyCustomQueryBuilder&lt;/str&gt;%0A&lt;/queryParser&gt;%0A%3C/pre%3E%0A */%0A
 public c

add javadocs for XmlQParserPlugin class.