Class: WebApiActivequerybuilder::Transform

Inherits:
Object
  • Object
show all
Defined in:
lib/webapi-active-query-builder/models/transform.rb

Overview

SQL transformation parameters and commands.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transform

Initializes the object


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/webapi-active-query-builder/models/transform.rb', line 74

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

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

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

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

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

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

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

end

Instance Attribute Details

#filterObject

Returns the value of attribute filter


41
42
43
# File 'lib/webapi-active-query-builder/models/transform.rb', line 41

def filter
  @filter
end

#guidObject

Unique identifier that defines SQL execution context for the given query, i.e. database server (SQL syntax rules), database schema. The context itself must be saved in the user account on webapi.activequerybuilder.com/.


30
31
32
# File 'lib/webapi-active-query-builder/models/transform.rb', line 30

def guid
  @guid
end

#hidden_columnsObject

Returns the value of attribute hidden_columns


43
44
45
# File 'lib/webapi-active-query-builder/models/transform.rb', line 43

def hidden_columns
  @hidden_columns
end

#paginationObject

Returns the value of attribute pagination


35
36
37
# File 'lib/webapi-active-query-builder/models/transform.rb', line 35

def pagination
  @pagination
end

#sortingsObject

Returns the value of attribute sortings


39
40
41
# File 'lib/webapi-active-query-builder/models/transform.rb', line 39

def sortings
  @sortings
end

#sqlObject

Text of original SQL query to be transformed.


33
34
35
# File 'lib/webapi-active-query-builder/models/transform.rb', line 33

def sql
  @sql
end

#totalsObject

Returns the value of attribute totals


37
38
39
# File 'lib/webapi-active-query-builder/models/transform.rb', line 37

def totals
  @totals
end

Class Method Details

.attribute_mapObject

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


47
48
49
50
51
52
53
54
55
56
57
# File 'lib/webapi-active-query-builder/models/transform.rb', line 47

def self.attribute_map
  {
    :'guid' => :'Guid',
    :'sql' => :'Sql',
    :'pagination' => :'Pagination',
    :'totals' => :'Totals',
    :'sortings' => :'Sortings',
    :'filter' => :'Filter',
    :'hidden_columns' => :'HiddenColumns'
  }
end

.swagger_typesObject

Attribute type mapping.


60
61
62
63
64
65
66
67
68
69
70
# File 'lib/webapi-active-query-builder/models/transform.rb', line 60

def self.swagger_types
  {
    :'guid' => :'String',
    :'sql' => :'String',
    :'pagination' => :'Pagination',
    :'totals' => :'Array<Totals>',
    :'sortings' => :'Array<Sorting>',
    :'filter' => :'ConditionGroup',
    :'hidden_columns' => :'Array<HiddenColumn>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.


131
132
133
134
135
136
137
138
139
140
141
# File 'lib/webapi-active-query-builder/models/transform.rb', line 131

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      guid == o.guid &&
      sql == o.sql &&
      pagination == o.pagination &&
      totals == o.totals &&
      sortings == o.sortings &&
      filter == o.filter &&
      hidden_columns == o.hidden_columns
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/webapi-active-query-builder/models/transform.rb', line 179

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 =~ /^(true|t|yes|y|1)$/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 = WebApiActivequerybuilder.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


245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'lib/webapi-active-query-builder/models/transform.rb', line 245

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


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/webapi-active-query-builder/models/transform.rb', line 158

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/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

See Also:

  • `==` method

145
146
147
# File 'lib/webapi-active-query-builder/models/transform.rb', line 145

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.


151
152
153
# File 'lib/webapi-active-query-builder/models/transform.rb', line 151

def hash
  [guid, sql, pagination, totals, sortings, filter, hidden_columns].hash
end

#list_invalid_propertiesObject

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


118
119
120
121
# File 'lib/webapi-active-query-builder/models/transform.rb', line 118

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)


225
226
227
# File 'lib/webapi-active-query-builder/models/transform.rb', line 225

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash


231
232
233
234
235
236
237
238
239
# File 'lib/webapi-active-query-builder/models/transform.rb', line 231

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_sString

Returns the string representation of the object


219
220
221
# File 'lib/webapi-active-query-builder/models/transform.rb', line 219

def to_s
  to_hash.to_s
end

#valid?Boolean

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


125
126
127
# File 'lib/webapi-active-query-builder/models/transform.rb', line 125

def valid?
  return true
end