Class: Sunspot::Facet

Inherits:

Object

• Object
• Sunspot::Facet

Defined in:

lib/sunspot/facet.rb

Direct Known Subclasses

InstantiatedFacet

Instance Method Summary

• #initialize(facet_data) ⇒ Facet constructor

  :nodoc:.

• #name ⇒ Object (also: #field_name)

  For field facets, this is the field name.

• #rows ⇒ Object

  Collection of FacetRow objects containing the individual values returned by the facet.

Constructor Details

#initialize(facet_data) ⇒ Facet

:nodoc:

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

def initialize(facet_data) #:nodoc:
  @facet_data = facet_data
end

Instance Method Details

#name ⇒ Object Also known as: field_name

For field facets, this is the field name. For query facets, this is the name given to the #facet method in the DSL.

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

def name
  @facet_data.name
end

#rows ⇒ Object

Collection of FacetRow objects containing the individual values returned by the facet.

# File 'lib/sunspot/facet.rb', line 20

def rows
  @facet_data.rows { |value, count| FacetRow.new(value, count) }
end