Class: Sunspot::Query::Restriction::Base

Inherits:
Object
  • Object
show all
Includes:
RSolr::Char
Defined in:
lib/sunspot/query/restriction.rb

Overview

Subclasses of this class represent restrictions that can be applied to a Sunspot query. The Sunspot::DSL::Restriction class presents a builder API for instances of this class.

Implementations of this class must respond to #to_params and #to_negated_params. Instead of implementing those methods, they may choose to implement any of:

  • #to_positive_boolean_phrase, and optionally #to_negated_boolean_phrase

  • #to_solr_conditional

Direct Known Subclasses

AllOf, AnyOf, Between, EqualTo, GreaterThan, LessThan, SameAs

Instance Method Summary collapse

Constructor Details

#initialize(field, value, negated = false) ⇒ Base

Returns a new instance of Base.



38
39
40
 
# File 'lib/sunspot/query/restriction.rb', line 38

def initialize(field, value, negated = false)
  @field, @value, @negated = field, value, negated
end

Instance Method Details

#negate ⇒ Object 



107
108
109
 
# File 'lib/sunspot/query/restriction.rb', line 107

def negate
  self.class.new(@field, @value, !@negated)
end

#negated? ⇒ Boolean

Whether this restriction should be negated from its original meaning

Returns:

  • (Boolean) 


103
104
105
 
# File 'lib/sunspot/query/restriction.rb', line 103

def negated? #:nodoc:
  !!@negated
end

#to_boolean_phrase ⇒ Object

Return the boolean phrase associated with this restriction object. Differentiates between positive and negated boolean phrases depending on whether this restriction is negated.



62
63
64
65
66
67
68
 
# File 'lib/sunspot/query/restriction.rb', line 62

def to_boolean_phrase
  unless negated?
    to_positive_boolean_phrase
  else
    to_negated_boolean_phrase
  end
end

#to_negated_boolean_phrase ⇒ Object

Boolean phrase representing this restriction in the negated. Subclasses may choose to implement this method, but it is not necessary, as the base implementation delegates to #to_positive_boolean_phrase.

Returns

String

Boolean phrase for restriction in the negated



96
97
98
 
# File 'lib/sunspot/query/restriction.rb', line 96

def to_negated_boolean_phrase
  "-#{to_positive_boolean_phrase}"
end

#to_params ⇒ Object

A hash representing this restriction in solr-ruby’s parameter format. All restriction implementations must respond to this method; however, the base implementation delegates to the #to_positive_boolean_phrase method, so subclasses may (and probably should) choose to implement that method instead.

Returns

Hash

Representation of this restriction as solr-ruby parameters



53
54
55
 
# File 'lib/sunspot/query/restriction.rb', line 53

def to_params
  { :fq => [to_boolean_phrase] }
end

#to_positive_boolean_phrase ⇒ Object

Boolean phrase representing this restriction in the positive. Subclasses may choose to implement this method rather than #to_params; however, this method delegates to the abstract #to_solr_conditional method, which in most cases will be what subclasses will want to implement. #to_solr_conditional contains the boolean phrase representing the condition but leaves out the field name (see built-in implementations for examples)

Returns

String

Boolean phrase for restriction in the positive



83
84
85
 
# File 'lib/sunspot/query/restriction.rb', line 83

def to_positive_boolean_phrase
  "#{escape(@field.indexed_name)}:#{to_solr_conditional}"
end