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 |
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> </TD> |
36 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
37 |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
38 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
39 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </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 |
<A HREF="../estraier/CreatorImpl.html" title="class in estraier"><B>PREV CLASS</B></A> |
51 |
<A HREF="../estraier/Node.html" title="interface 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> |
54 |
<A HREF="Document.html" target="_top"><B>NO FRAMES</B></A> |
55 |
<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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
71 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
72 |
DETAIL: FIELD | CONSTR | <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 |
<HR> |
86 |
<DL> |
87 |
<DT>public interface <B>Document</B></DL> |
88 |
|
89 |
<P> |
90 |
Abstraction of document. |
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> void</CODE></FONT></TD> |
117 |
<TD><CODE><B><A HREF="../estraier/Document.html#add_attr(java.lang.String, java.lang.String)">add_attr</A></B>(java.lang.String name, |
118 |
java.lang.String value)</CODE> |
119 |
|
120 |
<BR> |
121 |
Add an attribute.</TD> |
122 |
</TR> |
123 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
124 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
125 |
<CODE> void</CODE></FONT></TD> |
126 |
<TD><CODE><B><A HREF="../estraier/Document.html#add_hidden_text(java.lang.String)">add_hidden_text</A></B>(java.lang.String text)</CODE> |
127 |
|
128 |
<BR> |
129 |
Add a hidden sentence.</TD> |
130 |
</TR> |
131 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
132 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
133 |
<CODE> void</CODE></FONT></TD> |
134 |
<TD><CODE><B><A HREF="../estraier/Document.html#add_text(java.lang.String)">add_text</A></B>(java.lang.String text)</CODE> |
135 |
|
136 |
<BR> |
137 |
Add a sentence of text.</TD> |
138 |
</TR> |
139 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
140 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
141 |
<CODE> java.util.List</CODE></FONT></TD> |
142 |
<TD><CODE><B><A HREF="../estraier/Document.html#attr_names()">attr_names</A></B>()</CODE> |
143 |
|
144 |
<BR> |
145 |
Get a list of attribute names.</TD> |
146 |
</TR> |
147 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
148 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
149 |
<CODE> java.lang.String</CODE></FONT></TD> |
150 |
<TD><CODE><B><A HREF="../estraier/Document.html#attr(java.lang.String)">attr</A></B>(java.lang.String name)</CODE> |
151 |
|
152 |
<BR> |
153 |
Get the value of an attribute.</TD> |
154 |
</TR> |
155 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
156 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
157 |
<CODE> java.lang.String</CODE></FONT></TD> |
158 |
<TD><CODE><B><A HREF="../estraier/Document.html#cat_texts()">cat_texts</A></B>()</CODE> |
159 |
|
160 |
<BR> |
161 |
Concatenate sentences of the text.</TD> |
162 |
</TR> |
163 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
164 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
165 |
<CODE> java.lang.String</CODE></FONT></TD> |
166 |
<TD><CODE><B><A HREF="../estraier/Document.html#dump_draft()">dump_draft</A></B>()</CODE> |
167 |
|
168 |
<BR> |
169 |
Dump draft data.</TD> |
170 |
</TR> |
171 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
172 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
173 |
<CODE> int</CODE></FONT></TD> |
174 |
<TD><CODE><B><A HREF="../estraier/Document.html#id()">id</A></B>()</CODE> |
175 |
|
176 |
<BR> |
177 |
Get the ID number.</TD> |
178 |
</TR> |
179 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
180 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
181 |
<CODE> java.lang.String</CODE></FONT></TD> |
182 |
<TD><CODE><B><A HREF="../estraier/Document.html#make_snippet(java.util.List, int, int, int)">make_snippet</A></B>(java.util.List words, |
183 |
int wwidth, |
184 |
int hwidth, |
185 |
int awidth)</CODE> |
186 |
|
187 |
<BR> |
188 |
Make a snippet of the body text.</TD> |
189 |
</TR> |
190 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
191 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
192 |
<CODE> boolean</CODE></FONT></TD> |
193 |
<TD><CODE><B><A HREF="../estraier/Document.html#scan_words(java.util.List)">scan_words</A></B>(java.util.List words)</CODE> |
194 |
|
195 |
<BR> |
196 |
Check whether the text includes every specified words.</TD> |
197 |
</TR> |
198 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
199 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
200 |
<CODE> java.util.List</CODE></FONT></TD> |
201 |
<TD><CODE><B><A HREF="../estraier/Document.html#texts()">texts</A></B>()</CODE> |
202 |
|
203 |
<BR> |
204 |
Get a list of sentences of the text.</TD> |
205 |
</TR> |
206 |
</TABLE> |
207 |
|
208 |
<P> |
209 |
|
210 |
<!-- ============ FIELD DETAIL =========== --> |
211 |
|
212 |
|
213 |
<!-- ========= CONSTRUCTOR DETAIL ======== --> |
214 |
|
215 |
|
216 |
<!-- ============ METHOD DETAIL ========== --> |
217 |
|
218 |
<A NAME="method_detail"><!-- --></A> |
219 |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
220 |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
221 |
<TD COLSPAN=1><FONT SIZE="+2"> |
222 |
<B>Method Detail</B></FONT></TD> |
223 |
</TR> |
224 |
</TABLE> |
225 |
|
226 |
<A NAME="add_attr(java.lang.String, java.lang.String)"><!-- --></A><H3> |
227 |
add_attr</H3> |
228 |
<PRE> |
229 |
public void <B>add_attr</B>(java.lang.String name, |
230 |
java.lang.String value)</PRE> |
231 |
<DL> |
232 |
<DD>Add an attribute. |
233 |
<P> |
234 |
<DD><DL> |
235 |
<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> |
236 |
</DD> |
237 |
</DL> |
238 |
<HR> |
239 |
|
240 |
<A NAME="add_hidden_text(java.lang.String)"><!-- --></A><H3> |
241 |
add_hidden_text</H3> |
242 |
<PRE> |
243 |
public void <B>add_hidden_text</B>(java.lang.String text)</PRE> |
244 |
<DL> |
245 |
<DD>Add a hidden sentence. |
246 |
<P> |
247 |
<DD><DL> |
248 |
<DT><B>Parameters:</B><DD><CODE>text</CODE> - a hidden sentence.</DL> |
249 |
</DD> |
250 |
</DL> |
251 |
<HR> |
252 |
|
253 |
<A NAME="add_text(java.lang.String)"><!-- --></A><H3> |
254 |
add_text</H3> |
255 |
<PRE> |
256 |
public void <B>add_text</B>(java.lang.String text)</PRE> |
257 |
<DL> |
258 |
<DD>Add a sentence of text. |
259 |
<P> |
260 |
<DD><DL> |
261 |
<DT><B>Parameters:</B><DD><CODE>text</CODE> - sentence of text.</DL> |
262 |
</DD> |
263 |
</DL> |
264 |
<HR> |
265 |
|
266 |
<A NAME="attr_names()"><!-- --></A><H3> |
267 |
attr_names</H3> |
268 |
<PRE> |
269 |
public java.util.List <B>attr_names</B>()</PRE> |
270 |
<DL> |
271 |
<DD>Get a list of attribute names. |
272 |
<P> |
273 |
<DD><DL> |
274 |
|
275 |
<DT><B>Returns:</B><DD>a list object of attribute names.</DL> |
276 |
</DD> |
277 |
</DL> |
278 |
<HR> |
279 |
|
280 |
<A NAME="attr(java.lang.String)"><!-- --></A><H3> |
281 |
attr</H3> |
282 |
<PRE> |
283 |
public java.lang.String <B>attr</B>(java.lang.String name)</PRE> |
284 |
<DL> |
285 |
<DD>Get the value of an attribute. |
286 |
<P> |
287 |
<DD><DL> |
288 |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of an attribute. |
289 |
<DT><B>Returns:</B><DD>the value of the attribute or null if it does not exist.</DL> |
290 |
</DD> |
291 |
</DL> |
292 |
<HR> |
293 |
|
294 |
<A NAME="cat_texts()"><!-- --></A><H3> |
295 |
cat_texts</H3> |
296 |
<PRE> |
297 |
public java.lang.String <B>cat_texts</B>()</PRE> |
298 |
<DL> |
299 |
<DD>Concatenate sentences of the text. |
300 |
<P> |
301 |
<DD><DL> |
302 |
|
303 |
<DT><B>Returns:</B><DD>concatenated sentences.</DL> |
304 |
</DD> |
305 |
</DL> |
306 |
<HR> |
307 |
|
308 |
<A NAME="dump_draft()"><!-- --></A><H3> |
309 |
dump_draft</H3> |
310 |
<PRE> |
311 |
public java.lang.String <B>dump_draft</B>()</PRE> |
312 |
<DL> |
313 |
<DD>Dump draft data. |
314 |
<P> |
315 |
<DD><DL> |
316 |
|
317 |
<DT><B>Returns:</B><DD>draft data.</DL> |
318 |
</DD> |
319 |
</DL> |
320 |
<HR> |
321 |
|
322 |
<A NAME="id()"><!-- --></A><H3> |
323 |
id</H3> |
324 |
<PRE> |
325 |
public int <B>id</B>()</PRE> |
326 |
<DL> |
327 |
<DD>Get the ID number. |
328 |
<P> |
329 |
<DD><DL> |
330 |
|
331 |
<DT><B>Returns:</B><DD>the ID number. If this object has never been registered, -1 is returned.</DL> |
332 |
</DD> |
333 |
</DL> |
334 |
<HR> |
335 |
|
336 |
<A NAME="make_snippet(java.util.List, int, int, int)"><!-- --></A><H3> |
337 |
make_snippet</H3> |
338 |
<PRE> |
339 |
public java.lang.String <B>make_snippet</B>(java.util.List words, |
340 |
int wwidth, |
341 |
int hwidth, |
342 |
int awidth)</PRE> |
343 |
<DL> |
344 |
<DD>Make a snippet of the body text. |
345 |
<P> |
346 |
<DD><DL> |
347 |
<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. |
348 |
<DT><B>Returns:</B><DD>a snippet string of the body text. There are tab separated values. Each line is a |
349 |
string to be shown. Though most lines have only one field, some lines have two fields. If |
350 |
the second field exists, the first field is to be shown with highlighted, and the second |
351 |
field means its normalized form.</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 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> </TD> |
396 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
397 |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
398 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
399 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </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 |
<A HREF="../estraier/CreatorImpl.html" title="class in estraier"><B>PREV CLASS</B></A> |
411 |
<A HREF="../estraier/Node.html" title="interface 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> |
414 |
<A HREF="Document.html" target="_top"><B>NO FRAMES</B></A> |
415 |
<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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
431 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
432 |
DETAIL: FIELD | CONSTR | <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> |