Class: Estraier::Result

Inherits:
Object
  • Object
show all
Defined in:
lib/estraier/estraier-doc.rb

Overview

++ Abstraction of result set from database.

Instance Method Summary collapse

Instance Method Details

#doc_num ⇒ Object

Get the number of documents. The return value is the number of documents in the result.



259
260
261
 
# File 'lib/estraier/estraier-doc.rb', line 259

def doc_num()
  # native code ...
end

#get_dbidx(index) ⇒ Object

Get the index of the container database of a document. ‘index’ specifies the index of a document. The return value is the index of the container database of the document or -1 if the index is out of bounds.



272
273
274
 
# File 'lib/estraier/estraier-doc.rb', line 272

def get_dbidx(index)
  # native code ...
end

#get_doc_id(index) ⇒ Object

Get the ID number of a document. ‘index’ specifies the index of a document. The return value is the ID number of the document or -1 if the index is out of bounds.



265
266
267
 
# File 'lib/estraier/estraier-doc.rb', line 265

def get_doc_id(index)
  # native code ...
end

#get_score(index) ⇒ Object

Get the score of a document. ‘index’ specifies the index of a document. The return value is the score of the document or -1 if the index is out of bounds.



290
291
292
 
# File 'lib/estraier/estraier-doc.rb', line 290

def get_score(index)
  # native code ...
end

#get_shadows(id) ⇒ Object

Get an array of ID numbers of eclipsed docuemnts of a document. ‘id’ specifies the ID number of a parent document. The return value is an array whose elements expresse the ID numbers and their scores alternately.



297
298
299
 
# File 'lib/estraier/estraier-doc.rb', line 297

def get_shadows(id)
  # native code ...
end

#hint(word) ⇒ Object

Get the value of a hint word. ‘word’ specifies a hint word. An empty string means the number of whole result. The return value is the number of documents corresponding the hint word. If the word is in a negative condition, the value is negative.



284
285
286
 
# File 'lib/estraier/estraier-doc.rb', line 284

def hint(word)
  # native code ...
end

#hint_words ⇒ Object

Get an array of hint words. The return value is an array of hint words.



277
278
279
 
# File 'lib/estraier/estraier-doc.rb', line 277

def hint_words()
  # native code ...
end