Class: AsposeWordsCloud::XmlDataLoadOptions

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

Overview

Represents options for XML data loading. To learn more, visit the LINQ Reporting Engine documentation article. An instance of this class can be passed into constructors of XmlDataSource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ XmlDataLoadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 55

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?(:'AlwaysGenerateRootObject')
    self.always_generate_root_object = attributes[:'AlwaysGenerateRootObject']
  end
end

Instance Attribute Details

#always_generate_root_object ⇒ Object

Gets or sets a flag indicating whether a generated data source will always contain an object for an XML root element. If an XML root element has no attributes and all its child elements have same names, such an object is not created by default. The default value is false.



38
39
40
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 38

def always_generate_root_object
  @always_generate_root_object
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 40

def self.attribute_map
  {
    :'always_generate_root_object' => :'AlwaysGenerateRootObject'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 47

def self.swagger_types
  {
    :'always_generate_root_object' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



74
75
76
77
78
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 74

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



117
118
119
120
121
122
123
124
125
126
127
128
129
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
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 117

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



188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 188

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 95

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 



202
203
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 202

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


82
83
84
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 82

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



88
89
90
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 88

def hash
  [always_generate_root_object].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



168
169
170
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 168

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



174
175
176
177
178
179
180
181
182
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 174

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



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

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



68
69
70
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 68

def valid?
  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


205
206
207
 
# File 'lib/aspose_words_cloud/models/xml_data_load_options.rb', line 205

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