blob: ab6363f1d2e08b8244ea2ec4fe7efd89fbfdcd7d [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Namespace Lucene.Net.QueryParsers.Xml
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Lucene.Net.QueryParsers.Xml
| Apache Lucene.NET 4.8.0-beta00010 Documentation ">
<meta name="generator" content="docfx 2.56.0.0">
<link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="queryparser/toc.html">
<meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search">
<ul class="level0 breadcrumb">
<li>
<a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a>
<span id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</span>
</li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Lucene.Net.QueryParsers.Xml">
<h1 id="Lucene_Net_QueryParsers_Xml" data-uid="Lucene.Net.QueryParsers.Xml" class="text-break">Namespace Lucene.Net.QueryParsers.Xml
</h1>
<div class="markdown level0 summary"><!--
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.
-->
<p>Parser that produces Lucene Query objects from XML streams.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.CoreParser.html">CoreParser</a></h4>
<section><p>Assembles a <a class="xref" href="Lucene.Net.QueryParsers.Xml.IQueryBuilder.html">IQueryBuilder</a> which uses only core Lucene Query objects</p>
</section>
<h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.CorePlusExtensionsParser.html">CorePlusExtensionsParser</a></h4>
<section><p>Assembles a <span class="xref">Lucene.Net.Util.QueryBuilder</span> which uses <span class="xref">Lucene.Net.Search.Query</span> objects from
Lucene&apos;s <code>sandbox</code> and <code>queries</code>
modules in addition to core queries.</p>
</section>
<h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.DOMUtils.html">DOMUtils</a></h4>
<section><p>Helper methods for parsing XML</p>
</section>
<h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.FilterBuilderFactory.html">FilterBuilderFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.QueryParsers.Xml.IFilterBuilder.html">IFilterBuilder</a></p>
</section>
<h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.ParserException.html">ParserException</a></h4>
<section><p>Thrown when the xml queryparser encounters
invalid syntax/configuration.</p>
</section>
<h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.QueryBuilderFactory.html">QueryBuilderFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.QueryParsers.Xml.IQueryBuilder.html">IQueryBuilder</a></p>
</section>
<h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.QueryTemplateManager.html">QueryTemplateManager</a></h4>
<section><p>Provides utilities for turning query form input (such as from a web page or Swing gui) into
Lucene XML queries by using XSL templates. This approach offers a convenient way of externalizing
and changing how user input is turned into Lucene queries.
Database applications often adopt similar practices by externalizing SQL in template files that can
be easily changed/optimized by a DBA.
The static methods can be used on their own or by creating an instance of this class you can store and
re-use compiled stylesheets for fast use (e.g. in a server environment)</p>
<p>LUCENENET (.NET Core): This is not compiled this because .NET Standard
does not currently support XSL Transform.</p>
</section>
<h3 id="interfaces">Interfaces
</h3>
<h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.IFilterBuilder.html">IFilterBuilder</a></h4>
<section><p>Interface for building <span class="xref">Lucene.Net.Search.Filter</span>s</p>
</section>
<h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.IQueryBuilder.html">IQueryBuilder</a></h4>
<section><p>Implemented by objects that produce Lucene Query objects from XML streams. Implementations are
expected to be thread-safe so that they can be used to simultaneously parse multiple XML documents.</p>
</section>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/blob/docs/4.8.0-beta00010/src/Lucene.Net.QueryParser/Xml/package.md/#L2" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © 2020 Licensed to the Apache Software Foundation (ASF)
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script>
</body>
</html>