Class: Ferret::Search::FieldDoc

Inherits:
ScoreDoc
  • Object
show all
Defined in:
lib/ferret/search/field_doc.rb

Overview

Expert: A ScoreDoc which also contains information about how to sort the referenced document. In addition to the document number and score, this object contains an array of values for the document from the field(s) used to sort. For example, if the sort criteria was to sort by fields “a”, “b” then “c”, the fields object array will have three elements, corresponding respectively to the term values for the document in fields “a”, “b” and “c”. The class of each element in the array will be either Integer, Float or String depending on the type of values in the terms of each field.

Instance Attribute Summary collapse

Attributes inherited from ScoreDoc

#doc, #score

Instance Method Summary collapse

Methods inherited from ScoreDoc

#<=>, #hash, #to_s

Constructor Details

#initialize(doc, score, fields = nil) ⇒ FieldDoc

Expert: Creates one of these objects with the given sort information.



25
26
27
28
 
# File 'lib/ferret/search/field_doc.rb', line 25

def initialize(doc, score, fields = nil)
  super(doc, score)
  @fields = fields
end

Instance Attribute Details

#fields ⇒ Object

Expert: The values which are used to sort the referenced document. The order of these will match the original sort criteria given by a Sort object. Each Object will be either an Integer, Float or String, depending on the type of values in the terms of the original field. See Sort See Searcher#search(Query,Filter,int,Sort)



22
23
24
 
# File 'lib/ferret/search/field_doc.rb', line 22

def fields
  @fields
end