blob: 2512265b42db6754f1a9b977d2d43f2e2cd798c7 [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 FieldFragList
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class FieldFragList
| Apache Lucene.NET 4.8.0-beta00013 Documentation ">
<meta name="generator" content="docfx 2.56.2.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="highlighter/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">
<span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span>
<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.Search.VectorHighlight.FieldFragList">
<h1 id="Lucene_Net_Search_VectorHighlight_FieldFragList" data-uid="Lucene.Net.Search.VectorHighlight.FieldFragList" class="text-break">Class FieldFragList
</h1>
<div class="markdown level0 summary"><p>FieldFragList has a list of &quot;frag info&quot; that is used by <a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a> class
to create fragments (snippets).</p>
</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">FieldFragList</span></div>
<div class="level2"><a class="xref" href="Lucene.Net.Search.VectorHighlight.SimpleFieldFragList.html">SimpleFieldFragList</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Search.VectorHighlight.WeightedFieldFragList.html">WeightedFieldFragList</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<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>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.VectorHighlight.html">Lucene.Net.Search.VectorHighlight</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Highlighter.dll</h6>
<h5 id="Lucene_Net_Search_VectorHighlight_FieldFragList_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class FieldFragList</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_VectorHighlight_FieldFragList__ctor_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FieldFragList.%23ctor(System.Int32)%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/fix/apidocs-layout/src/Lucene.Net.Highlighter/VectorHighlight/FieldFragList.cs/#L39">View Source</a>
</span>
<a id="Lucene_Net_Search_VectorHighlight_FieldFragList__ctor_" data-uid="Lucene.Net.Search.VectorHighlight.FieldFragList.#ctor*"></a>
<h4 id="Lucene_Net_Search_VectorHighlight_FieldFragList__ctor_System_Int32_" data-uid="Lucene.Net.Search.VectorHighlight.FieldFragList.#ctor(System.Int32)">FieldFragList(Int32)</h4>
<div class="markdown level1 summary"><p>a constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected FieldFragList(int fragCharSize)</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.Int32</span></td>
<td><span class="parametername">fragCharSize</span></td>
<td><p>the length (number of chars) of a fragment</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_VectorHighlight_FieldFragList_FragInfos.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FieldFragList.FragInfos%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/fix/apidocs-layout/src/Lucene.Net.Highlighter/VectorHighlight/FieldFragList.cs/#L55">View Source</a>
</span>
<a id="Lucene_Net_Search_VectorHighlight_FieldFragList_FragInfos_" data-uid="Lucene.Net.Search.VectorHighlight.FieldFragList.FragInfos*"></a>
<h4 id="Lucene_Net_Search_VectorHighlight_FieldFragList_FragInfos" data-uid="Lucene.Net.Search.VectorHighlight.FieldFragList.FragInfos">FragInfos</h4>
<div class="markdown level1 summary"><p>return the list of <a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldFragList.WeightedFragInfo.html">FieldFragList.WeightedFragInfo</a>s.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IList&lt;FieldFragList.WeightedFragInfo&gt; FragInfos { get; }</code></pre>
</div>
<h5 class="propertyValue">Property 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.Collections.Generic.IList</span>&lt;<a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldFragList.WeightedFragInfo.html">FieldFragList.WeightedFragInfo</a>&gt;</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_VectorHighlight_FieldFragList_Add_System_Int32_System_Int32_System_Collections_Generic_IList_Lucene_Net_Search_VectorHighlight_FieldPhraseList_WeightedPhraseInfo__.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FieldFragList.Add(System.Int32%2CSystem.Int32%2CSystem.Collections.Generic.IList%7BLucene.Net.Search.VectorHighlight.FieldPhraseList.WeightedPhraseInfo%7D)%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/fix/apidocs-layout/src/Lucene.Net.Highlighter/VectorHighlight/FieldFragList.cs/#L50">View Source</a>
</span>
<a id="Lucene_Net_Search_VectorHighlight_FieldFragList_Add_" data-uid="Lucene.Net.Search.VectorHighlight.FieldFragList.Add*"></a>
<h4 id="Lucene_Net_Search_VectorHighlight_FieldFragList_Add_System_Int32_System_Int32_System_Collections_Generic_IList_Lucene_Net_Search_VectorHighlight_FieldPhraseList_WeightedPhraseInfo__" data-uid="Lucene.Net.Search.VectorHighlight.FieldFragList.Add(System.Int32,System.Int32,System.Collections.Generic.IList{Lucene.Net.Search.VectorHighlight.FieldPhraseList.WeightedPhraseInfo})">Add(Int32, Int32, IList&lt;FieldPhraseList.WeightedPhraseInfo&gt;)</h4>
<div class="markdown level1 summary"><p>convert the list of <a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldPhraseList.WeightedPhraseInfo.html">FieldPhraseList.WeightedPhraseInfo</a> to <a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldFragList.WeightedFragInfo.html">FieldFragList.WeightedFragInfo</a>, then add it to the fragInfos</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract void Add(int startOffset, int endOffset, IList&lt;FieldPhraseList.WeightedPhraseInfo&gt; phraseInfoList)</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.Int32</span></td>
<td><span class="parametername">startOffset</span></td>
<td><p>start offset of the fragment</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">endOffset</span></td>
<td><p>end offset of the fragment</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.IList</span>&lt;<a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldPhraseList.WeightedPhraseInfo.html">FieldPhraseList.WeightedPhraseInfo</a>&gt;</td>
<td><span class="parametername">phraseInfoList</span></td>
<td><p>list of <a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldPhraseList.WeightedPhraseInfo.html">FieldPhraseList.WeightedPhraseInfo</a> objects</p>
</td>
</tr>
</tbody>
</table>
</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_VectorHighlight_FieldFragList.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FieldFragList%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/fix/apidocs-layout/src/Lucene.Net.Highlighter/VectorHighlight/FieldFragList.cs/#L30" 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 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small>
</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>