Class: Sunspot::Query::Scope

Inherits:
Object
  • Object
show all
Defined in:
lib/sunspot/query/scope.rb

Overview

The Scope class encapsulates a set of restrictions that scope search results (as well as query facets rows). This class’s API is exposed by Query::Query and Query::QueryFacetRow.

Direct Known Subclasses

Connective::Abstract, FieldQuery

Instance Method Summary collapse

Instance Method Details

#add_conjunction ⇒ Object

Add a conjunction to the scope. In most cases, this will simply return the Scope object itself, since scopes by default combine their restrictions with OR semantics. The Connective::Disjunction class overrides this method to return a Connective::Conjunction.

Returns

Scope

Self or another scope with conjunctive semantics.



77
78
79
 
# File 'lib/sunspot/query/scope.rb', line 77

def add_conjunction
  self
end

#add_disjunction ⇒ Object

Add a disjunction to the scope. The disjunction can then take a set of restrictions, which are combined with OR semantics.

Returns

Connective::Disjunction

New disjunction



62
63
64
65
 
# File 'lib/sunspot/query/scope.rb', line 62

def add_disjunction
  add_component(disjunction = Connective::Disjunction.new(setup))
  disjunction
end

#add_negated_restriction(field_name, restriction_type, value) ⇒ Object

Add a negated restriction to the query. The restriction will be taken as the opposite of its usual meaning (e.g., an :equal_to restriction will be “not equal to”.

Parameters

field_name<Symbol>

Name of the field to which the restriction applies

restriction_type<Class>

Subclass of Sunspot::Query::Restriction::Base to instantiate

value<Object>

Value against which the restriction applies (e.g. less_than(2) has a value of 2)



50
51
52
 
# File 'lib/sunspot/query/scope.rb', line 50

def add_negated_restriction(field_name, restriction_type, value)
  add_restriction(field_name, restriction_type, value, true)
end

#add_negated_shorthand_restriction(field_name, value) ⇒ Object

Add a negated shorthand restriction. See #add_shorthand_restriction



142
143
144
 
# File 'lib/sunspot/query/scope.rb', line 142

def add_negated_shorthand_restriction(field_name, value)
  add_shorthand_restriction(field_name, value, true)
end

#add_restriction(field_name, restriction_type, value, negated = false) ⇒ Object

Add a restriction to the query.

Parameters

field_name<Symbol>

Name of the field to which the restriction applies

restriction_type<Class,Symbol>

Subclass of Sunspot::Query::Restriction::Base, or snake_cased name as symbol (e.g., :equal_to)

value<Object>

Value against which the restriction applies (e.g. less_than(2) has a value of 2)

negated

Whether this restriction should be negated (use add_negated_restriction)



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/sunspot/query/scope.rb', line 24

def add_restriction(field_name, restriction_type, value, negated = false)
  if restriction_type.is_a?(Symbol)
    restriction_type = Restriction[restriction_type]
  end
  add_component(
    restriction = restriction_type.new(
      build_field(field_name), value, negated
    )
  )
  restriction
end

#add_shorthand_restriction(field_name, value, negated = false) ⇒ Object

Determine which restriction type to add based on the type of the value. Used to interpret query conditions passed as a hash, as well as the short-form DSL::Scope#with method.

Parameters

field_name<Symbol>

Name of the field on which to apply the restriction

value<Object,Array,Range>

Value to which to apply to the restriction

–

negated<Boolean>

Whether to negate the restriction.



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/sunspot/query/scope.rb', line 126

def add_shorthand_restriction(field_name, value, negated = false) #:nodoc:
  restriction_type =
    case value
    when Range
      Restriction::Between
    when Array
      Restriction::AnyOf
    else
      Restriction::EqualTo
    end
  add_restriction(field_name, restriction_type, value, negated)
end

#dynamic_query(base_name) ⇒ Object

Generate a DynamicQuery instance for the given base name. This gives you access to a subset of the Query API but the operations apply to dynamic fields inside the dynamic field definition specified by base_name.

Parameters

base_name<Symbol>

Base name of the dynamic field definition to use in the dynamic query operations

Returns

DynamicQuery

Instance providing dynamic query functionality for the given field definitions.



110
111
112
 
# File 'lib/sunspot/query/scope.rb', line 110

def dynamic_query(base_name)
  DynamicQuery.new(setup.dynamic_field_factory(base_name), self)
end

#exclude_instance(instance) ⇒ Object

Exclude a particular instance from the search results

Parameters

instance<Object>

instance to exclude from results



88
89
90
 
# File 'lib/sunspot/query/scope.rb', line 88

def exclude_instance(instance)
  add_component(Restriction::SameAs.new(instance, true))
end