Class: Sunspot::AttributeField

Inherits:
Field
  • Object
show all
Defined in:
lib/sunspot/field.rb

Overview

AttributeField instances encapsulate non-tokenized attribute data. AttributeFields can have any type except TextType, and can also have a reference (for instantiated facets), optionally allow multiple values (false by default), and can store their values (false by default). All scoping, sorting, and faceting is done with attribute fields.

Instance Attribute Summary

Attributes inherited from Field

#attributes, #name, #reference, #type

Instance Method Summary collapse

Methods inherited from Field

#cast, #eql?, #hash, #multiple?, #to_indexed

Constructor Details

#initialize(name, type, options = {}) ⇒ AttributeField

:nodoc:

Raises:

  • (ArgumentError) 


125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/sunspot/field.rb', line 125

def initialize(name, type, options = {})
  super(name, type, options)
  @multiple = !!options.delete(:multiple)
  @reference =
    if (reference = options.delete(:references)).respond_to?(:name)
      reference.name
    elsif reference.respond_to?(:to_sym)
      reference.to_sym
    end
  raise ArgumentError, "Unknown field option #{options.keys.first.inspect} provided for field #{name.inspect}" unless options.empty?
end

Instance Method Details

#indexed_name ⇒ Object

The name of the field as it is indexed in Solr. The indexed name contains a suffix that contains information about the type as well as whether the field allows multiple values for a document.

Returns

String

The field’s indexed name



145
146
147
 
# File 'lib/sunspot/field.rb', line 145

def indexed_name
  "#{super}#{'m' if @multiple}#{'s' if @stored}"
end