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

« back to all changes in this revision

Viewing changes to doc/javanativeapi/estraier/Condition.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:29 JST 2005 -->
 
5
<!-- Generated by javadoc (build 1.4.2_06) on Sat Nov 11 19:57:54 JST 2006 -->
6
6
<TITLE>
7
7
Condition (estraier)
8
8
</TITLE>
119
119
</TR>
120
120
<TR BGCOLOR="white" CLASS="TableRowColor">
121
121
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
122
<CODE>static&nbsp;double</CODE></FONT></TD>
 
123
<TD><CODE><B><A HREF="../estraier/Condition.html#ECLDIR">ECLDIR</A></B></CODE>
 
124
 
 
125
<BR>
 
126
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;eclipse tuning: on directory basis</TD>
 
127
</TR>
 
128
<TR BGCOLOR="white" CLASS="TableRowColor">
 
129
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
130
<CODE>static&nbsp;double</CODE></FONT></TD>
 
131
<TD><CODE><B><A HREF="../estraier/Condition.html#ECLFILE">ECLFILE</A></B></CODE>
 
132
 
 
133
<BR>
 
134
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;eclipse tuning: on file basis</TD>
 
135
</TR>
 
136
<TR BGCOLOR="white" CLASS="TableRowColor">
 
137
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
138
<CODE>static&nbsp;double</CODE></FONT></TD>
 
139
<TD><CODE><B><A HREF="../estraier/Condition.html#ECLSERV">ECLSERV</A></B></CODE>
 
140
 
 
141
<BR>
 
142
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;eclipse tuning: on server basis</TD>
 
143
</TR>
 
144
<TR BGCOLOR="white" CLASS="TableRowColor">
 
145
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
146
<CODE>static&nbsp;double</CODE></FONT></TD>
 
147
<TD><CODE><B><A HREF="../estraier/Condition.html#ECLSIMURL">ECLSIMURL</A></B></CODE>
 
148
 
 
149
<BR>
 
150
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;eclipse tuning: consider URL</TD>
 
151
</TR>
 
152
<TR BGCOLOR="white" CLASS="TableRowColor">
 
153
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
122
154
<CODE>static&nbsp;int</CODE></FONT></TD>
123
155
<TD><CODE><B><A HREF="../estraier/Condition.html#FAST">FAST</A></B></CODE>
124
156
 
128
160
<TR BGCOLOR="white" CLASS="TableRowColor">
129
161
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
130
162
<CODE>static&nbsp;int</CODE></FONT></TD>
 
163
<TD><CODE><B><A HREF="../estraier/Condition.html#ISECT">ISECT</A></B></CODE>
 
164
 
 
165
<BR>
 
166
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;option: with the intersection phrase</TD>
 
167
</TR>
 
168
<TR BGCOLOR="white" CLASS="TableRowColor">
 
169
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
170
<CODE>static&nbsp;int</CODE></FONT></TD>
131
171
<TD><CODE><B><A HREF="../estraier/Condition.html#NOIDF">NOIDF</A></B></CODE>
132
172
 
133
173
<BR>
136
176
<TR BGCOLOR="white" CLASS="TableRowColor">
137
177
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138
178
<CODE>static&nbsp;int</CODE></FONT></TD>
 
179
<TD><CODE><B><A HREF="../estraier/Condition.html#ROUGH">ROUGH</A></B></CODE>
 
180
 
 
181
<BR>
 
182
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;option: with the rough phrase</TD>
 
183
</TR>
 
184
<TR BGCOLOR="white" CLASS="TableRowColor">
 
185
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
186
<CODE>static&nbsp;int</CODE></FONT></TD>
139
187
<TD><CODE><B><A HREF="../estraier/Condition.html#SIMPLE">SIMPLE</A></B></CODE>
140
188
 
141
189
<BR>
152
200
<TR BGCOLOR="white" CLASS="TableRowColor">
153
201
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154
202
<CODE>static&nbsp;int</CODE></FONT></TD>
 
