Class: Algolia::Composition::HighlightResultOption

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/composition/highlight_result_option.rb

Overview

Surround words that match the query with HTML tags for highlighting.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HighlightResultOption

Initializes the object



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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 60

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise(
      ArgumentError,
      "The input argument (attributes) must be a hash in `Algolia::HighlightResultOption` 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::HighlightResultOption`. 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?(:value)
    self.value = attributes[:value]
  else
    self.value = nil
  end

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

  if attributes.key?(:matched_words)
    if (value = attributes[:matched_words]).is_a?(Array)
      self.matched_words = value
    end
  else
    self.matched_words = nil
  end

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

Instance Attribute Details

#fully_highlighted ⇒ Object

Whether the entire attribute value is highlighted.



21
22
23
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 21

def fully_highlighted
  @fully_highlighted
end

#match_level ⇒ Object

Returns the value of attribute match_level.



15
16
17
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 15

def match_level
  @match_level
end

#matched_words ⇒ Object

List of matched words from the search query.



18
19
20
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 18

def matched_words
  @matched_words
end

#value ⇒ Object

Highlighted attribute value, including HTML tags.



13
14
15
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 13

def value
  @value
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 159

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::Composition.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

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 24

def self.attribute_map
  {
    :value => :value,
    :match_level => :matchLevel,
    :matched_words => :matchedWords,
    :fully_highlighted => :fullyHighlighted
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 132

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

.discriminator_attributes ⇒ Object

Returns the keys that uniquely identify this oneOf variant when present



34
35
36
37
38
39
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 34

def self.discriminator_attributes
  [
    :matchLevel,
    :matchedWords
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



52
53
54
55
56
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 52

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

.types_mapping ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 42

def self.types_mapping
  {
    :value => :"String",
    :match_level => :"MatchLevel",
    :matched_words => :"Array<String>",
    :fully_highlighted => :"Boolean"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



108
109
110
111
112
113
114
115
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 108

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    value == other.value &&
    match_level == other.match_level &&
    matched_words == other.matched_words &&
    fully_highlighted == other.fully_highlighted
end

#_to_hash(value) ⇒ Hash

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



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 238

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

See Also:

  • `==` method


119
120
121
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



125
126
127
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 125

def hash
  [value, match_level, matched_words, fully_highlighted].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



209
210
211
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 209

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 219

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 



213
214
215
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 213

def to_json(*_args)
  to_hash.to_json
end

#to_s ⇒ String

Returns the string representation of the object



203
204
205
 
# File 'lib/algolia/models/composition/highlight_result_option.rb', line 203

def to_s
  to_hash.to_s
end