Sha256: d8172bec23e7d0552b03404e856e2c04b45a860c57e5b9c2c0336fa2d90dc3fa
Contents?: true
Size: 1.53 KB
Versions: 11
Compression:
Stored size: 1.53 KB
Contents
module Sunspot
module Query
#
# This class acts as a base class for query components that encapsulate
# operations on fields. It is subclassed by the Query::Query class and the
# Query::DynamicQuery class.
#
class FieldQuery < Scope
#
# Add a field facet. See Sunspot::Facet for more information.
#
# ==== Parameters
#
# field_name<Symbol>:: Name of the field on which to get a facet
#
# ==== Returns
#
# FieldFacet:: The field facet object
#
def add_field_facet(field_name, options = nil)
add_component(FieldFacet.build(build_field(field_name), options || {}))
end
#
# Add a query facet.
#
# ==== Parameters
#
# name<Symbol>::
# The name associated with the query facet. This is not passed to Solr,
# but allows the user to retrieve the facet result by passing the name
# to the Search#facet method.
#
# ==== Returns
#
# QueryFacet:: The query facet object
#
def add_query_facet(name)
add_component(facet = QueryFacet.new(name, setup))
query_facets[name.to_sym] = facet
facet
end
#
# Set result ordering.
#
# ==== Parameters
#
# field_name<Symbol>:: Name of the field on which to order
# direction<Symbol>:: :asc or :desc (default :asc)
#
def order_by(field_name, direction = nil)
add_sort(Sort.new(build_field(field_name), direction))
end
end
end
end
Version data entries
11 entries across 11 versions & 4 rubygems