203
<TD><CODE><B><A HREF="../estraier/Condition.html#UNION">UNION</A></B></CODE>
 
204
 
 
205
<BR>
 
206
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;option: with the union phrase</TD>
 
207
</TR>
 
208
<TR BGCOLOR="white" CLASS="TableRowColor">
 
209
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
210
<CODE>static&nbsp;int</CODE></FONT></TD>
155
211
<TD><CODE><B><A HREF="../estraier/Condition.html#USUAL">USUAL</A></B></CODE>
156
212
 
157
213
<BR>
202
258
<TR BGCOLOR="white" CLASS="TableRowColor">
203
259
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204
260
<CODE>&nbsp;void</CODE></FONT></TD>
 
261
<TD><CODE><B><A HREF="../estraier/Condition.html#set_auxiliary(int)">set_auxiliary</A></B>(int&nbsp;min)</CODE>
 
262
 
 
263
<BR>
 
264
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set permission to adopt result of the auxiliary index.</TD>
 
265
</TR>
 
266
<TR BGCOLOR="white" CLASS="TableRowColor">
 
267
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
268
<CODE>&nbsp;void</CODE></FONT></TD>
 
269
<TD><CODE><B><A HREF="../estraier/Condition.html#set_distinct(java.lang.String)">set_distinct</A></B>(java.lang.String&nbsp;name)</CODE>
 
270
 
 
271
<BR>
 
272
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the attribute distinction filter.</TD>
 
273
</TR>
 
274
<TR BGCOLOR="white" CLASS="TableRowColor">
 
275
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
276
<CODE>&nbsp;void</CODE></FONT></TD>
 
277
<TD><CODE><B><A HREF="../estraier/Condition.html#set_eclipse(double)">set_eclipse</A></B>(double&nbsp;limit)</CODE>
 
278
 
 
279
<BR>
 
280
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the lower limit of similarity eclipse.</TD>
 
281
</TR>
 
282
<TR BGCOLOR="white" CLASS="TableRowColor">
 
283
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
284
<CODE>&nbsp;void</CODE></FONT></TD>
 
285
<TD><CODE><B><A HREF="../estraier/Condition.html#set_mask(int)">set_mask</A></B>(int&nbsp;mask)</CODE>
 
286
 
 
287
<BR>
 
288
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the mask of targets of meta search.</TD>
 
289
</TR>
 
290
<TR BGCOLOR="white" CLASS="TableRowColor">
 
291
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
292
<CODE>&nbsp;void</CODE></FONT></TD>
205
293
<TD><CODE><B><A HREF="../estraier/Condition.html#set_max(int)">set_max</A></B>(int&nbsp;max)</CODE>
206
294
 
207
295
<BR>
231
319
<BR>
232
320
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the search phrase.</TD>
233
321
</TR>
 
322
<TR BGCOLOR="white" CLASS="TableRowColor">
 
323
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
324
<CODE>&nbsp;void</CODE></FONT></TD>
 
325
<TD><CODE><B><A HREF="../estraier/Condition.html#set_skip(int)">set_skip</A></B>(int&nbsp;skip)</CODE>
 
326
 
 
327
<BR>
 
328
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the number of skipped documents.</TD>
 
329
</TR>
234
330
</TABLE>
235
331
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
236
332
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
266
362
</DL>
267
363
<HR>
268
364
 
 
365
<A NAME="ECLDIR"><!-- --></A><H3>
 
366
ECLDIR</H3>
 
367
<PRE>
 
368
public static final double <B>ECLDIR</B></PRE>
 
369
<DL>
 
370
<DD>eclipse tuning: on directory basis
 
371
<P>
 
372
<DL>
 
373
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#estraier.Condition.ECLDIR">Constant Field Values</A></DL>
 
374
</DL>
 
375
<HR>
 
376
 
 
377
<A NAME="ECLFILE"><!-- --></A><H3>
 
378
ECLFILE</H3>
 
379
<PRE>
 
380
public static final double <B>ECLFILE</B></PRE>
 
381
<DL>
 
382
<DD>eclipse tuning: on file basis
 
