| <!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: core/Document/Document.cs Source File</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 port of the Lucene search engine library, written in C# and targeted at .NET runtime users.</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="../../annotated.html"><span>Classes</span></a></li> |
| <li class="current"><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="../../files.html"><span>File List</span></a></li> |
| <li><a href="../../globals.html"><span>File 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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</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="../../dir_1efe588324fc547683bba4a3f1bac847.html">core</a></li><li class="navelem"><a class="el" href="../../dir_26c304b05067858a09da5afdd232cb28.html">Document</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">Document.cs</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="../../df/d41/_document_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* </span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * </span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * </span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * limitations under the License.</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">using</span> System;</div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// for javadoc</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"><a class="code" href="../../df/d41/_document_8cs.html#a2a6914ea10bbe06764856e29e5674e66"> 21</a></span> <span class="keyword">using</span> <a class="code" href="../../dd/d53/_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> = Lucene.Net.Index.IndexReader;</div> |
| <div class="line"><a name="l00022"></a><span class="lineno"><a class="code" href="../../df/d41/_document_8cs.html#a11bec7ba632f3ad2cac1484b3296e8c1"> 22</a></span> <span class="keyword">using</span> <a class="code" href="../../df/d41/_document_8cs.html#a11bec7ba632f3ad2cac1484b3296e8c1">ScoreDoc</a> = Lucene.Net.Search.ScoreDoc;</div> |
| <div class="line"><a name="l00023"></a><span class="lineno"><a class="code" href="../../df/d41/_document_8cs.html#a4be53b8845ef8ff2a91031c18774a62c"> 23</a></span> <span class="keyword">using</span> <a class="code" href="../../df/d41/_document_8cs.html#a4be53b8845ef8ff2a91031c18774a62c">Searcher</a> = Lucene.Net.Search.Searcher;</div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span>Lucene.Net.<a class="code" href="../../df/d4b/_index_set_8cs.html#ab0c91be630b1f43f2379cc5964ed640c">Documents</a></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// <summary>Documents are the unit of indexing and search.</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> /// </span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /// A Document is a set of fields. Each field has a name and a textual value.</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> /// A field may be <see cref="IFieldable.IsStored()">stored</see> with the document, in which</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> /// case it is returned with search hits on the document. Thus each document</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> /// should typically contain one or more stored fields which uniquely identify</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> /// it.</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> /// </span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> /// <p/>Note that fields which are <i>not</i> <see cref="IFieldable.IsStored()">stored</see> are</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /// <i>not</i> available in documents retrieved from the index, e.g. with <see cref="ScoreDoc.Doc" />,</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> /// <see cref="Searcher.Doc(int)" /> or <see cref="IndexReader.Document(int)" />.</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  [Serializable]</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html"> 42</a></span>  <span class="keyword">public</span> sealed <span class="keyword">class </span><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  {</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">private</span> <span class="keyword">class </span>AnonymousClassEnumeration : System.Collections.IEnumerator</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  {</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">public</span> AnonymousClassEnumeration(<a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> enclosingInstance)</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  {</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  InitBlock(enclosingInstance);</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  }</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">private</span> <span class="keywordtype">void</span> InitBlock(<a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> enclosingInstance)</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  this.enclosingInstance = enclosingInstance;</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  iter = Enclosing_Instance.fields.GetEnumerator();</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  }</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">private</span> System.Object tempAuxObj;</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">public</span> <span class="keywordtype">bool</span> MoveNext()</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">bool</span> result = HasMoreElements();</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">if</span> (result)</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  tempAuxObj = NextElement();</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">return</span> result;</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  }</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">public</span> <span class="keywordtype">void</span> Reset()</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  {</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  tempAuxObj = null;</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">public</span> System.Object Current</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  {</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">get</span></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  {</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> tempAuxObj;</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">private</span> <a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> enclosingInstance;</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">public</span> <a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> Enclosing_Instance</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  {</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">get</span></div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  {</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> enclosingInstance;</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  }</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">internal</span> System.Collections.IEnumerator iter;</div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">public</span> <span class="keywordtype">bool</span> HasMoreElements()</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  {</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">return</span> iter.MoveNext();</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  }</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">public</span> System.Object NextElement()</div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  {</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">return</span> iter.Current;</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">internal</span> System.Collections.Generic.IList<<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a>> fields = <span class="keyword">new</span> System.Collections.Generic.List<<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a>>();</div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">private</span> <span class="keywordtype">float</span> boost = 1.0f;</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> /// <summary>Constructs a new document with no fields. </summary></span></div> |
| <div class="line"><a name="l00100"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#aa52ffd7ef0a06212a49184862d6bcc16"> 100</a></span> <span class="comment"></span> <span class="keyword">public</span> <a class="code" href="../../dd/d53/_more_like_this_8cs.html#a2ad6aef8641c7b7a6cf9277f7d54b2cd">Document</a>()</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  {</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  }</div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> /// <summary>Gets or sets, at indexing time, the boost factor. </span></div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> /// <para></span></div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> /// The default is 1.0</span></div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> /// </para></span></div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> /// <p/>Note that once a document is indexed this value is no longer available</span></div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> /// from the index. At search time, for retrieved documents, this method always </span></div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> /// returns 1. This however does not mean that the boost value set at indexing </span></div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> /// time was ignored - it was just combined with other indexing time factors and </span></div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> /// stored elsewhere, for better indexing and search performance. (For more </span></div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> /// information see the "norm(t,d)" part of the scoring formula in </span></div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> /// <see cref="Lucene.Net.Search.Similarity">Similarity</see>.)</span></div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"></span> <span class="keyword">public</span> <span class="keywordtype">float</span> Boost</div> |
| <div class="line"><a name="l00118"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#a7f5028e493c9b04c4a2b2eedd7543cda"> 118</a></span>  {</div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">get</span> { <span class="keywordflow">return</span> boost; }</div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">set</span> { this.boost = value; }</div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> /// <summary> <p/>Adds a field to a document. Several fields may be added with</span></div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> /// the same name. In this case, if the fields are indexed, their text is</span></div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> /// treated as though appended for the purposes of search.<p/></span></div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> /// <p/> Note that add like the removeField(s) methods only makes sense </span></div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> /// prior to adding a document to an index. These methods cannot</span></div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> /// be used to change the content of an existing index! In order to achieve this,</span></div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> /// a document has to be deleted from an index and a new changed version of that</span></div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> /// document has to be added.<p/></span></div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00132"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#acd45aa28de7754d34357017ecb5a1aea"> 132</a></span> <span class="comment"></span> <span class="keyword">public</span> <span class="keywordtype">void</span> Add(<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> field)</div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  {</div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  fields.Add(field);</div> |
| <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  }</div> |
| <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> /// <summary> <p/>Removes field with the specified name from the document.</span></div> |
| <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> /// If multiple fields exist with this name, this method removes the first field that has been added.</span></div> |
| <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> /// If there is no field with the specified name, the document remains unchanged.<p/></span></div> |
| <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> /// <p/> Note that the removeField(s) methods like the add method only make sense </span></div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> /// prior to adding a document to an index. These methods cannot</span></div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> /// be used to change the content of an existing index! In order to achieve this,</span></div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> /// a document has to be deleted from an index and a new changed version of that</span></div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> /// document has to be added.<p/></span></div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00146"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#a847e19ea26c262dde379f4cd072f1de5"> 146</a></span> <span class="comment"></span> <span class="keyword">public</span> <span class="keywordtype">void</span> RemoveField(System.String name)</div> |
| <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  {</div> |
| <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  System.Collections.Generic.IEnumerator<<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a>> it = fields.GetEnumerator();</div> |
| <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordflow">while</span> (it.MoveNext())</div> |
| <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  {</div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> field = it.Current;</div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordflow">if</span> (field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a887bc8d5d19fdb6873625745a915a439" title="Returns the name of the field as an interned string. For example "date", "title", "body"...">Name</a>.Equals(name))</div> |
| <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  {</div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  fields.Remove(field);</div> |
| <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  return ;</div> |
| <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  }</div> |
| <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  }</div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  }</div> |
| <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> /// <summary> <p/>Removes all fields with the given name from the document.</span></div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> /// If there is no field with the specified name, the document remains unchanged.<p/></span></div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> /// <p/> Note that the removeField(s) methods like the add method only make sense </span></div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> /// prior to adding a document to an index. These methods cannot</span></div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> /// be used to change the content of an existing index! In order to achieve this,</span></div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> /// a document has to be deleted from an index and a new changed version of that</span></div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> /// document has to be added.<p/></span></div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00168"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#a75d6796acaac8ca39daf98029ab013c1"> 168</a></span> <span class="comment"></span> <span class="keyword">public</span> <span class="keywordtype">void</span> RemoveFields(System.String name)</div> |
| <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  {</div> |
| <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = fields.Count - 1; i >= 0; i--)</div> |
| <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  {</div> |
| <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> field = fields[i];</div> |
| <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keywordflow">if</span> (field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a887bc8d5d19fdb6873625745a915a439" title="Returns the name of the field as an interned string. For example "date", "title", "body"...">Name</a>.Equals(name))</div> |
| <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  {</div> |
| <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  fields.RemoveAt(i);</div> |
| <div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  }</div> |
| <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  }</div> |
| <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  }</div> |
| <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> /// <summary>Returns a field with the given name if any exist in this document, or</span></div> |
| <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> /// null. If multiple fields exists with this name, this method returns the</span></div> |
| <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> /// first value added.</span></div> |
| <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> /// Do not use this method with lazy loaded fields.</span></div> |
| <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00185"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#ae6a3a61481d324e3146fdaa002f52dff"> 185</a></span> <span class="comment"></span> <span class="keyword">public</span> <a class="code" href="../../de/da7/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> GetField(System.String name)</div> |
| <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  {</div> |
| <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keywordflow">return</span> (<a class="code" href="../../de/da7/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>) GetFieldable(name);</div> |
| <div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  }</div> |
| <div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  </div> |
| <div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> /// <summary>Returns a field with the given name if any exist in this document, or</span></div> |
| <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> /// null. If multiple fields exists with this name, this method returns the</span></div> |
| <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> /// first value added.</span></div> |
| <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00195"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#a16575756a78511475e219debd31ea090"> 195</a></span> <span class="comment"></span> <span class="keyword">public</span> <a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> GetFieldable(System.String name)</div> |
| <div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  {</div> |
| <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keywordflow">foreach</span>(<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> field <span class="keywordflow">in</span> fields)</div> |
| <div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  {</div> |
| <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="keywordflow">if</span> (field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a887bc8d5d19fdb6873625745a915a439" title="Returns the name of the field as an interned string. For example "date", "title", "body"...">Name</a>.Equals(name))</div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keywordflow">return</span> field;</div> |
| <div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  }</div> |
| <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keywordflow">return</span> null;</div> |
| <div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  }</div> |
| <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> /// <summary>Returns the string value of the field with the given name if any exist in</span></div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> /// this document, or null. If multiple fields exist with this name, this</span></div> |
| <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> /// method returns the first value added. If only binary fields with this name</span></div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> /// exist, returns null.</span></div> |
| <div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00210"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#ab279a2d40744d95895e01cc16965887b"> 210</a></span> <span class="comment"></span> <span class="keyword">public</span> System.String Get(System.String name)</div> |
| <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  {</div> |
| <div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="keywordflow">foreach</span>(<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> field <span class="keywordflow">in</span> fields)</div> |
| <div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  {</div> |
| <div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="keywordflow">if</span> (field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a887bc8d5d19fdb6873625745a915a439" title="Returns the name of the field as an interned string. For example "date", "title", "body"...">Name</a>.Equals(name) && (!field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1f0b930c4cc0180629d70fb056a17316" title="True if the value of the field is stored as binary ">IsBinary</a>))</div> |
| <div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keywordflow">return</span> field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#adaea4a14b9c96576da9171b41abff836" title="The value of the field as a String, or null. For indexing, if isStored()==true, the stringValue() wil...">StringValue</a>;</div> |
| <div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  }</div> |
| <div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keywordflow">return</span> null;</div> |
| <div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  }</div> |
| <div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> /// <summary>Returns a List of all the fields in a document.</span></div> |
| <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> /// <p/>Note that fields which are <i>not</i> <see cref="IFieldable.IsStored()">stored</see> are</span></div> |
| <div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> /// <i>not</i> available in documents retrieved from the</span></div> |
| <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> /// index, e.g. <see cref="Searcher.Doc(int)" /> or <see cref="IndexReader.Document(int)" />.</span></div> |
| <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00225"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#ac6494808927ec84c6ae9bda2c815918e"> 225</a></span> <span class="comment"></span> <span class="keyword">public</span> System.Collections.Generic.IList<<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a>> GetFields()</div> |
| <div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  {</div> |
| <div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordflow">return</span> fields;</div> |
| <div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  }</div> |
| <div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  </div> |
| <div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="keyword">private</span> <span class="keyword">static</span> readonly <a class="code" href="../../de/da7/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>[] NO_FIELDS = <span class="keyword">new</span> <a class="code" href="../../de/da7/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>[0];</div> |
| <div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> /// <summary> Returns an array of <see cref="Field" />s with the given name.</span></div> |
| <div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> /// Do not use with lazy loaded fields.</span></div> |
| <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> /// This method returns an empty array when there are no</span></div> |
| <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> /// matching fields. It never returns null.</span></div> |
| <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> /// </span></div> |
| <div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> /// <param name="name">the name of the field</span></div> |
| <div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> /// <returns> a <c>Field[]</c> array</span></div> |
| <div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> /// </returns></span></div> |
| <div class="line"><a name="l00242"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#a3430eabeb9c2927ea29b723086f2a36b"> 242</a></span> <span class="comment"></span> <span class="keyword">public</span> <a class="code" href="../../de/da7/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>[] GetFields(System.String name)</div> |
| <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  {</div> |
| <div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  var result = <span class="keyword">new</span> System.Collections.Generic.List<<a class="code" href="../../de/da7/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>>();</div> |
| <div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  <span class="keywordflow">foreach</span>(<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> field <span class="keywordflow">in</span> fields)</div> |
| <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  {</div> |
| <div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="keywordflow">if</span> (field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a887bc8d5d19fdb6873625745a915a439" title="Returns the name of the field as an interned string. For example "date", "title", "body"...">Name</a>.Equals(name))</div> |
| <div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  {</div> |
| <div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  result.Add((<a class="code" href="../../de/da7/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>)field);</div> |
| <div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  }</div> |
| <div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  }</div> |
| <div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  </div> |
| <div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <span class="keywordflow">if</span> (result.Count == 0)</div> |
| <div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  <span class="keywordflow">return</span> NO_FIELDS;</div> |
| <div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  </div> |
| <div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <span class="keywordflow">return</span> result.ToArray();</div> |
| <div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  }</div> |
| <div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  </div> |
| <div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  </div> |
| <div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keyword">private</span> <span class="keyword">static</span> readonly <a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a>[] NO_FIELDABLES = <span class="keyword">new</span> <a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a>[0];</div> |
| <div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> /// <summary> Returns an array of <see cref="IFieldable" />s with the given name.</span></div> |
| <div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> /// This method returns an empty array when there are no</span></div> |
| <div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> /// matching fields. It never returns null.</span></div> |
| <div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> /// </span></div> |
| <div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> /// <param name="name">the name of the field</span></div> |
| <div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> /// <returns> a <c>Fieldable[]</c> array</span></div> |
| <div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> /// </returns></span></div> |
| <div class="line"><a name="l00271"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#a7ee446c8b41ebd89e214303e704fb319"> 271</a></span> <span class="comment"></span> <span class="keyword">public</span> <a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a>[] GetFieldables(System.String name)</div> |
| <div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  {</div> |
| <div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  var result = <span class="keyword">new</span> System.Collections.Generic.List<<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a>>();</div> |
| <div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keywordflow">foreach</span>(<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> field <span class="keywordflow">in</span> fields)</div> |
| <div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  {</div> |
| <div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  <span class="keywordflow">if</span> (field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a887bc8d5d19fdb6873625745a915a439" title="Returns the name of the field as an interned string. For example "date", "title", "body"...">Name</a>.Equals(name))</div> |
| <div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  {</div> |
| <div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  result.Add(field);</div> |
| <div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  }</div> |
| <div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  }</div> |
| <div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  </div> |
| <div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  <span class="keywordflow">if</span> (result.Count == 0)</div> |
| <div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  <span class="keywordflow">return</span> NO_FIELDABLES;</div> |
| <div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  </div> |
| <div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  <span class="keywordflow">return</span> result.ToArray();</div> |
| <div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  }</div> |
| <div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  </div> |
| <div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  </div> |
| <div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  <span class="keyword">private</span> <span class="keyword">static</span> readonly System.String[] NO_STRINGS = <span class="keyword">new</span> System.String[0];</div> |
| <div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> /// <summary> Returns an array of values of the field specified as the method parameter.</span></div> |
| <div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> /// This method returns an empty array when there are no</span></div> |
| <div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> /// matching fields. It never returns null.</span></div> |
| <div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> /// <param name="name">the name of the field</span></div> |
| <div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"> /// <returns> a <c>String[]</c> of field values</span></div> |
| <div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> /// </returns></span></div> |
| <div class="line"><a name="l00299"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#a7578d29b3b60af01b43ba38a1bd4417b"> 299</a></span> <span class="comment"></span> <span class="keyword">public</span> System.String[] GetValues(System.String name)</div> |
| <div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  {</div> |
| <div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  var result = <span class="keyword">new</span> System.Collections.Generic.List<<span class="keywordtype">string</span>>();</div> |
| <div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  <span class="keywordflow">foreach</span>(<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> field <span class="keywordflow">in</span> fields)</div> |
| <div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  {</div> |
| <div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  <span class="keywordflow">if</span> (field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a887bc8d5d19fdb6873625745a915a439" title="Returns the name of the field as an interned string. For example "date", "title", "body"...">Name</a>.Equals(name) && (!field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1f0b930c4cc0180629d70fb056a17316" title="True if the value of the field is stored as binary ">IsBinary</a>))</div> |
| <div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  result.Add(field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#adaea4a14b9c96576da9171b41abff836" title="The value of the field as a String, or null. For indexing, if isStored()==true, the stringValue() wil...">StringValue</a>);</div> |
| <div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  }</div> |
| <div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  </div> |
| <div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="keywordflow">if</span> (result.Count == 0)</div> |
| <div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  <span class="keywordflow">return</span> NO_STRINGS;</div> |
| <div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  </div> |
| <div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  <span class="keywordflow">return</span> result.ToArray();</div> |
| <div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  }</div> |
| <div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  </div> |
| <div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  <span class="keyword">private</span> <span class="keyword">static</span> readonly byte[][] NO_BYTES = <span class="keyword">new</span> byte[0][];</div> |
| <div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> /// <summary> Returns an array of byte arrays for of the fields that have the name specified</span></div> |
| <div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> /// as the method parameter. This method returns an empty</span></div> |
| <div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> /// array when there are no matching fields. It never</span></div> |
| <div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> /// returns null.</span></div> |
| <div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> /// </span></div> |
| <div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> /// <param name="name">the name of the field</span></div> |
| <div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> /// <returns> a <c>byte[][]</c> of binary field values</span></div> |
| <div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"> /// </returns></span></div> |
| <div class="line"><a name="l00326"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#a27cf6a6eedd95813eed86d0d23440edc"> 326</a></span> <span class="comment"></span> <span class="keyword">public</span> byte[][] GetBinaryValues(System.String name)</div> |
| <div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  {</div> |
| <div class="line"><a name="l00328"></a><span class="lineno"> 328</span>  var result = <span class="keyword">new</span> System.Collections.Generic.List<byte[]>();</div> |
| <div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  <span class="keywordflow">foreach</span>(<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> field <span class="keywordflow">in</span> fields)</div> |
| <div class="line"><a name="l00330"></a><span class="lineno"> 330</span>  {</div> |
| <div class="line"><a name="l00331"></a><span class="lineno"> 331</span>  <span class="keywordflow">if</span> (field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a887bc8d5d19fdb6873625745a915a439" title="Returns the name of the field as an interned string. For example "date", "title", "body"...">Name</a>.Equals(name) && (field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1f0b930c4cc0180629d70fb056a17316" title="True if the value of the field is stored as binary ">IsBinary</a>))</div> |
| <div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  result.Add(field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1dc9e02aaec54ab33b827ccf60b7c116" title="Return the raw byte[] for the binary field. Note that you must also call BinaryLength and BinaryOffse...">GetBinaryValue</a>());</div> |
| <div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  }</div> |
| <div class="line"><a name="l00334"></a><span class="lineno"> 334</span>  </div> |
| <div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  <span class="keywordflow">if</span> (result.Count == 0)</div> |
| <div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  <span class="keywordflow">return</span> NO_BYTES;</div> |
| <div class="line"><a name="l00337"></a><span class="lineno"> 337</span> </div> |
| <div class="line"><a name="l00338"></a><span class="lineno"> 338</span>  <span class="keywordflow">return</span> result.ToArray();</div> |
| <div class="line"><a name="l00339"></a><span class="lineno"> 339</span>  }</div> |
| <div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> /// <summary> Returns an array of bytes for the first (or only) field that has the name</span></div> |
| <div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> /// specified as the method parameter. This method will return <c>null</c></span></div> |
| <div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> /// if no binary fields with the specified name are available.</span></div> |
| <div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> /// There may be non-binary fields with the same name.</span></div> |
| <div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> /// </span></div> |
| <div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> /// <param name="name">the name of the field.</span></div> |
| <div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> /// <returns> a <c>byte[]</c> containing the binary field value or <c>null</c></span></div> |
| <div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment"> /// </returns></span></div> |
| <div class="line"><a name="l00351"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#afa1c60b136d361d2da4b6ba6eb4ea162"> 351</a></span> <span class="comment"></span> <span class="keyword">public</span> byte[] GetBinaryValue(System.String name)</div> |
| <div class="line"><a name="l00352"></a><span class="lineno"> 352</span>  {</div> |
| <div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  <span class="keywordflow">foreach</span>(<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> field <span class="keywordflow">in</span> fields)</div> |
| <div class="line"><a name="l00354"></a><span class="lineno"> 354</span>  {</div> |
| <div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  <span class="keywordflow">if</span> (field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a887bc8d5d19fdb6873625745a915a439" title="Returns the name of the field as an interned string. For example "date", "title", "body"...">Name</a>.Equals(name) && (field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1f0b930c4cc0180629d70fb056a17316" title="True if the value of the field is stored as binary ">IsBinary</a>))</div> |
| <div class="line"><a name="l00356"></a><span class="lineno"> 356</span>  <span class="keywordflow">return</span> field.<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1dc9e02aaec54ab33b827ccf60b7c116" title="Return the raw byte[] for the binary field. Note that you must also call BinaryLength and BinaryOffse...">GetBinaryValue</a>();</div> |
| <div class="line"><a name="l00357"></a><span class="lineno"> 357</span>  }</div> |
| <div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  <span class="keywordflow">return</span> null;</div> |
| <div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  }</div> |
| <div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> /// <summary>Prints the fields of a document for human consumption. </summary></span></div> |
| <div class="line"><a name="l00362"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#ab5915319f94829fc00830b7dd3fdf38c"> 362</a></span> <span class="comment"></span> <span class="keyword">public</span> <span class="keyword">override</span> System.String ToString()</div> |
| <div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  {</div> |
| <div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  System.Text.StringBuilder buffer = <span class="keyword">new</span> System.Text.StringBuilder();</div> |
| <div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  buffer.Append(<span class="stringliteral">"Document<"</span>);</div> |
| <div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < fields.Count; i++)</div> |
| <div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  {</div> |
| <div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  <a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> field = fields[i];</div> |
| <div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  buffer.Append(field.ToString());</div> |
| <div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  <span class="keywordflow">if</span> (i != fields.Count - 1)</div> |
| <div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  buffer.Append(<span class="stringliteral">" "</span>);</div> |
| <div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  }</div> |
| <div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  buffer.Append(<span class="stringliteral">">"</span>);</div> |
| <div class="line"><a name="l00374"></a><span class="lineno"> 374</span>  <span class="keywordflow">return</span> buffer.ToString();</div> |
| <div class="line"><a name="l00375"></a><span class="lineno"> 375</span>  }</div> |
| <div class="line"><a name="l00376"></a><span class="lineno"> 376</span> </div> |
| <div class="line"><a name="l00377"></a><span class="lineno"> 377</span>  <span class="keyword">public</span> System.Collections.Generic.IList<<a class="code" href="../../de/df5/interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a>> fields_ForNUnit</div> |
| <div class="line"><a name="l00378"></a><span class="lineno"><a class="code" href="../../db/d65/class_lucene_1_1_net_1_1_documents_1_1_document.html#a6b2a982d09bbe45899c62f64a97f369e"> 378</a></span>  {</div> |
| <div class="line"><a name="l00379"></a><span class="lineno"> 379</span>  <span class="keyword">get</span> { <span class="keywordflow">return</span> fields; }</div> |
| <div class="line"><a name="l00380"></a><span class="lineno"> 380</span>  }</div> |
| <div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  }</div> |
| <div class="line"><a name="l00382"></a><span class="lineno"> 382</span> }</div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:34:11 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> |
