class AsposeCellsCloud::SortKey
Attributes
Gets the sorted column index(absolute position, column A is 0, B is 1, …).
Represents the key of sorting.
Indicates the order of sorting.
Represents the order of sorting.
Represents the type of sorting.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/aspose_cells_cloud/models/sort_key.rb, line 48 def self.attribute_map { :'key' => :'Key', :'sort_order' => :'SortOrder', :'custom_list' => :'CustomList', :'order' => :'Order', :'index' => :'Index', :'type' => :'Type' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/aspose_cells_cloud/models/sort_key.rb, line 73 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?(:'Key') self.key = attributes[:'Key'] end if attributes.has_key?(:'SortOrder') self.sort_order = attributes[:'SortOrder'] end if attributes.has_key?(:'CustomList') self.custom_list = attributes[:'CustomList'] end if attributes.has_key?(:'Order') self.order = attributes[:'Order'] end if attributes.has_key?(:'Index') self.index = attributes[:'Index'] end if attributes.has_key?(:'Type') self.type = attributes[:'Type'] end end
Attribute type mapping.
# File lib/aspose_cells_cloud/models/sort_key.rb, line 60 def self.swagger_types { :'key' => :'Integer', :'sort_order' => :'String', :'custom_list' => :'Array<String>', :'order' => :'String', :'index' => :'Integer', :'type' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/aspose_cells_cloud/models/sort_key.rb, line 140 def ==(o) return true if self.equal?(o) self.class == o.class && key == o.key && sort_order == o.sort_order && custom_list == o.custom_list && order == o.order && index == o.index && type == o.type std_dev == o.std_dev end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/aspose_cells_cloud/models/sort_key.rb, line 188 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 = AsposeCellsCloud.const_get(type).new temp_model.build_from_hash(value) end end
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/aspose_cells_cloud/models/sort_key.rb, line 254 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/aspose_cells_cloud/models/sort_key.rb, line 167 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/aspose_cells_cloud/models/sort_key.rb, line 154 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose_cells_cloud/models/sort_key.rb, line 160 def hash [ key , sort_order , custom_list , order , index , type ].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/aspose_cells_cloud/models/sort_key.rb, line 102 def list_invalid_properties invalid_properties = Array.new if @key.nil? invalid_properties.push("invalid value for 'key', key cannot be nil.") end if @sort_order.nil? invalid_properties.push("invalid value for 'sort_order', sort_order cannot be nil.") end if @custom_list.nil? invalid_properties.push("invalid value for 'custom_list', custom_list cannot be nil.") end if @order.nil? invalid_properties.push("invalid value for 'order', order cannot be nil.") end if @index.nil? invalid_properties.push("invalid value for 'index', index cannot be nil.") end if @type.nil? invalid_properties.push("invalid value for 'type', type cannot be nil.") end return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/aspose_cells_cloud/models/sort_key.rb, line 240 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/aspose_cells_cloud/models/sort_key.rb, line 228 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/aspose_cells_cloud/models/sort_key.rb, line 128 def valid? return false if @key.nil? return false if @sort_order.nil? return false if @custom_list.nil? return false if @order.nil? return false if @index.nil? return false if @type.nil? return true end