| 1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 |
<!DOCTYPE html |
| 3 |
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| 4 |
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 5 |
|
| 6 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| 7 |
<head> |
| 8 |
<title>Class: Estraier::NodeResult</title> |
| 9 |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
| 10 |
<meta http-equiv="Content-Script-Type" content="text/javascript" /> |
| 11 |
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" /> |
| 12 |
<script type="text/javascript"> |
| 13 |
// <![CDATA[ |
| 14 |
|
| 15 |
function popupCode( url ) { |
| 16 |
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") |
| 17 |
} |
| 18 |
|
| 19 |
function toggleCode( id ) { |
| 20 |
if ( document.getElementById ) |
| 21 |
elem = document.getElementById( id ); |
| 22 |
else if ( document.all ) |
| 23 |
elem = eval( "document.all." + id ); |
| 24 |
else |
| 25 |
return false; |
| 26 |
|
| 27 |
elemStyle = elem.style; |
| 28 |
|
| 29 |
if ( elemStyle.display != "block" ) { |
| 30 |
elemStyle.display = "block" |
| 31 |
} else { |
| 32 |
elemStyle.display = "none" |
| 33 |
} |
| 34 |
|
| 35 |
return true; |
| 36 |
} |
| 37 |
|
| 38 |
// Make codeblocks hidden by default |
| 39 |
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) |
| 40 |
|
| 41 |
// ]]> |
| 42 |
</script> |
| 43 |
|
| 44 |
</head> |
| 45 |
<body> |
| 46 |
|
| 47 |
|
| 48 |
|
| 49 |
<div id="classHeader"> |
| 50 |
<table class="header-table"> |
| 51 |
<tr class="top-aligned-row"> |
| 52 |
<td><strong>Class</strong></td> |
| 53 |
<td class="class-name-in-header">Estraier::NodeResult</td> |
| 54 |
</tr> |
| 55 |
<tr class="top-aligned-row"> |
| 56 |
<td><strong>In:</strong></td> |
| 57 |
<td> |
| 58 |
<a href="../../files/estraier_rb.html"> |
| 59 |
estraier.rb |
| 60 |
</a> |
| 61 |
<br /> |
| 62 |
</td> |
| 63 |
</tr> |
| 64 |
|
| 65 |
<tr class="top-aligned-row"> |
| 66 |
<td><strong>Parent:</strong></td> |
| 67 |
<td> |
| 68 |
Object |
| 69 |
</td> |
| 70 |
</tr> |
| 71 |
</table> |
| 72 |
</div> |
| 73 |
<!-- banner header --> |
| 74 |
|
| 75 |
<div id="bodyContent"> |
| 76 |
|
| 77 |
|
| 78 |
|
| 79 |
<div id="contextContent"> |
| 80 |
|
| 81 |
<div id="description"> |
| 82 |
<p> |
| 83 |
Abstraction of result set from node. |
| 84 |
</p> |
| 85 |
|
| 86 |
</div> |
| 87 |
|
| 88 |
|
| 89 |
</div> |
| 90 |
|
| 91 |
<div id="method-list"> |
| 92 |
<h3 class="section-bar">Methods</h3> |
| 93 |
|
| 94 |
<div class="name-list"> |
| 95 |
<a href="#M000023">doc_num</a> |
| 96 |
<a href="#M000024">get_doc</a> |
| 97 |
<a href="#M000025">hint</a> |
| 98 |
<a href="#M000026">new</a> |
| 99 |
</div> |
| 100 |
</div> |
| 101 |
|
| 102 |
</div> |
| 103 |
|
| 104 |
|
| 105 |
<!-- if includes --> |
| 106 |
|
| 107 |
<div id="section"> |
| 108 |
|
| 109 |
|
| 110 |
|
| 111 |
|
| 112 |
|
| 113 |
|
| 114 |
|
| 115 |
|
| 116 |
<!-- if method_list --> |
| 117 |
<div id="methods"> |
| 118 |
<h3 class="section-bar">Public Class methods</h3> |
| 119 |
|
| 120 |
<div id="method-M000026" class="method-detail"> |
| 121 |
<a name="M000026"></a> |
| 122 |
|
| 123 |
<div class="method-heading"> |
| 124 |
<a href="NodeResult.src/M000026.html" target="Code" class="method-signature" |
| 125 |
onclick="popupCode('NodeResult.src/M000026.html');return false;"> |
| 126 |
<span class="method-name">new</span><span class="method-args">(docs, hints)</span> |
| 127 |
</a> |
| 128 |
</div> |
| 129 |
|
| 130 |
<div class="method-description"> |
| 131 |
<p> |
| 132 |
Create a node result object. |
| 133 |
</p> |
| 134 |
</div> |
| 135 |
</div> |
| 136 |
|
| 137 |
<h3 class="section-bar">Public Instance methods</h3> |
| 138 |
|
| 139 |
<div id="method-M000023" class="method-detail"> |
| 140 |
<a name="M000023"></a> |
| 141 |
|
| 142 |
<div class="method-heading"> |
| 143 |
<a href="NodeResult.src/M000023.html" target="Code" class="method-signature" |
| 144 |
onclick="popupCode('NodeResult.src/M000023.html');return false;"> |
| 145 |
<span class="method-name">doc_num</span><span class="method-args">()</span> |
| 146 |
</a> |
| 147 |
</div> |
| 148 |
|
| 149 |
<div class="method-description"> |
| 150 |
<p> |
| 151 |
Get the number of documents. The return value is the number of documents. |
| 152 |
</p> |
| 153 |
</div> |
| 154 |
</div> |
| 155 |
|
| 156 |
<div id="method-M000024" class="method-detail"> |
| 157 |
<a name="M000024"></a> |
| 158 |
|
| 159 |
<div class="method-heading"> |
| 160 |
<a href="NodeResult.src/M000024.html" target="Code" class="method-signature" |
| 161 |
onclick="popupCode('NodeResult.src/M000024.html');return false;"> |
| 162 |
<span class="method-name">get_doc</span><span class="method-args">(index)</span> |
| 163 |
</a> |
| 164 |
</div> |
| 165 |
|
| 166 |
<div class="method-description"> |
| 167 |
<p> |
| 168 |
Get the value of hint information. The return value is a result document |
| 169 |
object or nil if the index is out of bounds. |
| 170 |
</p> |
| 171 |
</div> |
| 172 |
</div> |
| 173 |
|
| 174 |
<div id="method-M000025" class="method-detail"> |
| 175 |
<a name="M000025"></a> |
| 176 |
|
| 177 |
<div class="method-heading"> |
| 178 |
<a href="NodeResult.src/M000025.html" target="Code" class="method-signature" |
| 179 |
onclick="popupCode('NodeResult.src/M000025.html');return false;"> |
| 180 |
<span class="method-name">hint</span><span class="method-args">(key)</span> |
| 181 |
</a> |
| 182 |
</div> |
| 183 |
|
| 184 |
<div class="method-description"> |
| 185 |
<p> |
| 186 |
Get the value of hint information. `key’ specifies the key of a hint. |
| 187 |
"VERSION", "NODE", "HIT", "HINT#n", |
| 188 |
"DOCNUM", "WORDNUM", "TIME", |
| 189 |
"LINK#n", and "VIEW" are provided for keys. The return |
| 190 |
value is the hint or nil if the key does not exist. |
| 191 |
</p> |
| 192 |
</div> |
| 193 |
</div> |
| 194 |
|
| 195 |
|
| 196 |
</div> |
| 197 |
|
| 198 |
|
| 199 |
</div> |
| 200 |
|
| 201 |
|
| 202 |
<div id="validator-badges"> |
| 203 |
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> |
| 204 |
</div> |
| 205 |
|
| 206 |
</body> |
| 207 |
</html> |
Parent Directory
| 
Revision Log