Class: AsposeWordsCloud::CsvDataLoadOptions

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

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CsvDataLoadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 71

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

  if attributes.key?(:'Delimiter')
    self.delimiter = attributes[:'Delimiter']
  end

  if attributes.key?(:'HasHeaders')
    self.has_headers = attributes[:'HasHeaders']
  end

  if attributes.key?(:'QuoteChar')
    self.quote_char = attributes[:'QuoteChar']
  end
end

Instance Attribute Details

#comment_char ⇒ Object

Gets or sets the character that is used to comment lines of CSV data. The default value is ‘#’ (number sign).



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

def comment_char
  @comment_char
end

#delimiter ⇒ Object

Gets or sets the character to be used as a column delimiter. The default value is ‘,’ (comma).



40
41
42
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 40

def delimiter
  @delimiter
end

#has_headers ⇒ Object

Gets or sets a value indicating whether the first record of CSV data contains column names. The default value is false.



44
45
46
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 44

def has_headers
  @has_headers
end

#quote_char ⇒ Object

Gets or sets the character that is used to quote field values. The default value is ‘“’ (quotation mark).Double the character to place it into quoted text.



48
49
50
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 48

def quote_char
  @quote_char
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 50

def self.attribute_map
  {
    :'comment_char' => :'CommentChar',
    :'delimiter' => :'Delimiter',
    :'has_headers' => :'HasHeaders',
    :'quote_char' => :'QuoteChar'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 60

def self.swagger_types
  {
    :'comment_char' => :'String',
    :'delimiter' => :'String',
    :'has_headers' => :'BOOLEAN',
    :'quote_char' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



102
103
104
105
106
107
108
109
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 102

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



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
185
186
187
188
189
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 148

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



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 219

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 126

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 



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

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


113
114
115
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 113

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 119

def hash
  [comment_char, delimiter, has_headers, quote_char].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



199
200
201
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 199

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



205
206
207
208
209
210
211
212
213
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 205

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



193
194
195
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 193

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



96
97
98
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 96

def valid?
  return true
end

#validate ⇒ Object

Raises:

  • (ArgumentError) 


236
237
238
239
240
241
 
# File 'lib/aspose_words_cloud/models/csv_data_load_options.rb', line 236

def validate()
  raise ArgumentError, 'Property comment_char in CsvDataLoadOptions is required.' if self.comment_char.nil?
  raise ArgumentError, 'Property delimiter in CsvDataLoadOptions is required.' if self.delimiter.nil?
  raise ArgumentError, 'Property has_headers in CsvDataLoadOptions is required.' if self.has_headers.nil?
  raise ArgumentError, 'Property quote_char in CsvDataLoadOptions is required.' if self.quote_char.nil?
end