~ubuntu-branches/ubuntu/trusty/hyperestraier/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/javapureapi/estraier/pure/Node.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2006-11-14 05:28:32 UTC
  • mfrom: (2.1.4 feisty)
  • Revision ID: james.westby@ubuntu.com-20061114052832-0lzqzcefn8mt4yqe
Tags: 1.4.9-1.1
* Non-maintainer upload.
* High-urgency upload for RC bugfix.
* Set HOME=$(CURDIR)/junkhome when building, otherwise the package build
  will incorrectly look for headers there -- and fail when the directory
  exists and is unreadable, as happens sometimes on sudo-using
  autobuilders!

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<!--NewPage-->
3
3
<HTML>
4
4
<HEAD>
5
 
<!-- Generated by javadoc (build 1.4.2_06) on Fri Nov 18 00:48:31 JST 2005 -->
 
5
<!-- Generated by javadoc (build 1.4.2_06) on Sat Nov 11 19:57:56 JST 2006 -->
6
6
<TITLE>
7
7
Node (estraier.pure)
8
8
</TITLE>
130
130
</TR>
131
131
<TR BGCOLOR="white" CLASS="TableRowColor">
132
132
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
133
<CODE>&nbsp;java.util.List</CODE></FONT></TD>
 
134
<TD><CODE><B><A HREF="../../estraier/pure/Node.html#admins()">admins</A></B>()</CODE>
 
135
 
 
136
<BR>
 
137
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a list of names of administrators.</TD>
 
138
</TR>
 
139
<TR BGCOLOR="white" CLASS="TableRowColor">
 
140
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
141
<CODE>&nbsp;double</CODE></FONT></TD>
 
142
<TD><CODE><B><A HREF="../../estraier/pure/Node.html#cache_usage()">cache_usage</A></B>()</CODE>
 
143
 
 
144
<BR>
 
145
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the usage ratio of the cache.</TD>
 
146
</TR>
 
147
<TR BGCOLOR="white" CLASS="TableRowColor">
 
148
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133
149
<CODE>&nbsp;int</CODE></FONT></TD>
134
150
<TD><CODE><B><A HREF="../../estraier/pure/Node.html#doc_num()">doc_num</A></B>()</CODE>
135
151
 
204
220
</TR>
205
221
<TR BGCOLOR="white" CLASS="TableRowColor">
206
222
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
223
<CODE>&nbsp;java.util.List</CODE></FONT></TD>
 
224
<TD><CODE><B><A HREF="../../estraier/pure/Node.html#links()">links</A></B>()</CODE>
 
225
 
 
226
<BR>
 
227
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a list of expressions of links.</TD>
 
228
</TR>
 
229
<TR BGCOLOR="white" CLASS="TableRowColor">
 
230
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207
231
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
208
232
<TD><CODE><B><A HREF="../../estraier/pure/Node.html#name()">name</A></B>()</CODE>
209
233
 
213
237
<TR BGCOLOR="white" CLASS="TableRowColor">
214
238
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215
239
<CODE>&nbsp;boolean</CODE></FONT></TD>
 
240
<TD><CODE><B><A HREF="../../estraier/pure/Node.html#optimize()">optimize</A></B>()</CODE>
 
241
 
 
242
<BR>
 
243
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Optimize the database.</TD>
 
244
</TR>
 
245
<TR BGCOLOR="white" CLASS="TableRowColor">
 
246
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
247
<CODE>&nbsp;boolean</CODE></FONT></TD>
216
248
<TD><CODE><B><A HREF="../../estraier/pure/Node.html#out_doc_by_uri(java.lang.String)">out_doc_by_uri</A></B>(java.lang.String&nbsp;uri)</CODE>
217
249
 
218
250
<BR>
241
273
       int&nbsp;depth)</CODE>
242
274
 
243
275
<BR>
244
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Search documents corresponding a condition.</TD>
 
276
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Search for documents corresponding a condition.</TD>
245
277
</TR>
246
278
<TR BGCOLOR="white" CLASS="TableRowColor">
247
279
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
312
344
<TD><CODE><B><A HREF="../../estraier/pure/Node.html#size()">size</A></B>()</CODE>
313
345
 
314
346
<BR>
315
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the size of the datbase of a node.</TD>
 
347
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the size of the datbase.</TD>
316
348
</TR>
317
349
<TR BGCOLOR="white" CLASS="TableRowColor">
318
350
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
324
356
</TR>
325
357
<TR BGCOLOR="white" CLASS="TableRowColor">
326
358
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
359
<CODE>&nbsp;boolean</CODE></FONT></TD>
 
360
<TD><CODE><B><A HREF="../../estraier/pure/Node.html#sync()">sync</A></B>()</CODE>
 
361
 
 
362
<BR>
 
363
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Synchronize updating contents of the database.</TD>
 
364
</TR>
 
365
<TR BGCOLOR="white" CLASS="TableRowColor">
 
366
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
327
367
<CODE>&nbsp;int</CODE></FONT></TD>
328
368
<TD><CODE><B><A HREF="../../estraier/pure/Node.html#uri_to_id(java.lang.String)">uri_to_id</A></B>(java.lang.String&nbsp;uri)</CODE>
329
369
 
332
372
</TR>
333
373
<TR BGCOLOR="white" CLASS="TableRowColor">
334
374
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
375
<CODE>&nbsp;java.util.List</CODE></FONT></TD>
 
376
<TD><CODE><B><A HREF="../../estraier/pure/Node.html#users()">users</A></B>()</CODE>
 
377
 
 
378
<BR>
 
379
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a list of names of users.</TD>
 
380
</TR>
 
