| <!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.Search.FieldDoc 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_search.html">Search</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_doc.html">FieldDoc</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_field_doc-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.FieldDoc Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Expert: A <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_score_doc.html" title="Expert: Returned by low-level search implementations.">ScoreDoc</a> which also contains information about how to sort the referenced document. In addition to the document number and score, this object contains an array of values for the document from the field(s) used to sort. For example, if the sort criteria was to sort by fields "a", "b" then "c", the <code>fields</code> object array will have three elements, corresponding respectively to the term values for the document in fields "a", "b" and "c". The class of each element in the array will be either Integer, Float or String depending on the type of values in the terms of each field. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_field_doc.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_score_doc.html">Lucene.Net.Search.ScoreDoc</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:a512301d5c6867004251ec43b2dc1601e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_doc.html#a512301d5c6867004251ec43b2dc1601e">FieldDoc</a> (int doc, float score)</td></tr> |
| <tr class="memdesc:a512301d5c6867004251ec43b2dc1601e"><td class="mdescLeft"> </td><td class="mdescRight">Expert: Creates one of these objects with empty sort information. <a href="#a512301d5c6867004251ec43b2dc1601e"></a><br/></td></tr> |
| <tr class="separator:a512301d5c6867004251ec43b2dc1601e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaaddf1ad5aa5820f7a00c7eafcf2c0b3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_doc.html#aaaddf1ad5aa5820f7a00c7eafcf2c0b3">FieldDoc</a> (int doc, float score, System.IComparable[] <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_doc.html#aa8b082bfd9429a289d2c6462eaf2d28f">fields</a>)</td></tr> |
| <tr class="memdesc:aaaddf1ad5aa5820f7a00c7eafcf2c0b3"><td class="mdescLeft"> </td><td class="mdescRight">Expert: Creates one of these objects with the given sort information. <a href="#aaaddf1ad5aa5820f7a00c7eafcf2c0b3"></a><br/></td></tr> |
| <tr class="separator:aaaddf1ad5aa5820f7a00c7eafcf2c0b3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a982071fb29375cb543ac70dd59cd5a22"><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_search_1_1_field_doc.html#a982071fb29375cb543ac70dd59cd5a22">ToString</a> ()</td></tr> |
| <tr class="separator:a982071fb29375cb543ac70dd59cd5a22"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_score_doc"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_score_doc')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_score_doc.html">Lucene.Net.Search.ScoreDoc</a></td></tr> |
| <tr class="memitem:a9ca1e0e7abaf9cab3cb12e8cea871e30 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_score_doc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_score_doc.html#a9ca1e0e7abaf9cab3cb12e8cea871e30">ScoreDoc</a> (int doc, float score)</td></tr> |
| <tr class="memdesc:a9ca1e0e7abaf9cab3cb12e8cea871e30 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_score_doc"><td class="mdescLeft"> </td><td class="mdescRight">Expert: Constructs a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_score_doc.html" title="Expert: Returned by low-level search implementations.">ScoreDoc</a>. <a href="#a9ca1e0e7abaf9cab3cb12e8cea871e30"></a><br/></td></tr> |
| <tr class="separator:a9ca1e0e7abaf9cab3cb12e8cea871e30 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_score_doc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a150de931180c029adcea21e911f85d0f inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_score_doc"><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_search_1_1_score_doc.html#a150de931180c029adcea21e911f85d0f">ToString</a> ()</td></tr> |
| <tr class="separator:a150de931180c029adcea21e911f85d0f inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_score_doc"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:aa8b082bfd9429a289d2c6462eaf2d28f"><td class="memItemLeft" align="right" valign="top">System.IComparable[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_doc.html#aa8b082bfd9429a289d2c6462eaf2d28f">fields</a></td></tr> |
| <tr class="memdesc:aa8b082bfd9429a289d2c6462eaf2d28f"><td class="mdescLeft"> </td><td class="mdescRight">Expert: The values which are used to sort the referenced document. The order of these will match the original sort criteria given by a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort.html" title="Encapsulates sort criteria for returned hits.">Sort</a> object. Each Object will be either an Integer, Float or String, depending on the type of values in the terms of the original field. <a href="#aa8b082bfd9429a289d2c6462eaf2d28f"></a><br/></td></tr> |
| <tr class="separator:aa8b082bfd9429a289d2c6462eaf2d28f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header properties_class_lucene_1_1_net_1_1_search_1_1_score_doc"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_search_1_1_score_doc')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_score_doc.html">Lucene.Net.Search.ScoreDoc</a></td></tr> |
| <tr class="memitem:ac4396542964216dd5e8dac1ea399cf1b inherit properties_class_lucene_1_1_net_1_1_search_1_1_score_doc"><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_search_1_1_score_doc.html#ac4396542964216dd5e8dac1ea399cf1b">Score</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:ac4396542964216dd5e8dac1ea399cf1b inherit properties_class_lucene_1_1_net_1_1_search_1_1_score_doc"><td class="mdescLeft"> </td><td class="mdescRight">Expert: The score of this document for the query. <a href="#ac4396542964216dd5e8dac1ea399cf1b"></a><br/></td></tr> |
| <tr class="separator:ac4396542964216dd5e8dac1ea399cf1b inherit properties_class_lucene_1_1_net_1_1_search_1_1_score_doc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6ea1b11e627ce3b8807f431908bec640 inherit properties_class_lucene_1_1_net_1_1_search_1_1_score_doc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_score_doc.html#a6ea1b11e627ce3b8807f431908bec640">Doc</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a6ea1b11e627ce3b8807f431908bec640 inherit properties_class_lucene_1_1_net_1_1_search_1_1_score_doc"><td class="mdescLeft"> </td><td class="mdescRight">Expert: A hit document's number. <a href="#a6ea1b11e627ce3b8807f431908bec640"></a><br/></td></tr> |
| <tr class="separator:a6ea1b11e627ce3b8807f431908bec640 inherit properties_class_lucene_1_1_net_1_1_search_1_1_score_doc"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Expert: A <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_score_doc.html" title="Expert: Returned by low-level search implementations.">ScoreDoc</a> which also contains information about how to sort the referenced document. In addition to the document number and score, this object contains an array of values for the document from the field(s) used to sort. For example, if the sort criteria was to sort by fields "a", "b" then "c", the <code>fields</code> object array will have three elements, corresponding respectively to the term values for the document in fields "a", "b" and "c". The class of each element in the array will be either Integer, Float or String depending on the type of values in the terms of each field. </p> |
| <p>Created: Feb 11, 2004 1:23:38 PM</p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_score_doc.html" title="Expert: Returned by low-level search implementations.">ScoreDoc</a></dd></dl> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_top_field_docs.html" title="Represents hits returned by Searcher.Search(Query,Filter,int,Sort). ">TopFieldDocs</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_field_doc_8cs_source.html#l00041">41</a> of file <a class="el" href="_field_doc_8cs_source.html">FieldDoc.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a512301d5c6867004251ec43b2dc1601e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.FieldDoc.FieldDoc </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>doc</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>score</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Expert: Creates one of these objects with empty sort information. </p> |
| |
| <p>Definition at line <a class="el" href="_field_doc_8cs_source.html#l00057">57</a> of file <a class="el" href="_field_doc_8cs_source.html">FieldDoc.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aaaddf1ad5aa5820f7a00c7eafcf2c0b3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.FieldDoc.FieldDoc </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>doc</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>score</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.IComparable[] </td> |
| <td class="paramname"><em>fields</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Expert: Creates one of these objects with the given sort information. </p> |
| |
| <p>Definition at line <a class="el" href="_field_doc_8cs_source.html#l00062">62</a> of file <a class="el" href="_field_doc_8cs_source.html">FieldDoc.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a982071fb29375cb543ac70dd59cd5a22"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.String Lucene.Net.Search.FieldDoc.ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_field_doc_8cs_source.html#l00068">68</a> of file <a class="el" href="_field_doc_8cs_source.html">FieldDoc.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="aa8b082bfd9429a289d2c6462eaf2d28f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System.IComparable [] Lucene.Net.Search.FieldDoc.fields</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Expert: The values which are used to sort the referenced document. The order of these will match the original sort criteria given by a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort.html" title="Encapsulates sort criteria for returned hits.">Sort</a> object. Each Object will be either an Integer, Float or String, depending on the type of values in the terms of the original field. </p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_sort.html" title="Encapsulates sort criteria for returned hits.">Sort</a></dd></dl> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html#a4fa776037fe41a7fccc3c9d32057c258" title="Search implementation with arbitrary sorting. Finds the top n hits for query, applying filter if non-...">Searcher.Search(Query,Filter,int,Sort)</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_field_doc_8cs_source.html#l00054">54</a> of file <a class="el" href="_field_doc_8cs_source.html">FieldDoc.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Search/<a class="el" href="_field_doc_8cs_source.html">FieldDoc.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:57 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> |
