Class: Sunspot::Field

Inherits:

Object

• Object
• Sunspot::Field

show all

Defined in:

sunspot/lib/sunspot/field.rb

Overview

Instance Attribute Summary (collapse)

• - (Object) boost readonly

  Returns the value of attribute boost.

• - (Object) indexed_name readonly

  Name with which this field is indexed internally.

• - (Object) name

  Returns the value of attribute name.

• - (Object) reference

  Model class that the value of this field refers to.

• - (Object) type

  The public-facing name of the field The Type of the field.

Instance Method Summary (collapse)

• - (Object) cast(value)

  Cast the value into the appropriate Ruby class for the field’s type.

• - (Boolean) eql?(field) (also: #==)
• - (Object) hash
• - (Field) initialize(name, type, options = {}) constructor

  A new instance of Field.

• - (Boolean) more_like_this?

  Whether this field can be used for more_like_this queries.

• - (Boolean) multiple?

  Whether this field accepts multiple values.

• - (Object) to_indexed(value)

  Convert a value to its representation for Solr indexing.

11
12
13
14
15
16
17

# File 'sunspot/lib/sunspot/field.rb', line 11

def initialize(name, type, options = {}) #:nodoc
  @name, @type = name.to_sym, type
  @stored = !!options.delete(:stored)
  @more_like_this = !!options.delete(:more_like_this)
  set_indexed_name(options)
  raise ArgumentError, "Field of type #{type} cannot be used for more_like_this" unless type.accepts_more_like_this? or !@more_like_this
end

6
7
8

# File 'sunspot/lib/sunspot/field.rb', line 6

def boost
  @boost
end

7
8
9

# File 'sunspot/lib/sunspot/field.rb', line 7

def indexed_name
  @indexed_name
end

3
4
5

# File 'sunspot/lib/sunspot/field.rb', line 3

def name
  @name
end

5
6
7

# File 'sunspot/lib/sunspot/field.rb', line 5

def reference
  @reference
end

4
5
6

# File 'sunspot/lib/sunspot/field.rb', line 4

def type
  @type
end

57
58
59

# File 'sunspot/lib/sunspot/field.rb', line 57

def cast(value)
  @type.cast(value)
end

88
89
90

# File 'sunspot/lib/sunspot/field.rb', line 88

def eql?(field)
  indexed_name == field.indexed_name
end

84
85
86

# File 'sunspot/lib/sunspot/field.rb', line 84

def hash
  indexed_name.hash
end

80
81
82

# File 'sunspot/lib/sunspot/field.rb', line 80

def more_like_this?
  !!@more_like_this
end

68
69
70

# File 'sunspot/lib/sunspot/field.rb', line 68

def multiple?
  !!@multiple
end

35
36
37
38
39
40
41
42
43
44
45

# File 'sunspot/lib/sunspot/field.rb', line 35

def to_indexed(value)
  if value.is_a? Array
    if @multiple
      value.map { |val| to_indexed(val) }
    else
      raise ArgumentError, "#{name} is not a multiple-value field, so it cannot index values #{value.inspect}"
    end
  else
    @type.to_indexed(value)
  end
end