Class: AsposeWordsCloud::PositionInsideNode

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/position_inside_node.rb

Overview

DTO container with a new position in the document tree.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PositionInsideNode

Initializes the object

Parameters:

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

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 60

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.type = 'Inside'

  if attributes.key?(:'NodeId')
    self.node_id = attributes[:'NodeId']
  end

  if attributes.key?(:'Offset')
    self.offset = attributes[:'Offset']
  end
end

Instance Attribute Details

#node_idObject

Gets or sets the node id.



33
34
35
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 33

def node_id
  @node_id
end

#offsetObject

Gets or sets the offset in the node.



39
40
41
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 39

def offset
  @offset
end

#typeObject

Gets position type.



36
37
38
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 36

def type
  @type
end

Class Method Details

.attribute_mapObject

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



41
42
43
44
45
46
47
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 41

def self.attribute_map
  {
    :'node_id' => :'NodeId',
    :'type' => :'Type',
    :'offset' => :'Offset'
  }
end

.swagger_typesObject

Attribute type mapping.



50
51
52
53
54
55
56
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 50

def self.swagger_types
  {
    :'node_id' => :'String',
    :'type' => :'String',
    :'offset' => :'Integer'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



85
86
87
88
89
90
91
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 85

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      node_id == other.node_id &&
      type == other.type &&
      offset == other.offset
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



130
131
132
133
134
135
136
137
138
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
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 130

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    temp_model = AsposeWordsCloud.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



201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 201

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 108

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#collectFilesContent(resultFilesContent) ⇒ Object



215
216
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 215

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


95
96
97
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 95

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



101
102
103
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 101

def hash
  [node_id, type, offset].hash
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



181
182
183
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 181

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 187

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



175
176
177
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 175

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



79
80
81
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 79

def valid?
  return true
end

#validateObject

Raises:

  • (ArgumentError)


218
219
220
# File 'lib/aspose_words_cloud/models/position_inside_node.rb', line 218

def validate()
  raise ArgumentError, 'Property node_id in PositionInsideNode is required.' if self.node_id.nil?
end