Class: TripletexRubyClient::ReportCell

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/models/report_cell.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportCell

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 102

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

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  end

  if attributes.has_key?(:'changes')
    if (value = attributes[:'changes']).is_a?(Array)
      self.changes = value
    end
  end

  if attributes.has_key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.has_key?(:'expression')
    self.expression = attributes[:'expression']
  end

  if attributes.has_key?(:'variableName')
    self.variable_name = attributes[:'variableName']
  end

  if attributes.has_key?(:'valueFormat')
    self.value_format = attributes[:'valueFormat']
  end

  if attributes.has_key?(:'cellFormat')
    self.cell_format = attributes[:'cellFormat']
  end

  if attributes.has_key?(:'defaultAxis')
    self.default_axis = attributes[:'defaultAxis']
  end

  if attributes.has_key?(:'column')
    self.column = attributes[:'column']
  end

  if attributes.has_key?(:'row')
    self.row = attributes[:'row']
  end
end

Instance Attribute Details

#cell_format ⇒ Object

Format string for cell (indentation, font size etc)



33
34
35
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 33

def cell_format
  @cell_format
end

#changes ⇒ Object

Returns the value of attribute changes.



19
20
21
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 19

def changes
  @changes
end

#column ⇒ Object

Column reference



39
40
41
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 39

def column
  @column
end

#default_axis ⇒ Object

Format string for cell (indentation, font size etc)



36
37
38
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 36

def default_axis
  @default_axis
end

#expression ⇒ Object

Expression / formula according to Rule Engine Expression Language



24
25
26
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 24

def expression
  @expression
end

#id ⇒ Object

Returns the value of attribute id.



15
16
17
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 15

def id
  @id
end

#row ⇒ Object

Row reference



42
43
44
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 42

def row
  @row
end

#url ⇒ Object

Returns the value of attribute url.



21
22
23
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 21

def url
  @url
end

#value_format ⇒ Object

Format string for value (how to print number, date etc)



30
31
32
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 30

def value_format
  @value_format
end

#variable_name ⇒ Object

Variable name that can be used to reference this cell



27
28
29
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 27

def variable_name
  @variable_name
end

#version ⇒ Object

Returns the value of attribute version.



17
18
19
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 17

def version
  @version
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
75
76
77
78
79
80
81
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 67

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'expression' => :'expression',
    :'variable_name' => :'variableName',
    :'value_format' => :'valueFormat',
    :'cell_format' => :'cellFormat',
    :'default_axis' => :'defaultAxis',
    :'column' => :'column',
    :'row' => :'row'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 84

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'expression' => :'String',
    :'variable_name' => :'String',
    :'value_format' => :'String',
    :'cell_format' => :'String',
    :'default_axis' => :'String',
    :'column' => :'ReportGroup',
    :'row' => :'ReportGroup'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 278

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      expression == o.expression &&
      variable_name == o.variable_name &&
      value_format == o.value_format &&
      cell_format == o.cell_format &&
      default_axis == o.default_axis &&
      column == o.column &&
      row == o.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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 330

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 = TripletexRubyClient.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



396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 396

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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 309

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 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


296
297
298
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 296

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



302
303
304
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 302

def hash
  [id, version, changes, url, expression, variable_name, value_format, cell_format, default_axis, column, row].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
190
191
192
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 157

def list_invalid_properties
  invalid_properties = Array.new
  if !@expression.nil? && @expression.to_s.length > 21845
    invalid_properties.push('invalid value for "expression", the character length must be smaller than or equal to 21845.')
  end

  if !@expression.nil? && @expression.to_s.length < 0
    invalid_properties.push('invalid value for "expression", the character length must be great than or equal to 0.')
  end

  if !@variable_name.nil? && @variable_name.to_s.length > 100
    invalid_properties.push('invalid value for "variable_name", the character length must be smaller than or equal to 100.')
  end

  if !@variable_name.nil? && @variable_name.to_s.length < 0
    invalid_properties.push('invalid value for "variable_name", the character length must be great than or equal to 0.')
  end

  if !@value_format.nil? && @value_format.to_s.length > 100
    invalid_properties.push('invalid value for "value_format", the character length must be smaller than or equal to 100.')
  end

  if !@value_format.nil? && @value_format.to_s.length < 0
    invalid_properties.push('invalid value for "value_format", the character length must be great than or equal to 0.')
  end

  if !@cell_format.nil? && @cell_format.to_s.length > 255
    invalid_properties.push('invalid value for "cell_format", the character length must be smaller than or equal to 255.')
  end

  if !@cell_format.nil? && @cell_format.to_s.length < 0
    invalid_properties.push('invalid value for "cell_format", the character length must be great than or equal to 0.')
  end

  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



376
377
378
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 376

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



382
383
384
385
386
387
388
389
390
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 382

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



370
371
372
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 370

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



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/tripletex_ruby_client/models/report_cell.rb', line 196

def valid?
  return false if !@expression.nil? && @expression.to_s.length > 21845
  return false if !@expression.nil? && @expression.to_s.length < 0
  return false if !@variable_name.nil? && @variable_name.to_s.length > 100
  return false if !@variable_name.nil? && @variable_name.to_s.length < 0
  return false if !@value_format.nil? && @value_format.to_s.length > 100
  return false if !@value_format.nil? && @value_format.to_s.length < 0
  return false if !@cell_format.nil? && @cell_format.to_s.length > 255
  return false if !@cell_format.nil? && @cell_format.to_s.length < 0
  default_axis_validator = EnumAttributeValidator.new('String', ['NONE', 'ROW', 'COL'])
  return false unless default_axis_validator.valid?(@default_axis)
  true
end