383
<P>
 
384
<DL>
 
385
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#estraier.Condition.ECLFILE">Constant Field Values</A></DL>
 
386
</DL>
 
387
<HR>
 
388
 
 
389
<A NAME="ECLSERV"><!-- --></A><H3>
 
390
ECLSERV</H3>
 
391
<PRE>
 
392
public static final double <B>ECLSERV</B></PRE>
 
393
<DL>
 
394
<DD>eclipse tuning: on server basis
 
395
<P>
 
396
<DL>
 
397
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#estraier.Condition.ECLSERV">Constant Field Values</A></DL>
 
398
</DL>
 
399
<HR>
 
400
 
 
401
<A NAME="ECLSIMURL"><!-- --></A><H3>
 
402
ECLSIMURL</H3>
 
403
<PRE>
 
404
public static final double <B>ECLSIMURL</B></PRE>
 
405
<DL>
 
406
<DD>eclipse tuning: consider URL
 
407
<P>
 
408
<DL>
 
409
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#estraier.Condition.ECLSIMURL">Constant Field Values</A></DL>
 
410
</DL>
 
411
<HR>
 
412
 
269
413
<A NAME="FAST"><!-- --></A><H3>
270
414
FAST</H3>
271
415
<PRE>
278
422
</DL>
279
423
<HR>
280
424
 
 
425
<A NAME="ISECT"><!-- --></A><H3>
 
426
ISECT</H3>
 
427
<PRE>
 
428
public static final int <B>ISECT</B></PRE>
 
429
<DL>
 
430
<DD>option: with the intersection phrase
 
431
<P>
 
432
<DL>
 
433
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#estraier.Condition.ISECT">Constant Field Values</A></DL>
 
434
</DL>
 
435
<HR>
 
436
 
281
437
<A NAME="NOIDF"><!-- --></A><H3>
282
438
NOIDF</H3>
283
439
<PRE>
290
446
</DL>
291
447
<HR>
292
448
 
 
449
<A NAME="ROUGH"><!-- --></A><H3>
 
450
ROUGH</H3>
 
451
<PRE>
 
452
public static final int <B>ROUGH</B></PRE>
 
453
<DL>
 
454
<DD>option: with the rough phrase
 
455
<P>
 
456
<DL>
 
457
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#estraier.Condition.ROUGH">Constant Field Values</A></DL>
 
458
</DL>
 
459
<HR>
 
460
 
293
461
<A NAME="SIMPLE"><!-- --></A><H3>
294
462
SIMPLE</H3>
295
463
<PRE>
314
482
</DL>
315
483
<HR>
316
484
 
 
485
<A NAME="UNION"><!-- --></A><H3>
 
486
UNION</H3>
 
487
<PRE>
 
488
public static final int <B>UNION</B></PRE>
 
489
<DL>
 
490
<DD>option: with the union phrase
 
491
<P>
 
492
<DL>
 
493
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#estraier.Condition.UNION">Constant Field Values</A></DL>
 
494
</DL>
 
495
<HR>
 
496
 
317
497
<A NAME="USUAL"><!-- --></A><H3>
318
498
USUAL</H3>
319
499
<PRE>
380
560
</DL>
381
561
<HR>
382
562
 
 
563
<A NAME="set_auxiliary(int)"><!-- --></A><H3>
 
564
set_auxiliary</H3>
 
565
<PRE>
 
566
public void <B>set_auxiliary</B>(int&nbsp;min)</PRE>
 
567
<DL>
 
568
<DD>Set permission to adopt result of the auxiliary index.
 
569
<P>
 
570
<DD><DL>
 
571
<DT><B>Parameters:</B><DD><CODE>min</CODE> - the minimum hits to adopt result of the auxiliary index.  If it is not more
 
572
 than 0, the auxiliary index is not used.  By default, it is 32.</DL>
 
573
</DD>
 
574
</DL>
 
575
<HR>
 
576
 
 
577
<A NAME="set_distinct(java.lang.String)"><!-- --></A><H3>
 
578
set_distinct</H3>
 
