Class: AsposeCellsCloud::Workbook

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Workbook

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
 
# File 'lib/aspose_cells_cloud/models/workbook.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.has_key?(:'FileName')
      self.file_name = attributes[:'FileName']
  end
  if attributes.has_key?(:'Links')
      self.links = attributes[:'Links']
  end
  if attributes.has_key?(:'Worksheets')
      self.worksheets = attributes[:'Worksheets']
  end
  if attributes.has_key?(:'DefaultStyle')
      self.default_style = attributes[:'DefaultStyle']
  end
  if attributes.has_key?(:'DocumentProperties')
      self.document_properties = attributes[:'DocumentProperties']
  end
  if attributes.has_key?(:'Names')
      self.names = attributes[:'Names']
  end
  if attributes.has_key?(:'Settings')
      self.settings = attributes[:'Settings']
  end
  if attributes.has_key?(:'IsWriteProtected')
      self.is_write_protected = attributes[:'IsWriteProtected']
  end
  if attributes.has_key?(:'IsProtected')
      self.is_protected = attributes[:'IsProtected']
  end
  if attributes.has_key?(:'IsEncryption')
      self.is_encryption = attributes[:'IsEncryption']
  end
  if attributes.has_key?(:'Password')
      self.password = attributes[:'Password']
  end

end

Instance Attribute Details

#default_style ⇒ Object

Gets or sets the default object of the workbook.



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

def default_style
  @default_style
end

#document_properties ⇒ Object

Returns the value of attribute document_properties.



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

def document_properties
  @document_properties
end

#file_name ⇒ Object

Gets and sets the current file name.



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

def file_name
  @file_name
end

#is_encryption ⇒ Object

Returns the value of attribute is_encryption.



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

def is_encryption
  @is_encryption
end

#is_protected ⇒ Object

Returns the value of attribute is_protected.



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

def is_protected
  @is_protected
end

#is_write_protected ⇒ Object

Returns the value of attribute is_write_protected.



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

def is_write_protected
  @is_write_protected
end

#links ⇒ Object

Returns the value of attribute links.



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

def links
  @links
end

#names ⇒ Object

Returns the value of attribute names.



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

def names
  @names
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#settings ⇒ Object

Represents the workbook settings.



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

def settings
  @settings
end

#worksheets ⇒ Object

Gets the collection in the spreadsheet.



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

def worksheets
  @worksheets
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 58

def self.attribute_map
  {
    :'file_name' => :'FileName',
    :'links' => :'Links',
    :'worksheets' => :'Worksheets',
    :'default_style' => :'DefaultStyle',
    :'document_properties' => :'DocumentProperties',
    :'names' => :'Names',
    :'settings' => :'Settings',
    :'is_write_protected' => :'IsWriteProtected',
    :'is_protected' => :'IsProtected',
    :'is_encryption' => :'IsEncryption',
    :'password' => :'Password'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 75

def self.swagger_types
  {
    :'file_name' => :'String',
    :'links' => :'Array<Link>',
    :'worksheets' => :'LinkElement',
    :'default_style' => :'LinkElement',
    :'document_properties' => :'LinkElement',
    :'names' => :'LinkElement',
    :'settings' => :'LinkElement',
    :'is_write_protected' => :'String',
    :'is_protected' => :'String',
    :'is_encryption' => :'String',
    :'password' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      file_name == o.file_name &&
      links == o.links &&
      worksheets == o.worksheets &&
      default_style == o.default_style &&
      document_properties == o.document_properties &&
      names == o.names &&
      settings == o.settings &&
      is_write_protected == o.is_write_protected &&
      is_protected == o.is_protected &&
      is_encryption == o.is_encryption &&
      password == o.password 
      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



248
249
250
251
252
253
254
255
256
257
258
259
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
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 248

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 314

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 227

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


214
215
216
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 220

def hash
  [ file_name , links , worksheets , default_style , document_properties , names , settings , is_write_protected , is_protected , is_encryption , password ].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



137
138
139
140
141
142
143
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
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 137

def list_invalid_properties
  invalid_properties = Array.new
  if @file_name.nil?
      invalid_properties.push("invalid value for 'file_name', file_name cannot be nil.")
  end
  if @links.nil?
      invalid_properties.push("invalid value for 'links', links cannot be nil.")
  end
  if @worksheets.nil?
      invalid_properties.push("invalid value for 'worksheets', worksheets cannot be nil.")
  end
  if @default_style.nil?
      invalid_properties.push("invalid value for 'default_style', default_style cannot be nil.")
  end
  if @document_properties.nil?
      invalid_properties.push("invalid value for 'document_properties', document_properties cannot be nil.")
  end
  if @names.nil?
      invalid_properties.push("invalid value for 'names', names cannot be nil.")
  end
  if @settings.nil?
      invalid_properties.push("invalid value for 'settings', settings cannot be nil.")
  end
  if @is_write_protected.nil?
      invalid_properties.push("invalid value for 'is_write_protected', is_write_protected cannot be nil.")
  end
  if @is_protected.nil?
      invalid_properties.push("invalid value for 'is_protected', is_protected cannot be nil.")
  end
  if @is_encryption.nil?
      invalid_properties.push("invalid value for 'is_encryption', is_encryption cannot be nil.")
  end
  if @password.nil?
      invalid_properties.push("invalid value for 'password', password 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



294
295
296
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 294

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



300
301
302
303
304
305
306
307
308
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 300

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



288
289
290
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 288

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/aspose_cells_cloud/models/workbook.rb', line 178

def valid?
  return false if @file_name.nil?
  return false if @links.nil?
  return false if @worksheets.nil?
  return false if @default_style.nil?
  return false if @document_properties.nil?
  return false if @names.nil?
  return false if @settings.nil?
  return false if @is_write_protected.nil?
  return false if @is_protected.nil?
  return false if @is_encryption.nil?
  return false if @password.nil?
  return true
end