Class: AsposeCellsCloud::TxtSaveOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/models/txt_save_options.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TxtSaveOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 97

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.has_key?(:'QuoteType')
      self.quote_type = attributes[:'QuoteType']
  end
  if attributes.has_key?(:'Separator')
      self.separator = attributes[:'Separator']
  end
  if attributes.has_key?(:'SeparatorString')
      self.separator_string = attributes[:'SeparatorString']
  end
  if attributes.has_key?(:'AlwaysQuoted')
      self.always_quoted = attributes[:'AlwaysQuoted']
  end
  if attributes.has_key?(:'SaveFormat')
      self.save_format = attributes[:'SaveFormat']
  end
  if attributes.has_key?(:'CachedFileFolder')
      self.cached_file_folder = attributes[:'CachedFileFolder']
  end
  if attributes.has_key?(:'ClearData')
      self.clear_data = attributes[:'ClearData']
  end
  if attributes.has_key?(:'CreateDirectory')
      self.create_directory = attributes[:'CreateDirectory']
  end
  if attributes.has_key?(:'EnableHTTPCompression')
      self.enable_http_compression = attributes[:'EnableHTTPCompression']
  end
  if attributes.has_key?(:'RefreshChartCache')
      self.refresh_chart_cache = attributes[:'RefreshChartCache']
  end
  if attributes.has_key?(:'SortNames')
      self.sort_names = attributes[:'SortNames']
  end
  if attributes.has_key?(:'ValidateMergedAreas')
      self.validate_merged_areas = attributes[:'ValidateMergedAreas']
  end

end

Instance Attribute Details

#always_quoted ⇒ Object

Indicates whether always adding ‘“’ for each field. If true then all values will be quoted; If false then values will only be quoted when needed(for example, when values contain special characters such as ‘”’ , ‘n’ or separator character). Default is false.



41
42
43
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 41

def always_quoted
  @always_quoted
end

#cached_file_folder ⇒ Object

Returns the value of attribute cached_file_folder.



45
46
47
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 45

def cached_file_folder
  @cached_file_folder
end

#clear_data ⇒ Object

Returns the value of attribute clear_data.



47
48
49
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 47

def clear_data
  @clear_data
end

#create_directory ⇒ Object

Returns the value of attribute create_directory.



49
50
51
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 49

def create_directory
  @create_directory
end

#enable_http_compression ⇒ Object

Returns the value of attribute enable_http_compression.



51
52
53
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 51

def enable_http_compression
  @enable_http_compression
end

#quote_type ⇒ Object

Gets or sets how to quote values in the exported text file.



35
36
37
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 35

def quote_type
  @quote_type
end

#refresh_chart_cache ⇒ Object

Returns the value of attribute refresh_chart_cache.



53
54
55
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 53

def refresh_chart_cache
  @refresh_chart_cache
end

#save_format ⇒ Object

Returns the value of attribute save_format.



43
44
45
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 43

def save_format
  @save_format
end

#separator ⇒ Object

Gets and sets char Delimiter of text file.



37
38
39
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 37

def separator
  @separator
end

#separator_string ⇒ Object

Gets and sets the a string value as separator.



39
40
41
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 39

def separator_string
  @separator_string
end

#sort_names ⇒ Object

Returns the value of attribute sort_names.



55
56
57
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 55

def sort_names
  @sort_names
end

#validate_merged_areas ⇒ Object

Returns the value of attribute validate_merged_areas.



57
58
59
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 57

def validate_merged_areas
  @validate_merged_areas
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'quote_type' => :'QuoteType',
    :'separator' => :'Separator',
    :'separator_string' => :'SeparatorString',
    :'always_quoted' => :'AlwaysQuoted',
    :'save_format' => :'SaveFormat',
    :'cached_file_folder' => :'CachedFileFolder',
    :'clear_data' => :'ClearData',
    :'create_directory' => :'CreateDirectory',
    :'enable_http_compression' => :'EnableHTTPCompression',
    :'refresh_chart_cache' => :'RefreshChartCache',
    :'sort_names' => :'SortNames',
    :'validate_merged_areas' => :'ValidateMergedAreas'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 78

