Condition (estraier)
Keywords: estraier.Condition class

Overview | Package | Class | Tree | Index
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## estraier
Class Condition

    java.lang.Object
      estraier.Condition

public class Condition
extends java.lang.Object

Abstraction of search condition.

Field Summary
`static int` | `AGITO` option: check N-gram keys skipping by three
`static double` | `ECLDIR` eclipse tuning: on directory basis
`static double` | `ECLFILE` eclipse tuning: on file basis
`static double` | `ECLSERV` eclipse tuning: on server basis
`static double` | `ECLSIMURL` eclipse tuning: consider URL
`static int` | `FAST` option: check N-gram keys skipping by two
`static int` | `ISECT` option: with the intersection phrase
`static int` | `NOIDF` option: without TF-IDF tuning
`static int` | `ROUGH` option: with the rough phrase
`static int` | `SIMPLE` option: with the simplified phrase
`static int` | `SURE` option: check every N-gram key
`static int` | `UNION` option: with the union phrase
`static int` | `USUAL` option: check N-gram keys skipping by one

Constructor Summary
`Condition()` Create a search condition object.

Method Summary
`void` | `add_attr(java.lang.String expr)` Add an expression for an attribute.
`protected void` | `finalize()` Release resources.
`void` | `set_auxiliary(int min)` Set permission to adopt result of the auxiliary index.
`void` | `set_distinct(java.lang.String name)` Set the attribute distinction filter.
`void` | `set_eclipse(double limit)` Set the lower limit of similarity eclipse.
`void` | `set_mask(int mask)` Set the mask of targets of meta search.
`void` | `set_max(int max)` Set the maximum number of retrieval.
`void` | `set_options(int options)` Set options of retrieval.
`void` | `set_order(java.lang.String expr)` Set the order.
`void` | `set_phrase(java.lang.String phrase)` Set the search phrase.
`void` | `set_skip(int skip)` Set the number of skipped documents.

Methods inherited from class java.lang.Object
`clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### AGITO

    public static final int AGITO

  option: check N-gram keys skipping by three

  See Also:
    Constant Field Values

### ECLDIR

    public static final double ECLDIR

  eclipse tuning: on directory basis

  See Also:
    Constant Field Values

### ECLFILE

    public static final double ECLFILE

  eclipse tuning: on file basis

  See Also:
    Constant Field Values

### ECLSERV

    public static final double ECLSERV

  eclipse tuning: on server basis

  See Also:
    Constant Field Values

### ECLSIMURL

    public static final double ECLSIMURL

  eclipse tuning: consider URL

  See Also:
    Constant Field Values

### FAST

    public static final int FAST

  option: check N-gram keys skipping by two

  See Also:
    Constant Field Values

### ISECT

    public static final int ISECT

  option: with the intersection phrase

  See Also:
    Constant Field Values

### NOIDF

    public static final int NOIDF

  option: without TF-IDF tuning

  See Also:
    Constant Field Values

### ROUGH

    public static final int ROUGH

  option: with the rough phrase

  See Also:
    Constant Field Values

### SIMPLE

    public static final int SIMPLE

  option: with the simplified phrase

  See Also:
    Constant Field Values

### SURE

    public static final int SURE

  option: check every N-gram key

  See Also:
    Constant Field Values

### UNION

    public static final int UNION

  option: with the union phrase

  See Also:
    Constant Field Values

### USUAL

    public static final int USUAL

  option: check N-gram keys skipping by one

  See Also:
    Constant Field Values

Constructor Detail

### Condition

    public Condition()

  Create a search condition object.

Method Detail

### add_attr

    public void add_attr(java.lang.String expr)

  Add an expression for an attribute.

  Parameters:
    `expr` - an expression for an attribute.

### finalize

    protected void finalize()

  Release resources.

### set_auxiliary

    public void set_auxiliary(int min)

  Set permission to adopt result of the auxiliary index.

  Parameters:
    `min` - the minimum hits to adopt result of the auxiliary index. If it is not more than 0, the auxiliary index is not used. By default, it is 32.

### set_distinct

    public void set_distinct(java.lang.String name)

  Set the attribute distinction filter.

  Parameters:
    `name` - the name of an attribute to be distinct.

### set_eclipse

    public void set_eclipse(double limit)

  Set the lower limit of similarity eclipse.

  Parameters:
    `limit` - the lower limit of similarity for documents to be eclipsed. Similarity is between 0.0 and 1.0. If the limit is added by `Condition.ECLSIMURL', similarity is weighted by URL. If the limit is `Condition.ECLSERV', similarity is ignored and documents in the same server are eclipsed. If the limit is `Condition.ECLDIR', similarity is ignored and documents in the same directory are eclipsed. If the limit is `Condition.ECLFILE', similarity is ignored and documents of the same file are eclipsed.

### set_mask

    public void set_mask(int mask)

  Set the mask of targets of meta search.

  Parameters:
    `mask` - a masking number. 1 means the first target, 2 means the second target, 4 means the third target and, power values of 2 and their summation compose the mask.

### set_max

    public void set_max(int max)

  Set the maximum number of retrieval.

  Parameters:
    `max` - the maximum number of retrieval. By default, the number of retrieval is not limited.

### set_options

    public void set_options(int options)

  Set options of retrieval.

  Parameters:
    `options` - options: `Condition.SURE' specifies that it checks every N-gram key, `Condition.USUAL', which is the default, specifies that it checks N-gram keys with skipping one key, `Condition.FAST' skips two keys, `Condition.AGITO' skips three keys, `Condition.NOIDF' specifies not to perform TF-IDF tuning, `Condition.SIMPLE' specifies to use simplified phrase, `Condition.ROUGH' specifies to use rough phrase, `Condition.UNION' specifies to use union phrase, `Condition.ISECT' specifies to use intersection phrase. Each option can be specified at the same time by bitwise or. If keys are skipped, though search speed is improved, the relevance ratio grows less.

### set_order

    public void set_order(java.lang.String expr)

  Set the order.

  Parameters:
    `expr` - an expression for the order. By default, the order is by score descending.

### set_phrase

    public void set_phrase(java.lang.String phrase)

  Set the search phrase.

  Parameters:
    `phrase` - a search phrase.

### set_skip

    public void set_skip(int skip)

  Set the number of skipped documents.

  Parameters:
    `skip` - the number of documents to be skipped in the search result.

Overview | Package | Class | Tree | Index
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD