| <!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.Documents.Document 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_documents.html">Documents</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html">Document</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_documents_1_1_document-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Documents.Document Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="namespace_lucene_1_1_net_1_1_documents.html">Documents</a> are the unit of indexing and search. |
| <a href="class_lucene_1_1_net_1_1_documents_1_1_document.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:aa52ffd7ef0a06212a49184862d6bcc16"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#aa52ffd7ef0a06212a49184862d6bcc16">Document</a> ()</td></tr> |
| <tr class="memdesc:aa52ffd7ef0a06212a49184862d6bcc16"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new document with no fields. <a href="#aa52ffd7ef0a06212a49184862d6bcc16"></a><br/></td></tr> |
| <tr class="separator:aa52ffd7ef0a06212a49184862d6bcc16"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acd45aa28de7754d34357017ecb5a1aea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#acd45aa28de7754d34357017ecb5a1aea">Add</a> (<a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a> field)</td></tr> |
| <tr class="memdesc:acd45aa28de7754d34357017ecb5a1aea"><td class="mdescLeft"> </td><td class="mdescRight">Adds a field to a document. Several fields may be added with the same name. In this case, if the fields are indexed, their text is treated as though appended for the purposes of search.Note that add like the removeField(s) methods only makes sense prior to adding a document to an index. These methods cannot be used to change the content of an existing index! In order to achieve this, a document has to be deleted from an index and a new changed version of that document has to be added. <a href="#acd45aa28de7754d34357017ecb5a1aea"></a><br/></td></tr> |
| <tr class="separator:acd45aa28de7754d34357017ecb5a1aea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a847e19ea26c262dde379f4cd072f1de5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#a847e19ea26c262dde379f4cd072f1de5">RemoveField</a> (System.String name)</td></tr> |
| <tr class="memdesc:a847e19ea26c262dde379f4cd072f1de5"><td class="mdescLeft"> </td><td class="mdescRight">Removes field with the specified name from the document. If multiple fields exist with this name, this method removes the first field that has been added. If there is no field with the specified name, the document remains unchanged.Note that the removeField(s) methods like the add method only make sense prior to adding a document to an index. These methods cannot be used to change the content of an existing index! In order to achieve this, a document has to be deleted from an index and a new changed version of that document has to be added. <a href="#a847e19ea26c262dde379f4cd072f1de5"></a><br/></td></tr> |
| <tr class="separator:a847e19ea26c262dde379f4cd072f1de5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a75d6796acaac8ca39daf98029ab013c1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#a75d6796acaac8ca39daf98029ab013c1">RemoveFields</a> (System.String name)</td></tr> |
| <tr class="memdesc:a75d6796acaac8ca39daf98029ab013c1"><td class="mdescLeft"> </td><td class="mdescRight">Removes all fields with the given name from the document. If there is no field with the specified name, the document remains unchanged.Note that the removeField(s) methods like the add method only make sense prior to adding a document to an index. These methods cannot be used to change the content of an existing index! In order to achieve this, a document has to be deleted from an index and a new changed version of that document has to be added. <a href="#a75d6796acaac8ca39daf98029ab013c1"></a><br/></td></tr> |
| <tr class="separator:a75d6796acaac8ca39daf98029ab013c1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae6a3a61481d324e3146fdaa002f52dff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html">Field</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#ae6a3a61481d324e3146fdaa002f52dff">GetField</a> (System.String name)</td></tr> |
| <tr class="memdesc:ae6a3a61481d324e3146fdaa002f52dff"><td class="mdescLeft"> </td><td class="mdescRight">Returns a field with the given name if any exist in this document, or null. If multiple fields exists with this name, this method returns the first value added. Do not use this method with lazy loaded fields. <a href="#ae6a3a61481d324e3146fdaa002f52dff"></a><br/></td></tr> |
| <tr class="separator:ae6a3a61481d324e3146fdaa002f52dff"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16575756a78511475e219debd31ea090"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#a16575756a78511475e219debd31ea090">GetFieldable</a> (System.String name)</td></tr> |
| <tr class="memdesc:a16575756a78511475e219debd31ea090"><td class="mdescLeft"> </td><td class="mdescRight">Returns a field with the given name if any exist in this document, or null. If multiple fields exists with this name, this method returns the first value added. <a href="#a16575756a78511475e219debd31ea090"></a><br/></td></tr> |
| <tr class="separator:a16575756a78511475e219debd31ea090"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab279a2d40744d95895e01cc16965887b"><td class="memItemLeft" align="right" valign="top">System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#ab279a2d40744d95895e01cc16965887b">Get</a> (System.String name)</td></tr> |
| <tr class="memdesc:ab279a2d40744d95895e01cc16965887b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the string value of the field with the given name if any exist in this document, or null. If multiple fields exist with this name, this method returns the first value added. If only binary fields with this name exist, returns null. <a href="#ab279a2d40744d95895e01cc16965887b"></a><br/></td></tr> |
| <tr class="separator:ab279a2d40744d95895e01cc16965887b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac6494808927ec84c6ae9bda2c815918e"><td class="memItemLeft" align="right" valign="top">System.Collections.Generic.IList<br class="typebreak"/> |
| < <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#ac6494808927ec84c6ae9bda2c815918e">GetFields</a> ()</td></tr> |
| <tr class="memdesc:ac6494808927ec84c6ae9bda2c815918e"><td class="mdescLeft"> </td><td class="mdescRight">Returns a List of all the fields in a document. Note that fields which are <em>not</em> <a class="el" href="">stored</a> are <em>not</em> available in documents retrieved from the index, e.g. Searcher.Doc(int) or IndexReader.Document(int). <a href="#ac6494808927ec84c6ae9bda2c815918e"></a><br/></td></tr> |
| <tr class="separator:ac6494808927ec84c6ae9bda2c815918e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3430eabeb9c2927ea29b723086f2a36b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html">Field</a>[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#a3430eabeb9c2927ea29b723086f2a36b">GetFields</a> (System.String name)</td></tr> |
| <tr class="memdesc:a3430eabeb9c2927ea29b723086f2a36b"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array of <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a>s with the given name. Do not use with lazy loaded fields. This method returns an empty array when there are no matching fields. It never returns null. <a href="#a3430eabeb9c2927ea29b723086f2a36b"></a><br/></td></tr> |
| <tr class="separator:a3430eabeb9c2927ea29b723086f2a36b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7ee446c8b41ebd89e214303e704fb319"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a>[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#a7ee446c8b41ebd89e214303e704fb319">GetFieldables</a> (System.String name)</td></tr> |
| <tr class="memdesc:a7ee446c8b41ebd89e214303e704fb319"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array of <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a>s with the given name. This method returns an empty array when there are no matching fields. It never returns null. <a href="#a7ee446c8b41ebd89e214303e704fb319"></a><br/></td></tr> |
| <tr class="separator:a7ee446c8b41ebd89e214303e704fb319"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7578d29b3b60af01b43ba38a1bd4417b"><td class="memItemLeft" align="right" valign="top">System.String[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#a7578d29b3b60af01b43ba38a1bd4417b">GetValues</a> (System.String name)</td></tr> |
| <tr class="memdesc:a7578d29b3b60af01b43ba38a1bd4417b"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array of values of the field specified as the method parameter. This method returns an empty array when there are no matching fields. It never returns null. <a href="#a7578d29b3b60af01b43ba38a1bd4417b"></a><br/></td></tr> |
| <tr class="separator:a7578d29b3b60af01b43ba38a1bd4417b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a27cf6a6eedd95813eed86d0d23440edc"><td class="memItemLeft" align="right" valign="top">byte[][] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#a27cf6a6eedd95813eed86d0d23440edc">GetBinaryValues</a> (System.String name)</td></tr> |
| <tr class="memdesc:a27cf6a6eedd95813eed86d0d23440edc"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array of byte arrays for of the fields that have the name specified as the method parameter. This method returns an empty array when there are no matching fields. It never returns null. <a href="#a27cf6a6eedd95813eed86d0d23440edc"></a><br/></td></tr> |
| <tr class="separator:a27cf6a6eedd95813eed86d0d23440edc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afa1c60b136d361d2da4b6ba6eb4ea162"><td class="memItemLeft" align="right" valign="top">byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#afa1c60b136d361d2da4b6ba6eb4ea162">GetBinaryValue</a> (System.String name)</td></tr> |
| <tr class="memdesc:afa1c60b136d361d2da4b6ba6eb4ea162"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array of bytes for the first (or only) field that has the name specified as the method parameter. This method will return <code>null</code> if no binary fields with the specified name are available. There may be non-binary fields with the same name. <a href="#afa1c60b136d361d2da4b6ba6eb4ea162"></a><br/></td></tr> |
| <tr class="separator:afa1c60b136d361d2da4b6ba6eb4ea162"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab5915319f94829fc00830b7dd3fdf38c"><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_documents_1_1_document.html#ab5915319f94829fc00830b7dd3fdf38c">ToString</a> ()</td></tr> |
| <tr class="memdesc:ab5915319f94829fc00830b7dd3fdf38c"><td class="mdescLeft"> </td><td class="mdescRight">Prints the fields of a document for human consumption. <a href="#ab5915319f94829fc00830b7dd3fdf38c"></a><br/></td></tr> |
| <tr class="separator:ab5915319f94829fc00830b7dd3fdf38c"><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:a7f5028e493c9b04c4a2b2eedd7543cda"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#a7f5028e493c9b04c4a2b2eedd7543cda">Boost</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a7f5028e493c9b04c4a2b2eedd7543cda"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets, at indexing time, the boost factor. <a href="#a7f5028e493c9b04c4a2b2eedd7543cda"></a><br/></td></tr> |
| <tr class="separator:a7f5028e493c9b04c4a2b2eedd7543cda"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6b2a982d09bbe45899c62f64a97f369e"><td class="memItemLeft" align="right" valign="top">System.Collections.Generic.IList<br class="typebreak"/> |
| < <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html#a6b2a982d09bbe45899c62f64a97f369e">fields_ForNUnit</a><code> [get]</code></td></tr> |
| <tr class="separator:a6b2a982d09bbe45899c62f64a97f369e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="namespace_lucene_1_1_net_1_1_documents.html">Documents</a> are the unit of indexing and search. </p> |
| <p>A <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> is a set of fields. Each field has a name and a textual value. A field may be <a class="el" href="">stored</a> with the document, in which case it is returned with search hits on the document. Thus each document should typically contain one or more stored fields which uniquely identify it.</p> |
| <p>Note that fields which are <em>not</em> <a class="el" href="">stored</a> are <em>not</em> available in documents retrieved from the index, e.g. with ScoreDoc.Doc, Searcher.Doc(int) or IndexReader.Document(int). </p> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00042">42</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="aa52ffd7ef0a06212a49184862d6bcc16"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.Document.Document </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs a new document with no fields. </p> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00100">100</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="acd45aa28de7754d34357017ecb5a1aea"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Documents.Document.Add </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a> </td> |
| <td class="paramname"><em>field</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Adds a field to a document. Several fields may be added with the same name. In this case, if the fields are indexed, their text is treated as though appended for the purposes of search.Note that add like the removeField(s) methods only makes sense prior to adding a document to an index. These methods cannot be used to change the content of an existing index! In order to achieve this, a document has to be deleted from an index and a new changed version of that document has to be added.</p> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00132">132</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab279a2d40744d95895e01cc16965887b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System.String Lucene.Net.Documents.Document.Get </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the string value of the field with the given name if any exist in this document, or null. If multiple fields exist with this name, this method returns the first value added. If only binary fields with this name exist, returns null. </p> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00210">210</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="afa1c60b136d361d2da4b6ba6eb4ea162"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">byte [] Lucene.Net.Documents.Document.GetBinaryValue </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns an array of bytes for the first (or only) field that has the name specified as the method parameter. This method will return <code>null</code> if no binary fields with the specified name are available. There may be non-binary fields with the same name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the name of the field. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a <code>byte[]</code> containing the binary field value or <code>null</code> </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00351">351</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a27cf6a6eedd95813eed86d0d23440edc"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">byte [][] Lucene.Net.Documents.Document.GetBinaryValues </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns an array of byte arrays for of the fields that have the name specified as the method parameter. This method returns an empty array when there are no matching fields. It never returns null. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the name of the field </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a <code>byte[][]</code> of binary field values </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00326">326</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae6a3a61481d324e3146fdaa002f52dff"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html">Field</a> Lucene.Net.Documents.Document.GetField </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a field with the given name if any exist in this document, or null. If multiple fields exists with this name, this method returns the first value added. Do not use this method with lazy loaded fields. </p> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00185">185</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a16575756a78511475e219debd31ea090"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a> Lucene.Net.Documents.Document.GetFieldable </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a field with the given name if any exist in this document, or null. If multiple fields exists with this name, this method returns the first value added. </p> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00195">195</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7ee446c8b41ebd89e214303e704fb319"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a> [] Lucene.Net.Documents.Document.GetFieldables </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns an array of <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a>s with the given name. This method returns an empty array when there are no matching fields. It never returns null. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the name of the field </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a <code>Fieldable[]</code> array </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00271">271</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac6494808927ec84c6ae9bda2c815918e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System.Collections.Generic.IList<<a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a>> Lucene.Net.Documents.Document.GetFields </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a List of all the fields in a document. Note that fields which are <em>not</em> <a class="el" href="">stored</a> are <em>not</em> available in documents retrieved from the index, e.g. Searcher.Doc(int) or IndexReader.Document(int). </p> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00225">225</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3430eabeb9c2927ea29b723086f2a36b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html">Field</a> [] Lucene.Net.Documents.Document.GetFields </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns an array of <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a>s with the given name. Do not use with lazy loaded fields. This method returns an empty array when there are no matching fields. It never returns null. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the name of the field </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a <code><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a>[]</code> array </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00242">242</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7578d29b3b60af01b43ba38a1bd4417b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System.String [] Lucene.Net.Documents.Document.GetValues </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns an array of values of the field specified as the method parameter. This method returns an empty array when there are no matching fields. It never returns null. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the name of the field </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a <code>String[]</code> of field values </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00299">299</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a847e19ea26c262dde379f4cd072f1de5"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Documents.Document.RemoveField </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Removes field with the specified name from the document. If multiple fields exist with this name, this method removes the first field that has been added. If there is no field with the specified name, the document remains unchanged.Note that the removeField(s) methods like the add method only make sense prior to adding a document to an index. These methods cannot be used to change the content of an existing index! In order to achieve this, a document has to be deleted from an index and a new changed version of that document has to be added.</p> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00146">146</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a75d6796acaac8ca39daf98029ab013c1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Documents.Document.RemoveFields </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Removes all fields with the given name from the document. If there is no field with the specified name, the document remains unchanged.Note that the removeField(s) methods like the add method only make sense prior to adding a document to an index. These methods cannot be used to change the content of an existing index! In order to achieve this, a document has to be deleted from an index and a new changed version of that document has to be added.</p> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00168">168</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab5915319f94829fc00830b7dd3fdf38c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.String Lucene.Net.Documents.Document.ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Prints the fields of a document for human consumption. </p> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00362">362</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a7f5028e493c9b04c4a2b2eedd7543cda"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">float Lucene.Net.Documents.Document.Boost</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets or sets, at indexing time, the boost factor. </p> |
| <p>The default is 1.0 </p> |
| <p>Note that once a document is indexed this value is no longer available from the index. At search time, for retrieved documents, this method always returns 1. This however does not mean that the boost value set at indexing time was ignored - it was just combined with other indexing time factors and stored elsewhere, for better indexing and search performance. (For more information see the "norm(t,d)" part of the scoring formula in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Similarity</a>.) </p> |
| |
| <p>Definition at line <a class="el" href="_document_8cs_source.html#l00118">118</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6b2a982d09bbe45899c62f64a97f369e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System.Collections.Generic.IList<<a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a>> Lucene.Net.Documents.Document.fields_ForNUnit</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="_document_8cs_source.html#l00378">378</a> of file <a class="el" href="_document_8cs_source.html">Document.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Document/<a class="el" href="_document_8cs_source.html">Document.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:49 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> |
