Class: AsposeWordsCloud::FootnoteBase

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

Overview

Footnote base class.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FootnoteBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 89

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 }

  if attributes.key?(:'FootnoteType')
    self.footnote_type = attributes[:'FootnoteType']
  end

  if attributes.key?(:'Position')
    self.position = attributes[:'Position']
  end

  if attributes.key?(:'ReferenceMark')
    self.reference_mark = attributes[:'ReferenceMark']
  end

  if attributes.key?(:'Text')
    self.text = attributes[:'Text']
  end
end

Instance Attribute Details

#footnote_type ⇒ Object

Gets or sets returns a value that specifies whether this is a footnote or endnote.



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

def footnote_type
  @footnote_type
end

#position ⇒ Object

Gets or sets link to comment range start node.



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

def position
  @position
end

#reference_mark ⇒ Object

Gets or sets /sets custom reference mark to be used for this footnote. Default value is Empty, meaning auto-numbered footnotes are used.



40
41
42
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 40

def reference_mark
  @reference_mark
end

#text ⇒ Object

Gets or sets this is a convenience property that allows to easily get or set text of the footnote.



43
44
45
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 43

def text
  @text
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 68

def self.attribute_map
  {
    :'footnote_type' => :'FootnoteType',
    :'position' => :'Position',
    :'reference_mark' => :'ReferenceMark',
    :'text' => :'Text'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 78

def self.swagger_types
  {
    :'footnote_type' => :'String',
    :'position' => :'DocumentPosition',
    :'reference_mark' => :'String',
    :'text' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



145
146
147
148
149
150
151
152
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 145

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      footnote_type == other.footnote_type &&
      position == other.position &&
      reference_mark == other.reference_mark &&
      text == other.text
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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 191

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 258

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 169

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

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


156
157
158
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 156

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 162

def hash
  [footnote_type, position, reference_mark, text].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



114
115
116
117
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 114

def list_invalid_properties
  invalid_properties = []
  return 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



238
239
240
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 238

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



244
245
246
247
248
249
250
251
252
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 244

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



232
233
234
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 232

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



121
122
123
124
125
126
 
# File 'lib/aspose_words_cloud/models/footnote_base.rb', line 121

def valid?
  footnote_type_validator = EnumAttributeValidator.new('String', ["Footnote", "Endnote"])
  return false unless footnote_type_validator.valid?(@footnote_type)

  return true
end