| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.3"/> |
| <title>Lucene.Net: Lucene.Net.Index.IndexWriter.MaxFieldLength Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Lucene.Net |
|  <span id="projectnumber">3.0.3</span> |
| </div> |
| <div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.3 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="Index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Packages</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Properties</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_index.html">Index</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html">IndexWriter</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html">MaxFieldLength</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.IndexWriter.MaxFieldLength Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Specifies maximum field length (in number of tokens/terms) in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html" title="An IndexWriter creates and maintains an index. The create argument to the constructor determines whet...">IndexWriter</a> constructors. <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html#a91be1a71d5a51f7232dc2b6f5e021d9e" title="The maximum number of terms that will be indexed for a single field in a document. This limits the amount of memory required for indexing, so that collections with very large files will not crash the indexing process by running out of memory. This setting refers to the number of running terms, not to the number of different terms.Note: this silently truncates large documents, excluding from the index all terms that occur further in the document. If you know your source documents are large, be sure to set this value high enough to accomodate the expected size. If you set it to Integer.MAX_VALUE, then the only limit is your memory, but you should anticipate an OutOfMemoryError.By default, no more than DEFAULT_MAX_FIELD_LENGTH terms will be indexed for a field. ">SetMaxFieldLength(int)</a> overrides the value set by the constructor. |
| <a href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:ac9eabe4070f65ffc2b1b90a991fab5d0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html#ac9eabe4070f65ffc2b1b90a991fab5d0">MaxFieldLength</a> (int limit)</td></tr> |
| <tr class="memdesc:ac9eabe4070f65ffc2b1b90a991fab5d0"><td class="mdescLeft"> </td><td class="mdescRight">Public constructor to allow users to specify the maximum field size limit. <a href="#ac9eabe4070f65ffc2b1b90a991fab5d0"></a><br/></td></tr> |
| <tr class="separator:ac9eabe4070f65ffc2b1b90a991fab5d0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a20bede1e17ebc4adfa8ed91e98bed609"><td class="memItemLeft" align="right" valign="top">override System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html#a20bede1e17ebc4adfa8ed91e98bed609">ToString</a> ()</td></tr> |
| <tr class="separator:a20bede1e17ebc4adfa8ed91e98bed609"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:a111a961b0e90ba30df67682176cb1e31"><td class="memItemLeft" align="right" valign="top">static readonly <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html">MaxFieldLength</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html#a111a961b0e90ba30df67682176cb1e31">UNLIMITED</a> = new <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html">MaxFieldLength</a>("UNLIMITED", System.Int32.MaxValue)</td></tr> |
| <tr class="memdesc:a111a961b0e90ba30df67682176cb1e31"><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum field length to int.MaxValue. <a href="#a111a961b0e90ba30df67682176cb1e31"></a><br/></td></tr> |
| <tr class="separator:a111a961b0e90ba30df67682176cb1e31"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d37d3637032877c4c0474cc8f192c34"><td class="memItemLeft" align="right" valign="top">static readonly <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html">MaxFieldLength</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html#a1d37d3637032877c4c0474cc8f192c34">LIMITED</a></td></tr> |
| <tr class="memdesc:a1d37d3637032877c4c0474cc8f192c34"><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum field length to <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html#a7295b9b97b02ed5a179bbc3778f10e57" title="Default value is 10,000. Change using SetMaxFieldLength(int).">DEFAULT_MAX_FIELD_LENGTH</a> <a href="#a1d37d3637032877c4c0474cc8f192c34"></a><br/></td></tr> |
| <tr class="separator:a1d37d3637032877c4c0474cc8f192c34"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a1aabbc277d3e6bf6ebb71e7995dc2a41"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html#a1aabbc277d3e6bf6ebb71e7995dc2a41">Limit</a><code> [get]</code></td></tr> |
| <tr class="separator:a1aabbc277d3e6bf6ebb71e7995dc2a41"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Specifies maximum field length (in number of tokens/terms) in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html" title="An IndexWriter creates and maintains an index. The create argument to the constructor determines whet...">IndexWriter</a> constructors. <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html#a91be1a71d5a51f7232dc2b6f5e021d9e" title="The maximum number of terms that will be indexed for a single field in a document. This limits the amount of memory required for indexing, so that collections with very large files will not crash the indexing process by running out of memory. This setting refers to the number of running terms, not to the number of different terms.Note: this silently truncates large documents, excluding from the index all terms that occur further in the document. If you know your source documents are large, be sure to set this value high enough to accomodate the expected size. If you set it to Integer.MAX_VALUE, then the only limit is your memory, but you should anticipate an OutOfMemoryError.By default, no more than DEFAULT_MAX_FIELD_LENGTH terms will be indexed for a field. ">SetMaxFieldLength(int)</a> overrides the value set by the constructor. </p> |
| |
| <p>Definition at line <a class="el" href="_index_writer_8cs_source.html#l05783">5783</a> of file <a class="el" href="_index_writer_8cs_source.html">IndexWriter.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="ac9eabe4070f65ffc2b1b90a991fab5d0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Index.IndexWriter.MaxFieldLength.MaxFieldLength </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>limit</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Public constructor to allow users to specify the maximum field size limit. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">limit</td><td>The maximum field length </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_index_writer_8cs_source.html#l05807">5807</a> of file <a class="el" href="_index_writer_8cs_source.html">IndexWriter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a20bede1e17ebc4adfa8ed91e98bed609"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.String Lucene.Net.Index.IndexWriter.MaxFieldLength.ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_index_writer_8cs_source.html#l05816">5816</a> of file <a class="el" href="_index_writer_8cs_source.html">IndexWriter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="a1d37d3637032877c4c0474cc8f192c34"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">readonly <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html">MaxFieldLength</a> Lucene.Net.Index.IndexWriter.MaxFieldLength.LIMITED</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the maximum field length to <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html#a7295b9b97b02ed5a179bbc3778f10e57" title="Default value is 10,000. Change using SetMaxFieldLength(int).">DEFAULT_MAX_FIELD_LENGTH</a> </p> |
| |
| <p>Definition at line <a class="el" href="_index_writer_8cs_source.html#l05828">5828</a> of file <a class="el" href="_index_writer_8cs_source.html">IndexWriter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a111a961b0e90ba30df67682176cb1e31"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">readonly <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html">MaxFieldLength</a> Lucene.Net.Index.IndexWriter.MaxFieldLength.UNLIMITED = new <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer_1_1_max_field_length.html">MaxFieldLength</a>("UNLIMITED", System.Int32.MaxValue)</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the maximum field length to int.MaxValue. </p> |
| |
| <p>Definition at line <a class="el" href="_index_writer_8cs_source.html#l05822">5822</a> of file <a class="el" href="_index_writer_8cs_source.html">IndexWriter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a1aabbc277d3e6bf6ebb71e7995dc2a41"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Index.IndexWriter.MaxFieldLength.Limit</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_index_writer_8cs_source.html#l05812">5812</a> of file <a class="el" href="_index_writer_8cs_source.html">IndexWriter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Index/<a class="el" href="_index_writer_8cs_source.html">IndexWriter.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:54 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
