blob: 7842523081114027eab714a1a3c8eb1e8e355d48 [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 ContainsPrefixTreeFilter
| Apache Lucene.NET 4.8.0-beta00011 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ContainsPrefixTreeFilter
| Apache Lucene.NET 4.8.0-beta00011 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.ContainsPrefixTreeFilter">
<h1 id="Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter" data-uid="Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter" class="text-break">Class ContainsPrefixTreeFilter
</h1>
<div class="markdown level0 summary"><p>Finds docs where its indexed shape <a class="xref" href="Lucene.Net.Spatial.Queries.SpatialOperation.html#Lucene_Net_Spatial_Queries_SpatialOperation_Contains">Contains</a>
the query shape. For use on <a class="xref" href="Lucene.Net.Spatial.Prefix.RecursivePrefixTreeStrategy.html">RecursivePrefixTreeStrategy</a>.</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"><span class="xref">Lucene.Net.Search.Filter</span></div>
<div class="level2"><a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractPrefixTreeFilter.html">AbstractPrefixTreeFilter</a></div>
<div class="level3"><span class="xref">ContainsPrefixTreeFilter</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractPrefixTreeFilter_m_queryShape">AbstractPrefixTreeFilter.m_queryShape</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractPrefixTreeFilter_m_fieldName">AbstractPrefixTreeFilter.m_fieldName</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractPrefixTreeFilter_m_grid">AbstractPrefixTreeFilter.m_grid</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractPrefixTreeFilter_m_detailLevel">AbstractPrefixTreeFilter.m_detailLevel</a>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Filter.html#Lucene_Net_Search_Filter_NewAnonymous_System_Func_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_Lucene_Net_Search_DocIdSet__">Filter.NewAnonymous(Func&lt;AtomicReaderContext, IBits, DocIdSet&gt;)</a>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</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>
<span class="xref">System.Object.ToString()</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_ContainsPrefixTreeFilter_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ContainsPrefixTreeFilter : AbstractPrefixTreeFilter</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter__ctor_Spatial4n_Core_Shapes_IShape_System_String_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_Int32_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.%23ctor(Spatial4n.Core.Shapes.IShape%2CSystem.String%2CLucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree%2CSystem.Int32%2CSystem.Boolean)%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_beta00011/src/Lucene.Net.Spatial/Prefix/ContainsPrefixTreeFilter.cs/#L50">View Source</a>
</span>
<a id="Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter__ctor_" data-uid="Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.#ctor*"></a>
<h4 id="Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter__ctor_Spatial4n_Core_Shapes_IShape_System_String_Lucene_Net_Spatial_Prefix_Tree_SpatialPrefixTree_System_Int32_System_Boolean_" data-uid="Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.#ctor(Spatial4n.Core.Shapes.IShape,System.String,Lucene.Net.Spatial.Prefix.Tree.SpatialPrefixTree,System.Int32,System.Boolean)">ContainsPrefixTreeFilter(IShape, String, SpatialPrefixTree, Int32, Boolean)</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 ContainsPrefixTreeFilter(IShape queryShape, string fieldName, SpatialPrefixTree grid, int detailLevel, bool multiOverlappingIndexedShapes)</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><span class="xref">Spatial4n.Core.Shapes.IShape</span></td>
<td><span class="parametername">queryShape</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">fieldName</span></td>
<td></td>
</tr>
<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.Int32</span></td>
<td><span class="parametername">detailLevel</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">multiOverlappingIndexedShapes</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter_m_multiOverlappingIndexedShapes.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.m_multiOverlappingIndexedShapes%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_beta00011/src/Lucene.Net.Spatial/Prefix/ContainsPrefixTreeFilter.cs/#L48">View Source</a>
</span>
<h4 id="Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter_m_multiOverlappingIndexedShapes" data-uid="Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.m_multiOverlappingIndexedShapes">m_multiOverlappingIndexedShapes</h4>
<div class="markdown level1 summary"><p>If the spatial data for a document is comprised of multiple overlapping or adjacent parts,
it might fail to match a query shape when doing the CONTAINS predicate when the sum of
those shapes contain the query shape but none do individually. Set this to false to
increase performance if you don&apos;t care about that circumstance (such as if your indexed
data doesn&apos;t even have such conditions). See LUCENE-5062.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected readonly bool m_multiOverlappingIndexedShapes</code></pre>
</div>
<h5 class="fieldValue">Field Value</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">System.Boolean</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter_Equals_System_Object_.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.Equals(System.Object)%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_beta00011/src/Lucene.Net.Spatial/Prefix/ContainsPrefixTreeFilter.cs/#L56">View Source</a>
</span>
<a id="Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter_Equals_" data-uid="Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.Equals*"></a>
<h4 id="Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter_Equals_System_Object_" data-uid="Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.Equals(System.Object)">Equals(Object)</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 bool Equals(object o)</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><span class="xref">System.Object</span></td>
<td><span class="parametername">o</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">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractPrefixTreeFilter_Equals_System_Object_">AbstractPrefixTreeFilter.Equals(Object)</a></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter_GetDocIdSet_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.GetDocIdSet(Lucene.Net.Index.AtomicReaderContext%2CLucene.Net.Util.IBits)%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_beta00011/src/Lucene.Net.Spatial/Prefix/ContainsPrefixTreeFilter.cs/#L68">View Source</a>
</span>
<a id="Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter_GetDocIdSet_" data-uid="Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.GetDocIdSet*"></a>
<h4 id="Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter_GetDocIdSet_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_" data-uid="Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.GetDocIdSet(Lucene.Net.Index.AtomicReaderContext,Lucene.Net.Util.IBits)">GetDocIdSet(AtomicReaderContext, IBits)</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 DocIdSet GetDocIdSet(AtomicReaderContext context, IBits acceptDocs)</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><span class="xref">Lucene.Net.Index.AtomicReaderContext</span></td>
<td><span class="parametername">context</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.IBits</span></td>
<td><span class="parametername">acceptDocs</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.DocIdSet</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Search.Filter.GetDocIdSet(Lucene.Net.Index.AtomicReaderContext, Lucene.Net.Util.IBits)</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter_GetHashCode.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.GetHashCode%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_beta00011/src/Lucene.Net.Spatial/Prefix/ContainsPrefixTreeFilter.cs/#L63">View Source</a>
</span>
<a id="Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter_GetHashCode_" data-uid="Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.GetHashCode*"></a>
<h4 id="Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter_GetHashCode" data-uid="Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter.GetHashCode">GetHashCode()</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 int GetHashCode()</code></pre>
</div>
<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">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Spatial.Prefix.AbstractPrefixTreeFilter.html#Lucene_Net_Spatial_Prefix_AbstractPrefixTreeFilter_GetHashCode">AbstractPrefixTreeFilter.GetHashCode()</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Prefix_ContainsPrefixTreeFilter.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Prefix.ContainsPrefixTreeFilter%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_beta00011/src/Lucene.Net.Spatial/Prefix/ContainsPrefixTreeFilter.cs/#L36" 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>