/[hyperestraier]/upstream/0.5.3/doc/japidoc/estraier/ResultDocument.html
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Contents of /upstream/0.5.3/doc/japidoc/estraier/ResultDocument.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 10 - (show annotations)
Wed Aug 3 15:25:48 2005 UTC (18 years, 9 months ago) by dpavlin
File MIME type: text/html
File size: 8988 byte(s)
import of upstream 0.5.3

1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.4.2_06) on Mon Aug 01 00:51:52 JST 2005 -->
6 <TITLE>
7 ResultDocument (estraier)
8 </TITLE>
9
10 <META NAME="keywords" CONTENT="estraier.ResultDocument interface">
11
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
13
14 <SCRIPT type="text/javascript">
15 function windowTitle()
16 {
17 parent.document.title="ResultDocument (estraier)";
18 }
19 </SCRIPT>
20
21 </HEAD>
22
23 <BODY BGCOLOR="white" onload="windowTitle();">
24
25
26 <!-- ========= START OF TOP NAVBAR ======= -->
27 <A NAME="navbar_top"><!-- --></A>
28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30 <TR>
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
40 </TR>
41 </TABLE>
42 </TD>
43 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
44 </EM>
45 </TD>
46 </TR>
47
48 <TR>
49 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
50 &nbsp;<A HREF="../estraier/NodeResult.html" title="interface in estraier"><B>PREV CLASS</B></A>&nbsp;
51 &nbsp;NEXT CLASS</FONT></TD>
52 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
53 <A HREF="../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
54 &nbsp;<A HREF="ResultDocument.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
55 &nbsp;<SCRIPT type="text/javascript">
56 <!--
57 if(window==top) {
58 document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
59 }
60 //-->
61 </SCRIPT>
62 <NOSCRIPT>
63 <A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
64 </NOSCRIPT>
65
66 </FONT></TD>
67 </TR>
68 <TR>
69 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
70 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
73 </TR>
74 </TABLE>
75 <A NAME="skip-navbar_top"></A>
76 <!-- ========= END OF TOP NAVBAR ========= -->
77
78 <HR>
79 <!-- ======== START OF CLASS DATA ======== -->
80 <H2>
81 <FONT SIZE="-1">
82 estraier</FONT>
83 <BR>
84 Interface ResultDocument</H2>
85 <HR>
86 <DL>
87 <DT>public interface <B>ResultDocument</B></DL>
88
89 <P>
90 Abstraction of document in result set.
91 <P>
92
93 <P>
94 <HR>
95
96 <P>
97 <!-- ======== NESTED CLASS SUMMARY ======== -->
98
99
100 <!-- =========== FIELD SUMMARY =========== -->
101
102
103 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
104
105
106 <!-- ========== METHOD SUMMARY =========== -->
107
108 <A NAME="method_summary"><!-- --></A>
109 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
110 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
111 <TD COLSPAN=2><FONT SIZE="+2">
112 <B>Method Summary</B></FONT></TD>
113 </TR>
114 <TR BGCOLOR="white" CLASS="TableRowColor">
115 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
116 <CODE>&nbsp;java.util.List</CODE></FONT></TD>
117 <TD><CODE><B><A HREF="../estraier/ResultDocument.html#attr_names()">attr_names</A></B>()</CODE>
118
119 <BR>
120 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a list of attribute names.</TD>
121 </TR>
122 <TR BGCOLOR="white" CLASS="TableRowColor">
123 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
124 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
125 <TD><CODE><B><A HREF="../estraier/ResultDocument.html#attr(java.lang.String)">attr</A></B>(java.lang.String&nbsp;name)</CODE>
126
127 <BR>
128 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of an attribute.</TD>
129 </TR>
130 <TR BGCOLOR="white" CLASS="TableRowColor">
131 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
132 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
133 <TD><CODE><B><A HREF="../estraier/ResultDocument.html#snippet()">snippet</A></B>()</CODE>
134
135 <BR>
136 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the snippet.</TD>
137 </TR>
138 <TR BGCOLOR="white" CLASS="TableRowColor">
139 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
141 <TD><CODE><B><A HREF="../estraier/ResultDocument.html#uri()">uri</A></B>()</CODE>
142
143 <BR>
144 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the URI.</TD>
145 </TR>
146 </TABLE>
147 &nbsp;
148 <P>
149
150 <!-- ============ FIELD DETAIL =========== -->
151
152
153 <!-- ========= CONSTRUCTOR DETAIL ======== -->
154
155
156 <!-- ============ METHOD DETAIL ========== -->
157
158 <A NAME="method_detail"><!-- --></A>
159 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
160 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
161 <TD COLSPAN=1><FONT SIZE="+2">
162 <B>Method Detail</B></FONT></TD>
163 </TR>
164 </TABLE>
165
166 <A NAME="attr_names()"><!-- --></A><H3>
167 attr_names</H3>
168 <PRE>
169 public java.util.List <B>attr_names</B>()</PRE>
170 <DL>
171 <DD>Get a list of attribute names.
172 <P>
173 <DD><DL>
174
175 <DT><B>Returns:</B><DD>a list object of attribute names.</DL>
176 </DD>
177 </DL>
178 <HR>
179
180 <A NAME="attr(java.lang.String)"><!-- --></A><H3>
181 attr</H3>
182 <PRE>
183 public java.lang.String <B>attr</B>(java.lang.String&nbsp;name)</PRE>
184 <DL>
185 <DD>Get the value of an attribute.
186 <P>
187 <DD><DL>
188 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of an attribute.
189 <DT><B>Returns:</B><DD>the value of the attribute or null if it does not exist.</DL>
190 </DD>
191 </DL>
192 <HR>
193
194 <A NAME="snippet()"><!-- --></A><H3>
195 snippet</H3>
196 <PRE>
197 public java.lang.String <B>snippet</B>()</PRE>
198 <DL>
199 <DD>Get the snippet.
200 <P>
201 <DD><DL>
202
203 <DT><B>Returns:</B><DD>the snippet of the result document object. There are tab separated values. Each
204 line is a string to be shown. Though most lines have only one field, some lines have two
205 fields. If the second field exists, the first field is to be shown with highlighted, and
206 the second field means its normalized form.</DL>
207 </DD>
208 </DL>
209 <HR>
210
211 <A NAME="uri()"><!-- --></A><H3>
212 uri</H3>
213 <PRE>
214 public java.lang.String <B>uri</B>()</PRE>
215 <DL>
216 <DD>Get the URI.
217 <P>
218 <DD><DL>
219
220 <DT><B>Returns:</B><DD>the URI.</DL>
221 </DD>
222 </DL>
223 <!-- ========= END OF CLASS DATA ========= -->
224 <HR>
225
226
227 <!-- ======= START OF BOTTOM NAVBAR ====== -->
228 <A NAME="navbar_bottom"><!-- --></A>
229 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
230 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
231 <TR>
232 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
233 <A NAME="navbar_bottom_firstrow"><!-- --></A>
234 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
235 <TR ALIGN="center" VALIGN="top">
236 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
237 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
238 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
239 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
240 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
241 </TR>
242 </TABLE>
243 </TD>
244 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
245 </EM>
246 </TD>
247 </TR>
248
249 <TR>
250 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
251 &nbsp;<A HREF="../estraier/NodeResult.html" title="interface in estraier"><B>PREV CLASS</B></A>&nbsp;
252 &nbsp;NEXT CLASS</FONT></TD>
253 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
254 <A HREF="../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
255 &nbsp;<A HREF="ResultDocument.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
256 &nbsp;<SCRIPT type="text/javascript">
257 <!--
258 if(window==top) {
259 document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
260 }
261 //-->
262 </SCRIPT>
263 <NOSCRIPT>
264 <A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
265 </NOSCRIPT>
266
267 </FONT></TD>
268 </TR>
269 <TR>
270 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
271 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
272 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
273 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
274 </TR>
275 </TABLE>
276 <A NAME="skip-navbar_bottom"></A>
277 <!-- ======== END OF BOTTOM NAVBAR ======= -->
278
279 <HR>
280
281 </BODY>
282 </HTML>

  ViewVC Help
Powered by ViewVC 1.1.26