/[hyperestraier]/upstream/0.5.3/doc/japidoc/estraier/Document.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/Document.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 9 - (show annotations)
Wed Aug 3 15:21:15 2005 UTC (18 years, 9 months ago) by dpavlin
Original Path: upstream/0.5.2/doc/japidoc/estraier/Document.html
File MIME type: text/html
File size: 14393 byte(s)
import upstream version 0.5.2

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 Jul 25 11:24:18 JST 2005 -->
6 <TITLE>
7 Document (estraier)
8 </TITLE>
9
10 <META NAME="keywords" CONTENT="estraier.Document 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="Document (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/ConditionImpl.html" title="class in estraier"><B>PREV CLASS</B></A>&nbsp;
51 &nbsp;<A HREF="../estraier/DocumentImpl.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="Document.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 Document</H2>
85 <DL>
86 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../estraier/DocumentImpl.html" title="class in estraier">DocumentImpl</A></DD>
87 </DL>
88 <HR>
89 <DL>
90 <DT>public interface <B>Document</B></DL>
91
92 <P>
93 Abstraction of document.
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;void</CODE></FONT></TD>
120 <TD><CODE><B><A HREF="../estraier/Document.html#add_attr(java.lang.String, java.lang.String)">add_attr</A></B>(java.lang.String&nbsp;name,
121 java.lang.String&nbsp;value)</CODE>
122
123 <BR>
124 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add an attribute.</TD>
125 </TR>
126 <TR BGCOLOR="white" CLASS="TableRowColor">
127 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128 <CODE>&nbsp;void</CODE></FONT></TD>
129 <TD><CODE><B><A HREF="../estraier/Document.html#add_hidden_text(java.lang.String)">add_hidden_text</A></B>(java.lang.String&nbsp;text)</CODE>
130
131 <BR>
132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a hidden sentence.</TD>
133 </TR>
134 <TR BGCOLOR="white" CLASS="TableRowColor">
135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
136 <CODE>&nbsp;void</CODE></FONT></TD>
137 <TD><CODE><B><A HREF="../estraier/Document.html#add_text(java.lang.String)">add_text</A></B>(java.lang.String&nbsp;text)</CODE>
138
139 <BR>
140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a sentence of text.</TD>
141 </TR>
142 <TR BGCOLOR="white" CLASS="TableRowColor">
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144 <CODE>&nbsp;java.util.List</CODE></FONT></TD>
145 <TD><CODE><B><A HREF="../estraier/Document.html#attr_names()">attr_names</A></B>()</CODE>
146
147 <BR>
148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a list of attribute names.</TD>
149 </TR>
150 <TR BGCOLOR="white" CLASS="TableRowColor">
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
153 <TD><CODE><B><A HREF="../estraier/Document.html#attr(java.lang.String)">attr</A></B>(java.lang.String&nbsp;name)</CODE>
154
155 <BR>
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of an attribute.</TD>
157 </TR>
158 <TR BGCOLOR="white" CLASS="TableRowColor">
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
161 <TD><CODE><B><A HREF="../estraier/Document.html#cat_texts()">cat_texts</A></B>()</CODE>
162
163 <BR>
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Concatenate sentences of the text.</TD>
165 </TR>
166 <TR BGCOLOR="white" CLASS="TableRowColor">
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
169 <TD><CODE><B><A HREF="../estraier/Document.html#dump_draft()">dump_draft</A></B>()</CODE>
170
171 <BR>
172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dump draft data.</TD>
173 </TR>
174 <TR BGCOLOR="white" CLASS="TableRowColor">
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176 <CODE>&nbsp;int</CODE></FONT></TD>
177 <TD><CODE><B><A HREF="../estraier/Document.html#id()">id</A></B>()</CODE>
178
179 <BR>
180 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the ID number.</TD>
181 </TR>
182 <TR BGCOLOR="white" CLASS="TableRowColor">
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
185 <TD><CODE><B><A HREF="../estraier/Document.html#make_snippet(java.util.List, int, int, int)">make_snippet</A></B>(java.util.List&nbsp;words,
186 int&nbsp;wwidth,
187 int&nbsp;hwidth,
188 int&nbsp;awidth)</CODE>
189
190 <BR>
191 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Make a snippet of the body text.</TD>
192 </TR>
193 <TR BGCOLOR="white" CLASS="TableRowColor">
194 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195 <CODE>&nbsp;boolean</CODE></FONT></TD>
196 <TD><CODE><B><A HREF="../estraier/Document.html#scan_words(java.util.List)">scan_words</A></B>(java.util.List&nbsp;words)</CODE>
197
198 <BR>
199 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check whether the text includes every specified words.</TD>
200 </TR>
201 <TR BGCOLOR="white" CLASS="TableRowColor">
202 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203 <CODE>&nbsp;java.util.List</CODE></FONT></TD>
204 <TD><CODE><B><A HREF="../estraier/Document.html#texts()">texts</A></B>()</CODE>
205
206 <BR>
207 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a list of sentences of the text.</TD>
208 </TR>
209 </TABLE>
210 &nbsp;
211 <P>
212
213 <!-- ============ FIELD DETAIL =========== -->
214
215
216 <!-- ========= CONSTRUCTOR DETAIL ======== -->
217
218
219 <!-- ============ METHOD DETAIL ========== -->
220
221 <A NAME="method_detail"><!-- --></A>
222 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
223 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
224 <TD COLSPAN=1><FONT SIZE="+2">
225 <B>Method Detail</B></FONT></TD>
226 </TR>
227 </TABLE>
228
229 <A NAME="add_attr(java.lang.String, java.lang.String)"><!-- --></A><H3>
230 add_attr</H3>
231 <PRE>
232 public void <B>add_attr</B>(java.lang.String&nbsp;name,
233 java.lang.String&nbsp;value)</PRE>
234 <DL>
235 <DD>Add an attribute.
236 <P>
237 <DD><DL>
238 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of an attribute.<DD><CODE>value</CODE> - the value of the attribute. If it is null, the attribute is removed.</DL>
239 </DD>
240 </DL>
241 <HR>
242
243 <A NAME="add_hidden_text(java.lang.String)"><!-- --></A><H3>
244 add_hidden_text</H3>
245 <PRE>
246 public void <B>add_hidden_text</B>(java.lang.String&nbsp;text)</PRE>
247 <DL>
248 <DD>Add a hidden sentence.
249 <P>
250 <DD><DL>
251 <DT><B>Parameters:</B><DD><CODE>text</CODE> - a hidden sentence.</DL>
252 </DD>
253 </DL>
254 <HR>
255
256 <A NAME="add_text(java.lang.String)"><!-- --></A><H3>
257 add_text</H3>
258 <PRE>
259 public void <B>add_text</B>(java.lang.String&nbsp;text)</PRE>
260 <DL>
261 <DD>Add a sentence of text.
262 <P>
263 <DD><DL>
264 <DT><B>Parameters:</B><DD><CODE>text</CODE> - sentence of text.</DL>
265 </DD>
266 </DL>
267 <HR>
268
269 <A NAME="attr_names()"><!-- --></A><H3>
270 attr_names</H3>
271 <PRE>
272 public java.util.List <B>attr_names</B>()</PRE>
273 <DL>
274 <DD>Get a list of attribute names.
275 <P>
276 <DD><DL>
277
278 <DT><B>Returns:</B><DD>a list of attribute names.</DL>
279 </DD>
280 </DL>
281 <HR>
282
283 <A NAME="attr(java.lang.String)"><!-- --></A><H3>
284 attr</H3>
285 <PRE>
286 public java.lang.String <B>attr</B>(java.lang.String&nbsp;name)</PRE>
287 <DL>
288 <DD>Get the value of an attribute.
289 <P>
290 <DD><DL>
291 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of an attribute.
292 <DT><B>Returns:</B><DD>the value of the attribute or null if it does not exist.</DL>
293 </DD>
294 </DL>
295 <HR>
296
297 <A NAME="cat_texts()"><!-- --></A><H3>
298 cat_texts</H3>
299 <PRE>
300 public java.lang.String <B>cat_texts</B>()</PRE>
301 <DL>
302 <DD>Concatenate sentences of the text.
303 <P>
304 <DD><DL>
305
306 <DT><B>Returns:</B><DD>concatenated sentences of a document object.</DL>
307 </DD>
308 </DL>
309 <HR>
310
311 <A NAME="dump_draft()"><!-- --></A><H3>
312 dump_draft</H3>
313 <PRE>
314 public java.lang.String <B>dump_draft</B>()</PRE>
315 <DL>
316 <DD>Dump draft data.
317 <P>
318 <DD><DL>
319
320 <DT><B>Returns:</B><DD>draft data.</DL>
321 </DD>
322 </DL>
323 <HR>
324
325 <A NAME="id()"><!-- --></A><H3>
326 id</H3>
327 <PRE>
328 public int <B>id</B>()</PRE>
329 <DL>
330 <DD>Get the ID number.
331 <P>
332 <DD><DL>
333
334 <DT><B>Returns:</B><DD>the ID number. If this object has never been registered, -1 is returned.</DL>
335 </DD>
336 </DL>
337 <HR>
338
339 <A NAME="make_snippet(java.util.List, int, int, int)"><!-- --></A><H3>
340 make_snippet</H3>
341 <PRE>
342 public java.lang.String <B>make_snippet</B>(java.util.List&nbsp;words,
343 int&nbsp;wwidth,
344 int&nbsp;hwidth,
345 int&nbsp;awidth)</PRE>
346 <DL>
347 <DD>Make a snippet of the body text.
348 <P>
349 <DD><DL>
350 <DT><B>Parameters:</B><DD><CODE>words</CODE> - a list object of words to be highlight.<DD><CODE>wwidth</CODE> - whole width of the result.<DD><CODE>hwidth</CODE> - width of strings picked up from the beginning of the text.<DD><CODE>awidth</CODE> - width of strings picked up around each highlighted word.
351 <DT><B>Returns:</B><DD>a snippet string of the body text.</DL>
352 </DD>
353 </DL>
354 <HR>
355
356 <A NAME="scan_words(java.util.List)"><!-- --></A><H3>
357 scan_words</H3>
358 <PRE>
359 public boolean <B>scan_words</B>(java.util.List&nbsp;words)</PRE>
360 <DL>
361 <DD>Check whether the text includes every specified words.
362 <P>
363 <DD><DL>
364 <DT><B>Parameters:</B><DD><CODE>words</CODE> - a list object of words to be checked.
365 <DT><B>Returns:</B><DD>true if every specified words is found, else it is false.</DL>
366 </DD>
367 </DL>
368 <HR>
369
370 <A NAME="texts()"><!-- --></A><H3>
371 texts</H3>
372 <PRE>
373 public java.util.List <B>texts</B>()</PRE>
374 <DL>
375 <DD>Get a list of sentences of the text.
376 <P>
377 <DD><DL>
378
379 <DT><B>Returns:</B><DD>a list object of sentences of the text.</DL>
380 </DD>
381 </DL>
382 <!-- ========= END OF CLASS DATA ========= -->
383 <HR>
384
385
386 <!-- ======= START OF BOTTOM NAVBAR ====== -->
387 <A NAME="navbar_bottom"><!-- --></A>
388 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
389 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
390 <TR>
391 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
392 <A NAME="navbar_bottom_firstrow"><!-- --></A>
393 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
394 <TR ALIGN="center" VALIGN="top">
395 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
396 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
397 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
398 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
399 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
400 </TR>
401 </TABLE>
402 </TD>
403 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
404 </EM>
405 </TD>
406 </TR>
407
408 <TR>
409 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
410 &nbsp;<A HREF="../estraier/ConditionImpl.html" title="class in estraier"><B>PREV CLASS</B></A>&nbsp;
411 &nbsp;<A HREF="../estraier/DocumentImpl.html" title="class in estraier"><B>NEXT CLASS</B></A></FONT></TD>
412 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
413 <A HREF="../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
414 &nbsp;<A HREF="Document.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
415 &nbsp;<SCRIPT type="text/javascript">
416 <!--
417 if(window==top) {
418 document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
419 }
420 //-->
421 </SCRIPT>
422 <NOSCRIPT>
423 <A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
424 </NOSCRIPT>
425
426 </FONT></TD>
427 </TR>
428 <TR>
429 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
430 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
431 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
432 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
433 </TR>
434 </TABLE>
435 <A NAME="skip-navbar_bottom"></A>
436 <!-- ======== END OF BOTTOM NAVBAR ======= -->
437
438 <HR>
439
440 </BODY>
441 </HTML>

  ViewVC Help
Powered by ViewVC 1.1.26