Class: Alfresco::RequestRange

Inherits:
Object
  • Object
show all
Defined in:
lib/alfresco/models/request_range.rb

Overview

Facet range

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestRange

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/alfresco/models/request_range.rb', line 78

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#_end ⇒ Object

The end of the range



25
26
27
 
# File 'lib/alfresco/models/request_range.rb', line 25

def _end
  @_end
end

#exclude_filters ⇒ Object

Filter queries to exclude when calculating statistics



43
44
45
 
# File 'lib/alfresco/models/request_range.rb', line 43

def exclude_filters
  @exclude_filters
end

#field ⇒ Object

The name of the field to perform range



19
20
21
 
# File 'lib/alfresco/models/request_range.rb', line 19

def field
  @field
end

#gap ⇒ Object

Bucket size



28
29
30
 
# File 'lib/alfresco/models/request_range.rb', line 28

def gap
  @gap
end

#hardend ⇒ Object

If true means that the last bucket will end at “end” even if it is less than “gap” wide.



31
32
33
 
# File 'lib/alfresco/models/request_range.rb', line 31

def hardend
  @hardend
end

#include ⇒ Object

lower, upper, edge, outer, all



37
38
39
 
# File 'lib/alfresco/models/request_range.rb', line 37

def include
  @include
end

#label ⇒ Object

A label to include as a pivot reference



40
41
42
 
# File 'lib/alfresco/models/request_range.rb', line 40

def label
  @label
end

#other ⇒ Object

before, after, between, non, all



34
35
36
 
# File 'lib/alfresco/models/request_range.rb', line 34

def other
  @other
end

#start ⇒ Object

The start of the range



22
23
24
 
# File 'lib/alfresco/models/request_range.rb', line 22

def start
  @start
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/alfresco/models/request_range.rb', line 47

def self.attribute_map
  {
    :'field' => :'field',
    :'start' => :'start',
    :'_end' => :'end',
    :'gap' => :'gap',
    :'hardend' => :'hardend',
    :'other' => :'other',
    :'include' => :'include',
    :'label' => :'label',
    :'exclude_filters' => :'excludeFilters'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/alfresco/models/request_range.rb', line 62

def self.swagger_types
  {
    :'field' => :'String',
    :'start' => :'String',
    :'_end' => :'String',
    :'gap' => :'String',
    :'hardend' => :'BOOLEAN',
    :'other' => :'Array<String>',
    :'include' => :'Array<String>',
    :'label' => :'String',
    :'exclude_filters' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/alfresco/models/request_range.rb', line 143

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      field == o.field &&
      start == o.start &&
      _end == o._end &&
      gap == o.gap &&
      hardend == o.hardend &&
      other == o.other &&
      include == o.include &&
      label == o.label &&
      exclude_filters == o.exclude_filters
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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/alfresco/models/request_range.rb', line 193

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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/alfresco/models/request_range.rb', line 259

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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/alfresco/models/request_range.rb', line 172

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


159
160
161
 
# File 'lib/alfresco/models/request_range.rb', line 159

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



165
166
167
 
# File 'lib/alfresco/models/request_range.rb', line 165

def hash
  [field, start, _end, gap, hardend, other, include, label, exclude_filters].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



130
131
132
133
 
# File 'lib/alfresco/models/request_range.rb', line 130

def list_invalid_properties
  invalid_properties = Array.new
  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



239
240
241
 
# File 'lib/alfresco/models/request_range.rb', line 239

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



245
246
247
248
249
250
251
252
253
 
# File 'lib/alfresco/models/request_range.rb', line 245

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



233
234
235
 
# File 'lib/alfresco/models/request_range.rb', line 233

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



137
138
139
 
# File 'lib/alfresco/models/request_range.rb', line 137

def valid?
  return true
end