579
<PRE>
 
580
public void <B>set_distinct</B>(java.lang.String&nbsp;name)</PRE>
 
581
<DL>
 
582
<DD>Set the attribute distinction filter.
 
583
<P>
 
584
<DD><DL>
 
585
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of an attribute to be distinct.</DL>
 
586
</DD>
 
587
</DL>
 
588
<HR>
 
589
 
 
590
<A NAME="set_eclipse(double)"><!-- --></A><H3>
 
591
set_eclipse</H3>
 
592
<PRE>
 
593
public void <B>set_eclipse</B>(double&nbsp;limit)</PRE>
 
594
<DL>
 
595
<DD>Set the lower limit of similarity eclipse.
 
596
<P>
 
597
<DD><DL>
 
598
<DT><B>Parameters:</B><DD><CODE>limit</CODE> - the lower limit of similarity for documents to be eclipsed.  Similarity is
 
599
 between 0.0 and 1.0.  If the limit is added by `Condition.ECLSIMURL', similarity is
 
600
 weighted by URL.  If the limit is `Condition.ECLSERV', similarity is ignored and documents
 
601
 in the same server are eclipsed.  If the limit is `Condition.ECLDIR', similarity is ignored
 
602
 and documents in the same directory are eclipsed.  If the limit is `Condition.ECLFILE',
 
603
 similarity is ignored and documents of the same file are eclipsed.</DL>
 
604
</DD>
 
605
</DL>
 
606
<HR>
 
607
 
 
608
<A NAME="set_mask(int)"><!-- --></A><H3>
 
609
set_mask</H3>
 
610
<PRE>
 
611
public void <B>set_mask</B>(int&nbsp;mask)</PRE>
 
612
<DL>
 
613
<DD>Set the mask of targets of meta search.
 
614
<P>
 
615
<DD><DL>
 
616
<DT><B>Parameters:</B><DD><CODE>mask</CODE> - a masking number.  1 means the first target, 2 means the second target, 4 means
 
617
 the third target and, power values of 2 and their summation compose the mask.</DL>
 
618
</DD>
 
619
</DL>
 
620
<HR>
 
621
 
383
622
<A NAME="set_max(int)"><!-- --></A><H3>
384
623
set_max</H3>
385
624
<PRE>
406
645
 `Condition.USUAL', which is the default, specifies that it checks N-gram keys with skipping
407
646
 one key, `Condition.FAST' skips two keys, `Condition.AGITO' skips three keys,
408
647
 `Condition.NOIDF' specifies not to perform TF-IDF tuning, `Condition.SIMPLE' specifies to
409
 
 use simplified phrase.  Each option can be specified at the same time by bitwise or.  If
410
 
 keys are skipped, though search speed is improved, the relevance ratio grows less.</DL>
 
648
 use simplified phrase, `Condition.ROUGH' specifies to use rough phrase, `Condition.UNION'
 
649
 specifies to use union phrase, `Condition.ISECT' specifies to use intersection phrase.  Each
 
650
 option can be specified at the same time by bitwise or.  If keys are skipped, though search
 
651
 speed is improved, the relevance ratio grows less.</DL>
411
652
</DD>
412
653
</DL>
413
654
<HR>
436
677
<DT><B>Parameters:</B><DD><CODE>phrase</CODE> - a search phrase.</DL>
437
678
</DD>
438
679
</DL>
 
680
<HR>
 
681
 
 
682
<A NAME="set_skip(int)"><!-- --></A><H3>
 
683
set_skip</H3>
 
684
<PRE>
 
685
public void <B>set_skip</B>(int&nbsp;skip)</PRE>
 
686
<DL>
 
687
<DD>Set the number of skipped documents.
 
688
<P>
 
689
<DD><DL>
 
690
<DT><B>Parameters:</B><DD><CODE>skip</CODE> - the number of documents to be skipped in the search result.</DL>
 
691
</DD>
 
692
</DL>
439
693
<!-- ========= END OF CLASS DATA ========= -->
440
694
<HR>
441
695