Module: Ferret::FieldSymbolMethods

Included in:
FieldSymbol, Symbol
Defined in:
lib/ferret/field_symbol.rb

Overview

The FieldSymbolMethods module contains the methods that are added to both the Symbol class and the FieldSymbol class. These methods allow you to set the type easily set the type of a field by calling a method on a symbol.

Right now this is only useful for Sorting and grouping, but some day Ferret may have typed fields, in which case these this methods will come in handy.

The available types are specified in Ferret::FIELD_TYPES.

Examples

index.search(query, :sort => :title.string.desc)

index.search(query, :sort => [:price.float, :count.integer.desc])

index.search(query, :group_by => :catalogue.string)

Note

If you set the field type multiple times, the last type specified will be the type used. For example;

puts :title.integer.float.byte.string.type.inspect # => :string

Calling #desc twice will set desc? to false

puts :title.desc?           # => false
puts :title.desc.desc?      # => true
puts :title.desc.desc.desc? # => false

Instance Method Summary collapse

Instance Method Details

#desc ⇒ Object

Set a field to be a descending field. This only makes sense in sort specifications.



58
59
60
61
62
 
# File 'lib/ferret/field_symbol.rb', line 58

def desc
  fsym = FieldSymbol.new(self, respond_to?(:desc?) ? !desc? : true)
  fsym.type = type if respond_to? :type
  fsym
end

#desc? ⇒ Boolean

Return whether or not this field should be a descending field

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/ferret/field_symbol.rb', line 65

def desc?
  @desc == true
end

#type ⇒ Object

Return the type of this field



70
71
72
 
# File 'lib/ferret/field_symbol.rb', line 70

def type
  @type || nil
end