Class: AsposeEmailCloud::AiNameComponent

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose-email-cloud/models/ai_name_component.rb

Overview

Parsed name component

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value: nil, category: nil, score: nil, position: nil) ⇒ AiNameComponent

Initializes the object

Parameters:

  • value (String) (defaults to: nil) —

    Component value

  • category (String) (defaults to: nil) —

    Name component category. Enum, available values: Unknown, Mononym, Score, Format, FirstInitial, FirstName, MiddleInitial, MiddleName, MiddleNickname, MiddleSobriquet, MiddleMaidenName, MiddlePatronym, MiddleMatronym, LastInitial, LastName, LastNobiliaryParticle, LastNominalConjunction, LastPaternalSurname, LastMaternalSurname, PrefixTitle, PostfixGenerationalTitle, PostfixPostnominalLetters, ArabicIsm, ArabicKunya, ArabicNasab, ArabicSlaqab, ArabicNisbah

  • score (Float) (defaults to: nil) —

    Score from 0.0 to 1.0

  • position (Integer) (defaults to: nil) —

    Component position from 0



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 68

def initialize(
  value: nil,
  category: nil,
  score: nil,
  position: nil)
  self.value = value if value
  self.category = category if category
  self.score = score if score
  self.position = position if position
end

Instance Attribute Details

#category ⇒ String

Name component category. Enum, available values: Unknown, Mononym, Score, Format, FirstInitial, FirstName, MiddleInitial, MiddleName, MiddleNickname, MiddleSobriquet, MiddleMaidenName, MiddlePatronym, MiddleMatronym, LastInitial, LastName, LastNobiliaryParticle, LastNominalConjunction, LastPaternalSurname, LastMaternalSurname, PrefixTitle, PostfixGenerationalTitle, PostfixPostnominalLetters, ArabicIsm, ArabicKunya, ArabicNasab, ArabicSlaqab, ArabicNisbah

Returns:

  • (String) 


36
37
38
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 36

def category
  @category
end

#position ⇒ Integer

Component position from 0

Returns:

  • (Integer) 


42
43
44
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 42

def position
  @position
end

#score ⇒ Float

Score from 0.0 to 1.0

Returns:

  • (Float) 


39
40
41
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 39

def score
  @score
end

#value ⇒ String

Component value

Returns:

  • (String) 


33
34
35
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 33

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 44

def self.attribute_map
  {
    :'value' => :'value',
    :'category' => :'category',
    :'score' => :'score',
    :'position' => :'position'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 54

def self.swagger_types
  {
    :'value' => :'String',
    :'category' => :'String',
    :'score' => :'Float',
    :'position' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      value == o.value &&
      category == o.category &&
      score == o.score &&
      position == o.position
end

#_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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 212

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
  else # model
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 282

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

#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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 189

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_key]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


176
177
178
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 182

def hash
  [value, category, score, position].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 81

def list_invalid_properties
  invalid_properties = Array.new
  if @category.nil?
    invalid_properties.push('invalid value for "category", category cannot be nil.')
  end

  if @score.nil?
    invalid_properties.push('invalid value for "score", score cannot be nil.')
  end

  if @score > 1.0
    invalid_properties.push('invalid value for "score", must be smaller than or equal to 1.0.')
  end

  if @score < 0.0
    invalid_properties.push('invalid value for "score", must be greater than or equal to 0.0.')
  end

  if @position.nil?
    invalid_properties.push('invalid value for "position", position cannot be nil.')
  end

  if @position > 2147483647
    invalid_properties.push('invalid value for "position", must be smaller than or equal to 2147483647.')
  end

  if @position < 0
    invalid_properties.push('invalid value for "position", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



262
263
264
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 262

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



268
269
270
271
272
273
274
275
276
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 268

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



256
257
258
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 256

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/aspose-email-cloud/models/ai_name_component.rb', line 116

def valid?
  return false if @category.nil?
  return false if @score.nil?
  return false if @score > 1.0
  return false if @score < 0.0
  return false if @position.nil?
  return false if @position > 2147483647
  return false if @position < 0
  true
end