Class Estraier::Condition
In: estraier-doc.rb
Parent: Object

Abstraction of search condition.

Methods

Constants

SURE = 1 << 0   option: check N-gram keys skipping by three
USUAL = 1 << 1   option: check N-gram keys skipping by two
FAST = 1 << 2   option: without TF-IDF tuning
AGITO = 1 << 3   option: with the simplified phrase
NOIDF = 1 << 4   option: check every N-gram key
SIMPLE = 1 << 10   option: check N-gram keys skipping by one

Public Class methods

Create a search condition object.

Public Instance methods

Add an expression for an attribute. `expr’ specifies an expression for an attribute. The return value is always `nil’.

Set permission to adopt result of the auxiliary index. `min’ specifies 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 the lower limit of similarity eclipse. `limit’ specifies the lower limit of similarity for documents to be eclipsed. Similarity is between 0.0 and 1.0.

Set the maximum number of retrieval. `max’ specifies the maximum number of retrieval. By default, the number of retrieval is not limited. The return value is always `nil’.

Set options of retrieval. `options’ specifies options: `Condition::SURE’ specifies that it checks every N-gram key, `Condition::USU’, 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. 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. The return value is always `nil’.

Set the order of a condition object. `expr’ specifies an expression for the order. By default, the order is by score descending. The return value is always `nil’.

Set the search phrase. `phrase’ specifies a search phrase. The return value is always `nil’.

Set the number of skipped documents. `skip’ specifies the number of documents to be skipped in the search result. The return value is always `nil’.

[Validate]