381
<TR BGCOLOR="white" CLASS="TableRowColor">
 
382
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
335
383
<CODE>&nbsp;int</CODE></FONT></TD>
336
384
<TD><CODE><B><A HREF="../../estraier/pure/Node.html#word_num()">word_num</A></B>()</CODE>
337
385
 
383
431
</TR>
384
432
</TABLE>
385
433
 
 
434
<A NAME="admins()"><!-- --></A><H3>
 
435
admins</H3>
 
436
<PRE>
 
437
public java.util.List <B>admins</B>()</PRE>
 
438
<DL>
 
439
<DD>Get a list of names of administrators.
 
440
<P>
 
441
<DD><DL>
 
442
 
 
443
<DT><B>Returns:</B><DD>a list object of names of administrators.  On error, `null' is returned.</DL>
 
444
</DD>
 
445
</DL>
 
446
<HR>
 
447
 
 
448
<A NAME="cache_usage()"><!-- --></A><H3>
 
449
cache_usage</H3>
 
450
<PRE>
 
451
public double <B>cache_usage</B>()</PRE>
 
452
<DL>
 
453
<DD>Get the usage ratio of the cache.
 
454
<P>
 
455
<DD><DL>
 
456
 
 
457
<DT><B>Returns:</B><DD>the usage ratio of the cache.  On error, -1.0 is returned.</DL>
 
458
</DD>
 
459
</DL>
 
460
<HR>
 
461
 
386
462
<A NAME="doc_num()"><!-- --></A><H3>
387
463
doc_num</H3>
388
464
<PRE>
511
587
</DL>
512
588
<HR>
513
589
 
 
590
<A NAME="links()"><!-- --></A><H3>
 
591
links</H3>
 
592
<PRE>
 
593
public java.util.List <B>links</B>()</PRE>
 
594
<DL>
 
595
<DD>Get a list of expressions of links.
 
596
<P>
 
597
<DD><DL>
 
598
 
 
599
<DT><B>Returns:</B><DD>a list object of expressions of links.  Each element is a TSV string and has three
 
600
 fields of the URL, the label, and the score.  On error, `null' is returned.</DL>
 
601
</DD>
 
602
</DL>
 
603
<HR>
 
604
 
514
605
<A NAME="name()"><!-- --></A><H3>
515
606
name</H3>
516
607
<PRE>
525
616
</DL>
526
617
<HR>
527
618
 
 
619
<A NAME="optimize()"><!-- --></A><H3>
 
620
optimize</H3>
 
621
<PRE>
 
622
public boolean <B>optimize</B>()</PRE>
 
623
<DL>
 
624
<DD>Optimize the database.
 
625
<P>
 
626
<DD><DL>
 
627
 
 
628
<DT><B>Returns:</B><DD>true if success, else it is false.</DL>
 
629
</DD>
 
630
</DL>
 
631
<HR>
 
632
 
528
633
<A NAME="out_doc_by_uri(java.lang.String)"><!-- --></A><H3>
529
634
out_doc_by_uri</H3>
530
635
<PRE>
573
678
public <A HREF="../../estraier/pure/NodeResult.html" title="class in estraier.pure">NodeResult</A> <B>search</B>(<A HREF="../../estraier/pure/Condition.html" title="class in estraier.pure">Condition</A>&nbsp;cond,
574
679
                         int&nbsp;depth)</PRE>
575
680
<DL>
576
 
<DD>Search documents corresponding a condition.
 
681
<DD>Search for documents corresponding a condition.
577
682
<P>
578
683
<DD><DL>
579
684
<DT><B>Parameters:</B><DD><CODE>cond</CODE> - a condition object.<DD><CODE>depth</CODE> - the depth of meta search.
691
796
<PRE>
692
797
public double <B>size</B>()</PRE>
693
798
<DL>
694
 
<DD>Get the size of the datbase of a node.
 
799
<DD>Get the size of the datbase.
695
800
<P>
696
801
<DD><DL>
697
802
 
698
 
<DT><B>Returns:</B><DD>the size of the datbase of the node.  On error, -1.0 is returned.</DL>
 
803
<DT><B>Returns:</B><DD>the size of the datbase.  On error, -1.0 is returned.</DL>
699
804
</DD>
700
805
</DL>
701
806
<HR>
714
819
</DL>
715
820
<HR>
716
821
 
 
822
<A NAME="sync()"><!-- --></A><H3>
 
823
sync</H3>
 
824
<PRE>
 
825
public boolean <B>sync</B>()</PRE>
 
826
<DL>
 
827
<DD>Synchronize updating contents of the database.
 
828
<P>
 
829
<DD><DL>
 
830
 
 
831
<DT><B>Returns:</B><DD>true if success, else it is false.</DL>
 
832
</DD>
 
833
</DL>
 
834
<HR>
 
835
 
717
836
<A NAME="uri_to_id(java.lang.String)"><!-- --></A><H3>
718
837
uri_to_id</H3>
719
838
<PRE>
728
847
</DL>
729
848
<HR>
730
849
 
 
850
<A NAME="users()"><!-- --></A><H3>
 
851
users</H3>
 
852
<PRE>
 
853
public java.util.List <B>users</B>()</PRE>
 
854
<DL>
 
855
<DD>Get a list of names of users.
 
856
<P>
 
857
<DD><DL>
 
858
 
 
859
<DT><B>Returns:</B><DD>a list object of names of users.  On error, `null' is returned.</DL>
 
860
</DD>
 
861
</DL>
 
862
<HR>
 
863
 
731
864
<A NAME="word_num()"><!-- --></A><H3>
732
865
word_num</H3>
733
866
<PRE>