class Alfresco::RequestFacetField

A simple facet field

Attributes

exclude_filters[RW]

Filter Queries with tags listed here will not be included in facet counts. This is used for multi-select facetting.

facet_enum_cache_min_df[RW]
field[RW]

The facet field

label[RW]

A label to include in place of the facet field

limit[RW]
method[RW]
mincount[RW]

The minimum count required for a facet field to be included in the response.

missing[RW]

When true, count results that match the query but which have no facet value for the field (in addition to the Term-based constraints).

offset[RW]
prefix[RW]

Restricts the possible constraints to only indexed values with a specified prefix.

sort[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/alfresco/models/request_facet_field.rb, line 69
def self.attribute_map
  {
    :'field' => :'field',
    :'label' => :'label',
    :'prefix' => :'prefix',
    :'sort' => :'sort',
    :'method' => :'method',
    :'missing' => :'missing',
    :'limit' => :'limit',
    :'offset' => :'offset',
    :'mincount' => :'mincount',
    :'facet_enum_cache_min_df' => :'facetEnumCacheMinDf',
    :'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_facet_field.rb, line 104
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?(:'label')
    self.label = attributes[:'label']
  end

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

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

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

  if attributes.has_key?(:'missing')
    self.missing = attributes[:'missing']
  else
    self.missing = false
  end

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

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

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

  if attributes.has_key?(:'facetEnumCacheMinDf')
    self.facet_enum_cache_min_df = attributes[:'facetEnumCacheMinDf']
  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_facet_field.rb, line 86
def self.swagger_types
  {
    :'field' => :'String',
    :'label' => :'String',
    :'prefix' => :'String',
    :'sort' => :'String',
    :'method' => :'String',
    :'missing' => :'BOOLEAN',
    :'limit' => :'Integer',
    :'offset' => :'Integer',
    :'mincount' => :'Integer',
    :'facet_enum_cache_min_df' => :'Integer',
    :'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_facet_field.rb, line 199
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      field == o.field &&
      label == o.label &&
      prefix == o.prefix &&
      sort == o.sort &&
      method == o.method &&
      missing == o.missing &&
      limit == o.limit &&
      offset == o.offset &&
      mincount == o.mincount &&
      facet_enum_cache_min_df == o.facet_enum_cache_min_df &&
      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_facet_field.rb, line 251
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_facet_field.rb, line 317
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_facet_field.rb, line 230
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_facet_field.rb, line 217
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_facet_field.rb, line 223
def hash
  [field, label, prefix, sort, method, missing, limit, offset, mincount, facet_enum_cache_min_df, 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_facet_field.rb, line 162
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
method=(method) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] method Object to be assigned

# File lib/alfresco/models/request_facet_field.rb, line 189
def method=(method)
  validator = EnumAttributeValidator.new('String', ["ENUM", "FC"])
  unless validator.valid?(method)
    fail ArgumentError, "invalid value for 'method', must be one of #{validator.allowable_values}."
  end
  @method = method
end
sort=(sort) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] sort Object to be assigned

# File lib/alfresco/models/request_facet_field.rb, line 179
def sort=(sort)
  validator = EnumAttributeValidator.new('String', ["COUNT", "INDEX"])
  unless validator.valid?(sort)
    fail ArgumentError, "invalid value for 'sort', must be one of #{validator.allowable_values}."
  end
  @sort = sort
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_facet_field.rb, line 297
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_facet_field.rb, line 303
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_facet_field.rb, line 291
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_facet_field.rb, line 169
def valid?
  sort_validator = EnumAttributeValidator.new('String', ["COUNT", "INDEX"])
  return false unless sort_validator.valid?(@sort)
  method_validator = EnumAttributeValidator.new('String', ["ENUM", "FC"])
  return false unless method_validator.valid?(@method)
  return true
end