blob: f41b039b6873d6f567108493398b691d3896d59d [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>Class TermQueryPrefixTreeStrategy
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class TermQueryPrefixTreeStrategy
| 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="spatial/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.Spatial.Prefix.TermQueryPrefixTreeStrategy">
<h1 id="Lucene_Net_Spatial_Prefix_TermQueryPrefixTreeStrategy" data-uid="Lucene.Net.Spatial.Prefix.TermQueryPrefixTreeStrategy" class="text-break">Class TermQueryPrefixTreeStrategy
</h1>
<div class="markdown level0 summary"><p>A basic implementation of <a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html">PrefixTreeStrategy</a> using a large
<span class="xref">Lucene.Net.Queries.TermsFilter</span> of all the cells from
<a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html#Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_GetCells_Spatial4n_Core_Shapes_IShape_System_Int32_System_Boolean_System_Boolean_">GetCells(IShape, Int32, Boolean, Boolean)</a>.
It only supports the search of indexed Point shapes.
<p>
The precision of query shapes (DistErrPct) is an important factor in using
this Strategy. If the precision is too precise then it will result in many
terms which will amount to a slower query.</p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html">SpatialStrategy</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html">PrefixTreeStrategy</a></div>
<div class="level3"><span class="xref">TermQueryPrefixTreeStrategy</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_m_grid">PrefixTreeStrategy.m_grid</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_m_simplifyIndexedCells">PrefixTreeStrategy.m_simplifyIndexedCells</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_m_defaultFieldValuesArrayLen">PrefixTreeStrategy.m_defaultFieldValuesArrayLen</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_m_distErrPct">PrefixTreeStrategy.m_distErrPct</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_DefaultFieldValuesArrayLen">PrefixTreeStrategy.DefaultFieldValuesArrayLen</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_DistErrPct">PrefixTreeStrategy.DistErrPct</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_CreateIndexableFields_Spatial4n_Core_Shapes_IShape_">PrefixTreeStrategy.CreateIndexableFields(IShape)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_CreateIndexableFields_Spatial4n_Core_Shapes_IShape_System_Double_">PrefixTreeStrategy.CreateIndexableFields(IShape, Double)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_FIELD_TYPE">PrefixTreeStrategy.FIELD_TYPE</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_System_Double_">PrefixTreeStrategy.MakeDistanceValueSource(IPoint, Double)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html#Lucene_Net_Spatial_Prefix_PrefixTreeStrategy_Grid">PrefixTreeStrategy.Grid</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_m_ctx">SpatialStrategy.m_ctx</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_SpatialContext">SpatialStrategy.SpatialContext</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_FieldName">SpatialStrategy.FieldName</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_">SpatialStrategy.MakeDistanceValueSource(IPoint)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeQuery_Lucene_Net_Spatial_Queries_SpatialArgs_">SpatialStrategy.MakeQuery(SpatialArgs)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeRecipDistanceValueSource_Spatial4n_Core_Shapes_IShape_">SpatialStrategy.MakeRecipDistanceValueSource(IShape)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_ToString">SpatialStrategy.ToString()</a>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Spatial.Prefix.html">Lucene.Net.Spatial.Prefix</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Spatial.dll</h6>
<h5 id="Lucene_Net_Spatial_Prefix_TermQueryPrefixTreeStrategy_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class TermQueryPrefixTreeStrategy : PrefixTreeStrategy</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_TermQueryPrefixTreeStrategy__ctor_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.TermQueryPrefixTreeStrategy.%23ctor(Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/TermQueryPrefixTreeStrategy.cs/#L42">View Source</a>
</span>
<a id="Lucene_Net_Spatial_Prefix_TermQueryPrefixTreeStrategy__ctor_" data-uid="Lucene.Net.Spatial.Prefix.TermQueryPrefixTreeStrategy.#ctor*"></a>
<h4 id="Lucene_Net_Spatial_Prefix_TermQueryPrefixTreeStrategy__ctor_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_String_" data-uid="Lucene.Net.Spatial.Prefix.TermQueryPrefixTreeStrategy.#ctor(Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree,System.String)">TermQueryPrefixTreeStrategy(SpatialPrefixTree, String)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TermQueryPrefixTreeStrategy(SpatialPrefixTree grid, string fieldName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree.html">SpatialPrefixTree</a></td>
<td><span class="parametername">grid</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">fieldName</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_TermQueryPrefixTreeStrategy_MakeFilter_Lucene_Net_Spatial_Queries_SpatialArgs_.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.TermQueryPrefixTreeStrategy.MakeFilter(Lucene.Net.Spatial.Queries.SpatialArgs)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/TermQueryPrefixTreeStrategy.cs/#L47">View Source</a>
</span>
<a id="Lucene_Net_Spatial_Prefix_TermQueryPrefixTreeStrategy_MakeFilter_" data-uid="Lucene.Net.Spatial.Prefix.TermQueryPrefixTreeStrategy.MakeFilter*"></a>
<h4 id="Lucene_Net_Spatial_Prefix_TermQueryPrefixTreeStrategy_MakeFilter_Lucene_Net_Spatial_Queries_SpatialArgs_" data-uid="Lucene.Net.Spatial.Prefix.TermQueryPrefixTreeStrategy.MakeFilter(Lucene.Net.Spatial.Queries.SpatialArgs)">MakeFilter(SpatialArgs)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Filter MakeFilter(SpatialArgs args)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Spatial.Queries.SpatialArgs.html">SpatialArgs</a></td>
<td><span class="parametername">args</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Lucene.Net.Search.Filter</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeFilter_Lucene_Net_Spatial_Queries_SpatialArgs_">SpatialStrategy.MakeFilter(SpatialArgs)</a></div>
</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/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_TermQueryPrefixTreeStrategy.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.TermQueryPrefixTreeStrategy%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Spatial/Prefix/TermQueryPrefixTreeStrategy.cs/#L40" class="contribution-link">View Source</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>