Class: AsposeWordsCloud::JsonDataLoadOptions

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

Overview

Represents options for parsing JSON data. An instance of this class can be passed into constructors of Aspose.Words.Reporting.JsonDataSource.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JsonDataLoadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 103

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

  if attributes.key?(:'ExactDateTimeParseFormats')
    if (value = attributes[:'ExactDateTimeParseFormats']).is_a?(Array)
      self.exact_date_time_parse_formats = value
    end
  end

  if attributes.key?(:'SimpleValueParseMode')
    self.simple_value_parse_mode = attributes[:'SimpleValueParseMode']
  end
end

Instance Attribute Details

#always_generate_root_object ⇒ Object

Gets or sets a value indicating whether a generated data source will always contain an object for a JSON root element. If a JSON root element contains a single complex property, such an object is not created by default. The default value is false.



37
38
39
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 37

def always_generate_root_object
  @always_generate_root_object
end

#exact_date_time_parse_formats ⇒ Object

Gets or sets exact formats for parsing JSON date-time values while loading JSON. The default is null. Strings encoded using Microsoft® JSON date-time format (for example, “/Date(1224043200000)/”) are always recognized as date-time values regardless of a value of this property. The property defines additional formats to be used while parsing date-time values from strings in the following way: • When Aspose.Words.Reporting.JsonDataLoadOptions.ExactDateTimeParseFormats is null, the ISO-8601 format and all date-time formats supported for the current, English USA, and English New Zealand cultures are used additionally in the mentioned order. • When Aspose.Words.Reporting.JsonDataLoadOptions.ExactDateTimeParseFormats contains strings, they are used as additional date-time formats utilizing the current culture. • When Aspose.Words.Reporting.JsonDataLoadOptions.ExactDateTimeParseFormats is empty, no additional date-time formats are used.



54
55
56
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 54

def exact_date_time_parse_formats
  @exact_date_time_parse_formats
end

#simple_value_parse_mode ⇒ Object

Gets or sets a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. Such a mode does not affect parsing of date-time values. The default is Aspose.Words.Reporting.JsonSimpleValueParseMode.Loose.



59
60
61
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 59

def simple_value_parse_mode
  @simple_value_parse_mode
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'always_generate_root_object' => :'AlwaysGenerateRootObject',
    :'exact_date_time_parse_formats' => :'ExactDateTimeParseFormats',
    :'simple_value_parse_mode' => :'SimpleValueParseMode'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 93

def self.swagger_types
  {
    :'always_generate_root_object' => :'BOOLEAN',
    :'exact_date_time_parse_formats' => :'Array<String>',
    :'simple_value_parse_mode' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



150
151
152
153
154
155
156
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 150

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



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
229
230
231
232
233
234
235
236
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 195

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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 266

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 173

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 



280
281
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 280

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


160
161
162
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 160

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



166
167
168
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 166

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



246
247
248
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 246

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



252
253
254
255
256
257
258
259
260
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 252

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



240
241
242
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 240

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



126
127
128
129
130
131
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 126

def valid?
  simple_value_parse_mode_validator = EnumAttributeValidator.new('String', ["Loose", "Strict"])
  return false unless simple_value_parse_mode_validator.valid?(@simple_value_parse_mode)

  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


283
284
285
286
 
# File 'lib/aspose_words_cloud/models/json_data_load_options.rb', line 283

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