/[hyperestraier]/upstream/0.5.2/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

Annotation of /upstream/0.5.2/doc/japidoc/estraier/ResultDocument.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 9 - (hide annotations)
Wed Aug 3 15:21:15 2005 UTC (18 years, 10 months ago) by dpavlin
File MIME type: text/html
File size: 9305 byte(s)
import upstream version 0.5.2

1 dpavlin 9 <!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 Jul 25 11:24:18 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/NodeResultImpl.html" title="class in estraier"><B>PREV CLASS</B></A>&nbsp;
51     &nbsp;<A HREF="../estraier/ResultDocumentImpl.html" title="class in estraier"><B>NEXT CLASS</B></A></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     <DL>
86     <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../estraier/ResultDocumentImpl.html" title="class in estraier">ResultDocumentImpl</A></DD>
87     </DL>
88     <HR>
89     <DL>
90     <DT>public interface <B>ResultDocument</B></DL>
91    
92     <P>
93     Abstraction of document in result set.
94     <P>
95    
96     <P>
97     <HR>
98    
99     <P>
100     <!-- ======== NESTED CLASS SUMMARY ======== -->
101    
102    
103     <!-- =========== FIELD SUMMARY =========== -->
104    
105    
106     <!-- ======== CONSTRUCTOR SUMMARY ======== -->
107    
108    
109     <!-- ========== METHOD SUMMARY =========== -->
110    
111     <A NAME="method_summary"><!-- --></A>
112     <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
113     <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
114     <TD COLSPAN=2><FONT SIZE="+2">
115     <B>Method Summary</B></FONT></TD>
116     </TR>
117     <TR BGCOLOR="white" CLASS="TableRowColor">
118     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
119     <CODE>&nbsp;java.util.List</CODE></FONT></TD>
120     <TD><CODE><B><A HREF="../estraier/ResultDocument.html#attr_names()">attr_names</A></B>()</CODE>
121    
122     <BR>
123     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a list of attribute names.</TD>
124     </TR>
125     <TR BGCOLOR="white" CLASS="TableRowColor">
126     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127     <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
128     <TD><CODE><B><A HREF="../estraier/ResultDocument.html#attr(java.lang.String)">attr</A></B>(java.lang.String&nbsp;name)</CODE>
129    
130     <BR>
131     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of an attribute.</TD>
132     </TR>
133     <TR BGCOLOR="white" CLASS="TableRowColor">
134     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135     <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
136     <TD><CODE><B><A HREF="../estraier/ResultDocument.html#snippet()">snippet</A></B>()</CODE>
137    
138     <BR>
139     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the snippet.</TD>
140     </TR>
141     <TR BGCOLOR="white" CLASS="TableRowColor">
142     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143     <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
144     <TD><CODE><B><A HREF="../estraier/ResultDocument.html#uri()">uri</A></B>()</CODE>
145    
146     <BR>
147     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the URI.</TD>
148     </TR>
149     </TABLE>
150     &nbsp;
151     <P>
152    
153     <!-- ============ FIELD DETAIL =========== -->
154    
155    
156     <!-- ========= CONSTRUCTOR DETAIL ======== -->
157    
158    
159     <!-- ============ METHOD DETAIL ========== -->
160    
161     <A NAME="method_detail"><!-- --></A>
162     <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
163     <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
164     <TD COLSPAN=1><FONT SIZE="+2">
165     <B>Method Detail</B></FONT></TD>
166     </TR>
167     </TABLE>
168    
169     <A NAME="attr_names()"><!-- --></A><H3>
170     attr_names</H3>
171     <PRE>
172     public java.util.List <B>attr_names</B>()</PRE>
173     <DL>
174     <DD>Get a list of attribute names.
175     <P>
176     <DD><DL>
177    
178     <DT><B>Returns:</B><DD>a list of attribute names.</DL>
179     </DD>
180     </DL>
181     <HR>
182    
183     <A NAME="attr(java.lang.String)"><!-- --></A><H3>
184     attr</H3>
185     <PRE>
186     public java.lang.String <B>attr</B>(java.lang.String&nbsp;name)</PRE>
187     <DL>
188     <DD>Get the value of an attribute.
189     <P>
190     <DD><DL>
191     <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of an attribute.
192     <DT><B>Returns:</B><DD>the value of the attribute or null if it does not exist.</DL>
193     </DD>
194     </DL>
195     <HR>
196    
197     <A NAME="snippet()"><!-- --></A><H3>
198     snippet</H3>
199     <PRE>
200     public java.lang.String <B>snippet</B>()</PRE>
201     <DL>
202     <DD>Get the snippet.
203     <P>
204     <DD><DL>
205    
206     <DT><B>Returns:</B><DD>the snippet of the result document object. There are tab separated values. Each
207     line is a string to be shown. Though most lines have only one field, some lines have two
208     fields. If the second field exists, the first field is to be shown with highlighted, and
209     the second field means its normalized form.</DL>
210     </DD>
211     </DL>
212     <HR>
213    
214     <A NAME="uri()"><!-- --></A><H3>
215     uri</H3>
216     <PRE>
217     public java.lang.String <B>uri</B>()</PRE>
218     <DL>
219     <DD>Get the URI.
220     <P>
221     <DD><DL>
222    
223     <DT><B>Returns:</B><DD>the URI.</DL>
224     </DD>
225     </DL>
226     <!-- ========= END OF CLASS DATA ========= -->
227     <HR>
228    
229    
230     <!-- ======= START OF BOTTOM NAVBAR ====== -->
231     <A NAME="navbar_bottom"><!-- --></A>
232     <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
233     <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
234     <TR>
235     <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
236     <A NAME="navbar_bottom_firstrow"><!-- --></A>
237     <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
238     <TR ALIGN="center" VALIGN="top">
239     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
240     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
241     <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
242     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
243     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
244     </TR>
245     </TABLE>
246     </TD>
247     <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
248     </EM>
249     </TD>
250     </TR>
251    
252     <TR>
253     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
254     &nbsp;<A HREF="../estraier/NodeResultImpl.html" title="class in estraier"><B>PREV CLASS</B></A>&nbsp;
255     &nbsp;<A HREF="../estraier/ResultDocumentImpl.html" title="class in estraier"><B>NEXT CLASS</B></A></FONT></TD>
256     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
257     <A HREF="../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
258     &nbsp;<A HREF="ResultDocument.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
259     &nbsp;<SCRIPT type="text/javascript">
260     <!--
261     if(window==top) {
262     document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
263     }
264     //-->
265     </SCRIPT>
266     <NOSCRIPT>
267     <A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
268     </NOSCRIPT>
269    
270     </FONT></TD>
271     </TR>
272     <TR>
273     <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
274     SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
275     <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
276     DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
277     </TR>
278     </TABLE>
279     <A NAME="skip-navbar_bottom"></A>
280     <!-- ======== END OF BOTTOM NAVBAR ======= -->
281    
282     <HR>
283    
284     </BODY>
285     </HTML>

  ViewVC Help
Powered by ViewVC 1.1.26