def self.swagger_types
  {
    :'quote_type' => :'String',
    :'separator' => :'String',
    :'separator_string' => :'String',
    :'always_quoted' => :'BOOLEAN',
    :'save_format' => :'String',
    :'cached_file_folder' => :'String',
    :'clear_data' => :'BOOLEAN',
    :'create_directory' => :'BOOLEAN',
    :'enable_http_compression' => :'BOOLEAN',
    :'refresh_chart_cache' => :'BOOLEAN',
    :'sort_names' => :'BOOLEAN',
    :'validate_merged_areas' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      quote_type == o.quote_type &&
      separator == o.separator &&
      separator_string == o.separator_string &&
      always_quoted == o.always_quoted &&
      save_format == o.save_format &&
      cached_file_folder == o.cached_file_folder &&
      clear_data == o.clear_data &&
      create_directory == o.create_directory &&
      enable_http_compression == o.enable_http_compression &&
      refresh_chart_cache == o.refresh_chart_cache &&
      sort_names == o.sort_names &&
      validate_merged_areas == o.validate_merged_areas 
      std_dev == o.std_dev
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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 260

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  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 = AsposeCellsCloud.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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 326

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 239

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?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


226
227
228
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



232
233
234
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 232

def hash
  [ quote_type , separator , separator_string , always_quoted , save_format , cached_file_folder , clear_data , create_directory , enable_http_compression , refresh_chart_cache , sort_names , validate_merged_areas ].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



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
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 144

def list_invalid_properties
  invalid_properties = Array.new
  if @quote_type.nil?
      invalid_properties.push("invalid value for 'quote_type', quote_type cannot be nil.")
  end
  if @separator.nil?
      invalid_properties.push("invalid value for 'separator', separator cannot be nil.")
  end
  if @separator_string.nil?
      invalid_properties.push("invalid value for 'separator_string', separator_string cannot be nil.")
  end
  if @always_quoted.nil?
      invalid_properties.push("invalid value for 'always_quoted', always_quoted cannot be nil.")
  end
  if @save_format.nil?
      invalid_properties.push("invalid value for 'save_format', save_format cannot be nil.")
  end
  if @cached_file_folder.nil?
      invalid_properties.push("invalid value for 'cached_file_folder', cached_file_folder cannot be nil.")
  end
  if @clear_data.nil?
      invalid_properties.push("invalid value for 'clear_data', clear_data cannot be nil.")
  end
  if @create_directory.nil?
      invalid_properties.push("invalid value for 'create_directory', create_directory cannot be nil.")
  end
  if @enable_http_compression.nil?
      invalid_properties.push("invalid value for 'enable_http_compression', enable_http_compression cannot be nil.")
  end
  if @refresh_chart_cache.nil?
      invalid_properties.push("invalid value for 'refresh_chart_cache', refresh_chart_cache cannot be nil.")
  end
  if @sort_names.nil?
      invalid_properties.push("invalid value for 'sort_names', sort_names cannot be nil.")
  end
  if @validate_merged_areas.nil?
      invalid_properties.push("invalid value for 'validate_merged_areas', validate_merged_areas cannot be nil.")
  end

  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



306
307
308
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 306

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



312
313
314
315
316
317
318
319
320
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 312

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



300
301
302
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 300

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 188

def valid?
  return false if @quote_type.nil?
  return false if @separator.nil?
  return false if @separator_string.nil?
  return false if @always_quoted.nil?
  return false if @save_format.nil?
  return false if @cached_file_folder.nil?
  return false if @clear_data.nil?
  return false if @create_directory.nil?
  return false if @enable_http_compression.nil?
  return false if @refresh_chart_cache.nil?
  return false if @sort_names.nil?
  return false if @validate_merged_areas.nil?
  return true
end