Class: Ferret::Document

Inherits:
Hash
  • Object
show all
Includes:
BoostMixin
Defined in:
lib/ferret/document.rb

Overview

Documents are the unit of indexing and search.

A Document is a set of fields. Each field has a name and an array of textual values. If you are coming from a Lucene background you should note that Fields don’t have any properties except for the boost property. You should use the Ferret::Index::FieldInfos class to set field properties across the whole index instead.

Boost

The boost attribute makes a Document more important in the index. That is, you can increase the score of a match for queries that match a particular document, making it more likely to appear at the top of search results. You may, for example, want to boost products that have a higher user rating so that they are more likely to appear in search results.

Note: that fields which are not stored (see Ferret::Index::FieldInfos) are not available in documents retrieved from the index, e.g. Ferret::Search::Searcher#doc or Ferret::Index::IndexReader#doc.

Note: that modifying a Document retrieved from the index will not modify the document contained within the index. You need to delete the old version of the document and add the new version of the document.

Instance Attribute Summary

Attributes included from BoostMixin

#boost

Instance Method Summary collapse

Constructor Details

#initialize(boost = 1.0) ⇒ Document

Create a new Document object with a boost. The boost defaults to 1.0.



49
50
51
 
# File 'lib/ferret/document.rb', line 49

def initialize(boost = 1.0)
  @boost = boost
end

Instance Method Details

#eql?(o) ⇒ Boolean Also known as: ==

Return true if the documents are equal, ie they have the same fields

Returns:

  • (Boolean) 


54
55
56
57
 
# File 'lib/ferret/document.rb', line 54

def eql?(o)
  return (o.is_a? Document and (o.boost == @boost) and
          (self.keys == o.keys) and (self.values == o.values))
end

#to_s ⇒ Object

Create a string representation of the document



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/ferret/document.rb', line 61

def to_s
  buf = ["Document {"]
  self.keys.sort_by {|key| key.to_s}.each do |key|
    val = self[key]
    val_str = if val.instance_of? Array then %{["#{val.join('", "')}"]}
              elsif val.is_a? Field then val.to_s
              else %{"#{val.to_s}"}
              end
    buf << "  :#{key} => #{val_str}"
  end
  buf << ["}#{@boost == 1.0 ? "" : "^" + @boost.to_s}"]
  return buf.join("\n")
end