Class: AsposeWordsCloud::ReportEngineSettings

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

Overview

Report engine settings.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportEngineSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'DataSourceName')
    self.data_source_name = attributes[:'DataSourceName']
  end

  if attributes.key?(:'DataSourceType')
    self.data_source_type = attributes[:'DataSourceType']
  end

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

Instance Attribute Details

#csv_data_load_options ⇒ Object

Gets or sets the options for parsing CSV data.



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

def csv_data_load_options
  @csv_data_load_options
end

#data_source_name ⇒ Object

Gets or sets the name to reference the data source object in the template.



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

def data_source_name
  @data_source_name
end

#data_source_type ⇒ Object

Gets or sets type of datasource.



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

def data_source_type
  @data_source_type
end

#report_build_options ⇒ Object

Gets or sets type of options to build report.



42
43
44
 
# File 'lib/aspose_words_cloud/models/report_engine_settings.rb', line 42

def report_build_options
  @report_build_options
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'csv_data_load_options' => :'CsvDataLoadOptions',
    :'data_source_name' => :'DataSourceName',
    :'data_source_type' => :'DataSourceType',
    :'report_build_options' => :'ReportBuildOptions'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'csv_data_load_options' => :'CsvDataLoadOptions',
    :'data_source_name' => :'String',
    :'data_source_type' => :'String',
    :'report_build_options' => :'Array<String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



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
229
 
# File 'lib/aspose_words_cloud/models/report_engine_settings.rb', line 192

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



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

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



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

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


157
158
159
 
# File 'lib/aspose_words_cloud/models/report_engine_settings.rb', line 157

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/aspose_words_cloud/models/report_engine_settings.rb', line 163

def hash
  [csv_data_load_options, data_source_name, data_source_type, report_build_options].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



115
116
117
118
 
# File 'lib/aspose_words_cloud/models/report_engine_settings.rb', line 115

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



239
240
241
 
# File 'lib/aspose_words_cloud/models/report_engine_settings.rb', line 239

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



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

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



233
234
235
 
# File 'lib/aspose_words_cloud/models/report_engine_settings.rb', line 233

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



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

def valid?
  data_source_type_validator = EnumAttributeValidator.new('String', ["Xml", "Json", "Csv"])
  return false unless data_source_type_validator.valid?(@data_source_type)

  return true
end