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::ResultDocument</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::ResultDocument</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 document in result set. |
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="#M000029">attr</a> |
96 |
<a href="#M000028">attr_names</a> |
97 |
<a href="#M000031">new</a> |
98 |
<a href="#M000030">snippet</a> |
99 |
<a href="#M000027">uri</a> |
100 |
</div> |
101 |
</div> |
102 |
|
103 |
</div> |
104 |
|
105 |
|
106 |
<!-- if includes --> |
107 |
|
108 |
<div id="section"> |
109 |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 |
<!-- if method_list --> |
118 |
<div id="methods"> |
119 |
<h3 class="section-bar">Public Class methods</h3> |
120 |
|
121 |
<div id="method-M000031" class="method-detail"> |
122 |
<a name="M000031"></a> |
123 |
|
124 |
<div class="method-heading"> |
125 |
<a href="ResultDocument.src/M000031.html" target="Code" class="method-signature" |
126 |
onclick="popupCode('ResultDocument.src/M000031.html');return false;"> |
127 |
<span class="method-name">new</span><span class="method-args">(uri, attrs, snippet)</span> |
128 |
</a> |
129 |
</div> |
130 |
|
131 |
<div class="method-description"> |
132 |
<p> |
133 |
Create a result document object. |
134 |
</p> |
135 |
</div> |
136 |
</div> |
137 |
|
138 |
<h3 class="section-bar">Public Instance methods</h3> |
139 |
|
140 |
<div id="method-M000029" class="method-detail"> |
141 |
<a name="M000029"></a> |
142 |
|
143 |
<div class="method-heading"> |
144 |
<a href="ResultDocument.src/M000029.html" target="Code" class="method-signature" |
145 |
onclick="popupCode('ResultDocument.src/M000029.html');return false;"> |
146 |
<span class="method-name">attr</span><span class="method-args">(name)</span> |
147 |
</a> |
148 |
</div> |
149 |
|
150 |
<div class="method-description"> |
151 |
<p> |
152 |
Get the value of an attribute. The return value is the value of the |
153 |
attribute or nil if it does not exist. |
154 |
</p> |
155 |
</div> |
156 |
</div> |
157 |
|
158 |
<div id="method-M000028" class="method-detail"> |
159 |
<a name="M000028"></a> |
160 |
|
161 |
<div class="method-heading"> |
162 |
<a href="ResultDocument.src/M000028.html" target="Code" class="method-signature" |
163 |
onclick="popupCode('ResultDocument.src/M000028.html');return false;"> |
164 |
<span class="method-name">attr_names</span><span class="method-args">()</span> |
165 |
</a> |
166 |
</div> |
167 |
|
168 |
<div class="method-description"> |
169 |
<p> |
170 |
Get a list of attribute names. The return value is a list object of |
171 |
attribute names. |
172 |
</p> |
173 |
</div> |
174 |
</div> |
175 |
|
176 |
<div id="method-M000030" class="method-detail"> |
177 |
<a name="M000030"></a> |
178 |
|
179 |
<div class="method-heading"> |
180 |
<a href="ResultDocument.src/M000030.html" target="Code" class="method-signature" |
181 |
onclick="popupCode('ResultDocument.src/M000030.html');return false;"> |
182 |
<span class="method-name">snippet</span><span class="method-args">()</span> |
183 |
</a> |
184 |
</div> |
185 |
|
186 |
<div class="method-description"> |
187 |
<p> |
188 |
Get the snippet of a result document object. The return value is the |
189 |
snippet of the result document object. There are tab separated values. Each |
190 |
line is a string to be shown. Though most lines have only one field, some |
191 |
lines have two fields. If the second field exists, the first field is to be |
192 |
shown with highlighted, and the second field means its normalized form. |
193 |
</p> |
194 |
</div> |
195 |
</div> |
196 |
|
197 |
<div id="method-M000027" class="method-detail"> |
198 |
<a name="M000027"></a> |
199 |
|
200 |
<div class="method-heading"> |
201 |
<a href="ResultDocument.src/M000027.html" target="Code" class="method-signature" |
202 |
onclick="popupCode('ResultDocument.src/M000027.html');return false;"> |
203 |
<span class="method-name">uri</span><span class="method-args">()</span> |
204 |
</a> |
205 |
</div> |
206 |
|
207 |
<div class="method-description"> |
208 |
<p> |
209 |
Get the URI. The return value is the URI of the result document object. |
210 |
</p> |
211 |
</div> |
212 |
</div> |
213 |
|
214 |
|
215 |
</div> |
216 |
|
217 |
|
218 |
</div> |
219 |
|
220 |
|
221 |
<div id="validator-badges"> |
222 |
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> |
223 |
</div> |
224 |
|
225 |
</body> |
226 |
</html> |