class Alfresco::RequestRange

Facet range

Attributes

_end[RW]

The end of the range

exclude_filters[RW]

Filter queries to exclude when calculating statistics

field[RW]

The name of the field to perform range

gap[RW]

Bucket size

hardend[RW]

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

include[RW]

lower, upper, edge, outer, all

label[RW]

A label to include as a pivot reference

other[RW]

before, after, between, non, all

start[RW]

The start of the range

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/alfresco/models/request_range.rb, line 159
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/alfresco/models/request_range.rb, line 130
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/alfresco/models/request_range.rb, line 239
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/alfresco/models/request_range.rb, line 233
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/alfresco/models/request_range.rb, line 137
def valid?
  return true
end