Class: GroupDocsEditorCloud::DelimitedTextSaveOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb

Overview

Contains options for generating and saving text-based Spreadsheet documents (CSV, Tab-based etc.), that use a separator (delimiter)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DelimitedTextSaveOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
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
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 93

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

  if attributes.key?(:'OutputPath')
    self.output_path = attributes[:'OutputPath']
  end

  if attributes.key?(:'HtmlPath')
    self.html_path = attributes[:'HtmlPath']
  end

  if attributes.key?(:'ResourcesPath')
    self.resources_path = attributes[:'ResourcesPath']
  end

  if attributes.key?(:'Format')
    self.format = attributes[:'Format']
  end

  if attributes.key?(:'Separator')
    self.separator = attributes[:'Separator']
  end

  if attributes.key?(:'Encoding')
    self.encoding = attributes[:'Encoding']
  end

  if attributes.key?(:'TrimLeadingBlankRowAndColumn')
    self.trim_leading_blank_row_and_column = attributes[:'TrimLeadingBlankRowAndColumn']
  end

  if attributes.key?(:'KeepSeparatorsForBlankRow')
    self.keep_separators_for_blank_row = attributes[:'KeepSeparatorsForBlankRow']
  end

end

Instance Attribute Details

#encoding ⇒ Object

Allows to set an encoding for the text-based Spreadsheet document. By default (and if not specified) is UTF-8.



53
54
55
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 53

def encoding
  @encoding
end

#file_info ⇒ Object

File info



35
36
37
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 35

def file_info
  @file_info
end

#format ⇒ Object

Document format



47
48
49
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 47

def format
  @format
end

#html_path ⇒ Object

The Html document path



41
42
43
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 41

def html_path
  @html_path
end

#keep_separators_for_blank_row ⇒ Object

Indicates whether separators should be output for blank row. Default value is false which means the content for blank row will be empty.



59
60
61
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 59

def keep_separators_for_blank_row
  @keep_separators_for_blank_row
end

#output_path ⇒ Object

The full output path



38
39
40
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 38

def output_path
  @output_path
end

#resources_path ⇒ Object

Resources path



44
45
46
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 44

def resources_path
  @resources_path
end

#separator ⇒ Object

Allows to specify a string separator (delimiter) for text-based Spreadsheet documents



50
51
52
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 50

def separator
  @separator
end

#trim_leading_blank_row_and_column ⇒ Object

Indicates whether leading blank rows and columns should be trimmed like what MS Excel does



56
57
58
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 56

def trim_leading_blank_row_and_column
  @trim_leading_blank_row_and_column
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 62

def self.attribute_map
  {
    :'file_info' => :'FileInfo',
    :'output_path' => :'OutputPath',
    :'html_path' => :'HtmlPath',
    :'resources_path' => :'ResourcesPath',
    :'format' => :'Format',
    :'separator' => :'Separator',
    :'encoding' => :'Encoding',
    :'trim_leading_blank_row_and_column' => :'TrimLeadingBlankRowAndColumn',
    :'keep_separators_for_blank_row' => :'KeepSeparatorsForBlankRow'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 77

def self.swagger_types
  {
    :'file_info' => :'FileInfo',
    :'output_path' => :'String',
    :'html_path' => :'String',
    :'resources_path' => :'String',
    :'format' => :'String',
    :'separator' => :'String',
    :'encoding' => :'String',
    :'trim_leading_blank_row_and_column' => :'BOOLEAN',
    :'keep_separators_for_blank_row' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 162

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      file_info == other.file_info &&
      output_path == other.output_path &&
      html_path == other.html_path &&
      resources_path == other.resources_path &&
      format == other.format &&
      separator == other.separator &&
      encoding == other.encoding &&
      trim_leading_blank_row_and_column == other.trim_leading_blank_row_and_column &&
      keep_separators_for_blank_row == other.keep_separators_for_blank_row
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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 221

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 288

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 197

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    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 value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    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


178
179
180
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 178

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



184
185
186
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 184

def hash
  [file_info, output_path, html_path, resources_path, format, separator, encoding, trim_leading_blank_row_and_column, keep_separators_for_blank_row].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



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 139

def list_invalid_properties
  invalid_properties = []
  if @trim_leading_blank_row_and_column.nil?
    invalid_properties.push("invalid value for 'trim_leading_blank_row_and_column', trim_leading_blank_row_and_column cannot be nil.")
  end

  if @keep_separators_for_blank_row.nil?
    invalid_properties.push("invalid value for 'keep_separators_for_blank_row', keep_separators_for_blank_row 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



268
269
270
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 268

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



274
275
276
277
278
279
280
281
282
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 274

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



262
263
264
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 262

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



190
191
192
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 190

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



154
155
156
157
158
 
# File 'lib/groupdocs_editor_cloud/models/delimited_text_save_options.rb', line 154

def valid?
  return false if @trim_leading_blank_row_and_column.nil?
  return false if @keep_separators_for_blank_row.nil?
  return true
end