Class: Algolia::Search::AutomaticFacetFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/search/automatic_facet_filter.rb

Overview

Filter or optional filter to be applied to the search.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AutomaticFacetFilter

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 51

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise(
      ArgumentError,
      "The input argument (attributes) must be a hash in `Algolia::AutomaticFacetFilter` initialize method"
    )
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      raise(
        ArgumentError,
        "`#{k}` is not a valid attribute in `Algolia::AutomaticFacetFilter`. Please check the name to make sure it's valid. List of attributes: " +
          self.class.attribute_map.keys.inspect
      )
    end

    h[k.to_sym] = v
  }

  if attributes.key?(:facet)
    self.facet = attributes[:facet]
  else
    self.facet = nil
  end

  if attributes.key?(:score)
    self.score = attributes[:score]
  end

  if attributes.key?(:disjunctive)
    self.disjunctive = attributes[:disjunctive]
  end
end

Instance Attribute Details

#disjunctive ⇒ Object

Whether the filter is disjunctive or conjunctive. If true the filter has multiple matches, multiple occurences are combined with the logical ‘OR` operation. If false, multiple occurences are combined with the logical `AND` operation.



17
18
19
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 17

def disjunctive
  @disjunctive
end

#facet ⇒ Object

Facet name to be applied as filter. The name must match placeholders in the ‘pattern` parameter. For example, with `pattern: facet:genre`, `automaticFacetFilters` must be `genre`.



11
12
13
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 11

def facet
  @facet
end

#score ⇒ Object

Filter scores to give different weights to individual filters.



14
15
16
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 14

def score
  @score
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 139

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end

  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
    # model
  else
    # models (e.g. Pet) or oneOf
    klass = Algolia::Search.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
      .build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



29
30
31
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 29

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



20
21
22
23
24
25
26
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 20

def self.attribute_map
  {
    :facet => :facet,
    :score => :score,
    :disjunctive => :disjunctive
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 112

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  types_mapping.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v|
          _deserialize(::Regexp.last_match(1), v)
        }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
    end
  end

  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



43
44
45
46
47
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 43

def self.openapi_nullable
  Set.new(
    []
  )
end

.types_mapping ⇒ Object

Attribute type mapping.



34
35
36
37
38
39
40
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 34

def self.types_mapping
  {
    :facet => :"String",
    :score => :"Integer",
    :disjunctive => :"Boolean"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



89
90
91
92
93
94
95
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 89

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    facet == other.facet &&
    score == other.score &&
    disjunctive == other.disjunctive
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 218

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to?(:to_hash)
    value.to_hash
  else
    value
  end
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


99
100
101
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 99

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



105
106
107
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 105

def hash
  [facet, score, disjunctive].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



189
190
191
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 189

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 199

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end

  hash
end

#to_json(*_args) ⇒ Object 



193
194
195
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 193

def to_json(*_args)
  to_hash.to_json
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



183
184
185
 
# File 'lib/algolia/models/search/automatic_facet_filter.rb', line 183

def to_s
  to_hash.to_s
end