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.
index.search(query, :sort => :title.string.desc) index.search(query, :sort => [:price.float, :count.integer.desc]) index.search(query, :group_by => :catalogue.string)
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
Set a field to be a descending field. This only makes sense in sort specifications.
# 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
Return whether or not this field should be a descending field
# File lib/ferret/field_symbol.rb, line 65 def desc? @desc == true end
Return the type of this field
# File lib/ferret/field_symbol.rb, line 70 def type @type || nil end