Class: WebApiActivequerybuilder::Totals

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

Overview

If any aggregations are defined there, the SELECT list of original query is replaced with the list of aggregations in transformed query. Filling aggregations is useful when you want to get totals for original query resultset.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Totals

Initializes the object

Parameters:

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

    Model attributes in the form of hash


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/webapi-active-query-builder/models/totals.rb', line 75

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

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

end

Instance Attribute Details

#aggregateObject

Aggregate function name.


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

def aggregate
  @aggregate
end

#fieldObject

Column of original query to which an aggregate function will be applied.


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

def field
  @field
end

Class Method Details

.attribute_mapObject

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


58
59
60
61
62
63
# File 'lib/webapi-active-query-builder/models/totals.rb', line 58

def self.attribute_map
  {
    :'field' => :'field',
    :'aggregate' => :'aggregate'
  }
end

.swagger_typesObject

Attribute type mapping.


66
67
68
69
70
71
# File 'lib/webapi-active-query-builder/models/totals.rb', line 66

def self.swagger_types
  {
    :'field' => :'String',
    :'aggregate' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      field == o.field &&
      aggregate == o.aggregate
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


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
193
194
195
196
197
# File 'lib/webapi-active-query-builder/models/totals.rb', line 161

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

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


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

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


140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/webapi-active-query-builder/models/totals.rb', line 140

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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

127
128
129
# File 'lib/webapi-active-query-builder/models/totals.rb', line 127

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


133
134
135
# File 'lib/webapi-active-query-builder/models/totals.rb', line 133

def hash
  [field, aggregate].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons


93
94
95
96
# File 'lib/webapi-active-query-builder/models/totals.rb', line 93

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


207
208
209
# File 'lib/webapi-active-query-builder/models/totals.rb', line 207

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


213
214
215
216
217
218
219
220
221
# File 'lib/webapi-active-query-builder/models/totals.rb', line 213

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

Returns:

  • (String)

    String presentation of the object


201
202
203
# File 'lib/webapi-active-query-builder/models/totals.rb', line 201

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


100
101
102
103
104
# File 'lib/webapi-active-query-builder/models/totals.rb', line 100

def valid?
  aggregate_validator = EnumAttributeValidator.new('String', ["avg", "count", "max", "min", "sum"])
  return false unless aggregate_validator.valid?(@aggregate)
  return true
end