Class EstraierPure::Condition
In: estraierpure.rb
Parent: Object

Abstraction of search condition.

Methods

add_attr   attrs   max   new   options   order   phrase   set_max   set_options   set_order   set_phrase   set_skip   skip  

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’.

Get expressions for attributes. The return value is expressions for attributes.

Get the maximum number of retrieval. The return value is the maximum number of retrieval.

Get options of retrieval. The return value is options by bitwise or.

Get the order expression. The return value is the order expression.

Get the search phrase. The return value is the search phrase.

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’.

Get the number of skipped documents. The return value is the number of documents to be skipped in the search result.

[Validate]