Class: WebApiActivequerybuilder::Pagination

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

Overview

Instructs to limit the number of rows in transformed query resultset taking limitations of original query into account. In other words, if original query contains row limitation clause, it will be wrapped into a derived table and additional row limitation clause will be added ontop.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Pagination

Initializes the object


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/webapi-active-query-builder/models/pagination.rb', line 54

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

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

end

Instance Attribute Details

#skipObject

Number of rows to skip from the top of original resultset.


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

def skip
  @skip
end

#takeObject

Number of rows to get from orignal to new resultset.


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

def take
  @take
end

Class Method Details

.attribute_mapObject

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


37
38
39
40
41
42
# File 'lib/webapi-active-query-builder/models/pagination.rb', line 37

def self.attribute_map
  {
    :'skip' => :'skip',
    :'take' => :'take'
  }
end

.swagger_typesObject

Attribute type mapping.


45
46
47
48
49
50
# File 'lib/webapi-active-query-builder/models/pagination.rb', line 45

def self.swagger_types
  {
    :'skip' => :'Integer',
    :'take' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.


85
86
87
88
89
90
# File 'lib/webapi-active-query-builder/models/pagination.rb', line 85

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      skip == o.skip &&
      take == o.take
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type


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
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/webapi-active-query-builder/models/pagination.rb', line 128

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


194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'lib/webapi-active-query-builder/models/pagination.rb', line 194

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


107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/webapi-active-query-builder/models/pagination.rb', line 107

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

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

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.


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

def hash
  [skip, take].hash
end

#list_invalid_propertiesObject

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


72
73
74
75
# File 'lib/webapi-active-query-builder/models/pagination.rb', line 72

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)


174
175
176
# File 'lib/webapi-active-query-builder/models/pagination.rb', line 174

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash


180
181
182
183
184
185
186
187
188
# File 'lib/webapi-active-query-builder/models/pagination.rb', line 180

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


168
169
170
# File 'lib/webapi-active-query-builder/models/pagination.rb', line 168

def to_s
  to_hash.to_s
end

#valid?Boolean

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


79
80
81
# File 'lib/webapi-active-query-builder/models/pagination.rb', line 79

def valid?
  return true
end