aspose_cells_cloud 24.10 → 24.12

data/lib/aspose_cells_cloud/models/extract_text_options.rb

@@ -0,0 +1,330 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+ <copyright company="Aspose" file="ExtractTextOptionsrb.cs">
+   Copyright (c) 2024 Aspose.Cells Cloud
+ </copyright>
+ <summary>
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+ </summary>
+--------------------------------------------------------------------------------------------------------------------
+=end
+
+
+require 'date'
+
+module AsposeCellsCloud
+
+  class ExtractTextOptions
+        #            
+        attr_accessor :name
+        #            
+        attr_accessor :data_source
+        #            
+        attr_accessor :file_info
+        #            
+        attr_accessor :worksheet
+        #            
+        attr_accessor :range
+        #            
+        attr_accessor :extract_text_type
+        #            
+        attr_accessor :before_text
+        #            
+        attr_accessor :after_text
+        #            
+        attr_accessor :before_position
+        #            
+        attr_accessor :after_position
+        #            
+        attr_accessor :out_position_range
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'Name',
+        :'data_source' => :'DataSource',
+        :'file_info' => :'FileInfo',
+        :'worksheet' => :'Worksheet',
+        :'range' => :'Range',
+        :'extract_text_type' => :'ExtractTextType',
+        :'before_text' => :'BeforeText',
+        :'after_text' => :'AfterText',
+        :'before_position' => :'BeforePosition',
+        :'after_position' => :'AfterPosition',
+        :'out_position_range' => :'OutPositionRange'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'data_source' => :'DataSource',
+        :'file_info' => :'FileInfo',
+        :'worksheet' => :'String',
+        :'range' => :'String',
+        :'extract_text_type' => :'String',
+        :'before_text' => :'String',
+        :'after_text' => :'String',
+        :'before_position' => :'Integer',
+        :'after_position' => :'Integer',
+        :'out_position_range' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'Name')
+          self.name = attributes[:'Name']
+      end
+      if attributes.has_key?(:'DataSource')
+          self.data_source = attributes[:'DataSource']
+      end
+      if attributes.has_key?(:'FileInfo')
+          self.file_info = attributes[:'FileInfo']
+      end
+      if attributes.has_key?(:'Worksheet')
+          self.worksheet = attributes[:'Worksheet']
+      end
+      if attributes.has_key?(:'Range')
+          self.range = attributes[:'Range']
+      end
+      if attributes.has_key?(:'ExtractTextType')
+          self.extract_text_type = attributes[:'ExtractTextType']
+      end
+      if attributes.has_key?(:'BeforeText')
+          self.before_text = attributes[:'BeforeText']
+      end
+      if attributes.has_key?(:'AfterText')
+          self.after_text = attributes[:'AfterText']
+      end
+      if attributes.has_key?(:'BeforePosition')
+          self.before_position = attributes[:'BeforePosition']
+      end
+      if attributes.has_key?(:'AfterPosition')
+          self.after_position = attributes[:'AfterPosition']
+      end
+      if attributes.has_key?(:'OutPositionRange')
+          self.out_position_range = attributes[:'OutPositionRange']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @name.nil?
+          invalid_properties.push("invalid value for 'name', name cannot be nil.")
+      end
+      if @data_source.nil?
+          invalid_properties.push("invalid value for 'data_source', data_source cannot be nil.")
+      end
+      if @file_info.nil?
+          invalid_properties.push("invalid value for 'file_info', file_info cannot be nil.")
+      end
+      if @worksheet.nil?
+          invalid_properties.push("invalid value for 'worksheet', worksheet cannot be nil.")
+      end
+      if @range.nil?
+          invalid_properties.push("invalid value for 'range', range cannot be nil.")
+      end
+      if @extract_text_type.nil?
+          invalid_properties.push("invalid value for 'extract_text_type', extract_text_type cannot be nil.")
+      end
+      if @before_text.nil?
+          invalid_properties.push("invalid value for 'before_text', before_text cannot be nil.")
+      end
+      if @after_text.nil?
+          invalid_properties.push("invalid value for 'after_text', after_text cannot be nil.")
+      end
+      if @before_position.nil?
+          invalid_properties.push("invalid value for 'before_position', before_position cannot be nil.")
+      end
+      if @after_position.nil?
+          invalid_properties.push("invalid value for 'after_position', after_position cannot be nil.")
+      end
+      if @out_position_range.nil?
+          invalid_properties.push("invalid value for 'out_position_range', out_position_range cannot be nil.")
+      end
+
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @name.nil?
+      return false if @data_source.nil?
+      return false if @file_info.nil?
+      return false if @worksheet.nil?
+      return false if @range.nil?
+      return false if @extract_text_type.nil?
+      return false if @before_text.nil?
+      return false if @after_text.nil?
+      return false if @before_position.nil?
+      return false if @after_position.nil?
+      return false if @out_position_range.nil?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          name == o.name &&
+          data_source == o.data_source &&
+          file_info == o.file_info &&
+          worksheet == o.worksheet &&
+          range == o.range &&
+          extract_text_type == o.extract_text_type &&
+          before_text == o.before_text &&
+          after_text == o.after_text &&
+          before_position == o.before_position &&
+          after_position == o.after_position &&
+          out_position_range == o.out_position_range 
+          std_dev == o.std_dev
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [ name , data_source , file_info , worksheet , range , extract_text_type , before_text , after_text , before_position , after_position , out_position_range ].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+
+end

data/lib/aspose_cells_cloud/models/pivot_filter.rb

@@ -40,7 +40,7 @@ module AsposeCellsCloud
         #Gets the autofilter type of the pivot filter.            
         attr_accessor :filter_type
         #Gets the measure field index of the pivot filter.                        
-        attr_accessor :measure_fld_index
+        attr_accessor :value_field_index
         #Gets the member property field index of the pivot filter.                        
         attr_accessor :member_property_field_index
         #Gets the name of the pivot filter.            
@@ -49,6 +49,8 @@ module AsposeCellsCloud
         attr_accessor :value1
         #Gets the string value2 of the label pivot filter.                        
         attr_accessor :value2
+        #            
+        attr_accessor :top10_filter
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -57,11 +59,12 @@ module AsposeCellsCloud
         :'evaluation_order' => :'EvaluationOrder',
         :'field_index' => :'FieldIndex',
         :'filter_type' => :'FilterType',
-        :'measure_fld_index' => :'MeasureFldIndex',
+        :'value_field_index' => :'ValueFieldIndex',
         :'member_property_field_index' => :'MemberPropertyFieldIndex',
         :'name' => :'Name',
         :'value1' => :'Value1',
-        :'value2' => :'Value2'
+        :'value2' => :'Value2',
+        :'top10_filter' => :'Top10Filter'
       }
     end
 
@@ -72,11 +75,12 @@ module AsposeCellsCloud
         :'evaluation_order' => :'Integer',
         :'field_index' => :'Integer',
         :'filter_type' => :'String',
-        :'measure_fld_index' => :'Integer',
+        :'value_field_index' => :'Integer',
         :'member_property_field_index' => :'Integer',
         :'name' => :'String',
         :'value1' => :'String',
-        :'value2' => :'String'
+        :'value2' => :'String',
+        :'top10_filter' => :'Top10Filter'
       }
     end
 
@@ -100,8 +104,8 @@ module AsposeCellsCloud
       if attributes.has_key?(:'FilterType')
           self.filter_type = attributes[:'FilterType']
       end
-      if attributes.has_key?(:'MeasureFldIndex')
-          self.measure_fld_index = attributes[:'MeasureFldIndex']
+      if attributes.has_key?(:'ValueFieldIndex')
+          self.value_field_index = attributes[:'ValueFieldIndex']
       end
       if attributes.has_key?(:'MemberPropertyFieldIndex')
           self.member_property_field_index = attributes[:'MemberPropertyFieldIndex']
@@ -115,6 +119,9 @@ module AsposeCellsCloud
       if attributes.has_key?(:'Value2')
           self.value2 = attributes[:'Value2']
       end
+      if attributes.has_key?(:'Top10Filter')
+          self.top10_filter = attributes[:'Top10Filter']
+      end
 
     end
 
@@ -134,8 +141,8 @@ module AsposeCellsCloud
       if @filter_type.nil?
           invalid_properties.push("invalid value for 'filter_type', filter_type cannot be nil.")
       end
-      if @measure_fld_index.nil?
-          invalid_properties.push("invalid value for 'measure_fld_index', measure_fld_index cannot be nil.")
+      if @value_field_index.nil?
+          invalid_properties.push("invalid value for 'value_field_index', value_field_index cannot be nil.")
       end
       if @member_property_field_index.nil?
           invalid_properties.push("invalid value for 'member_property_field_index', member_property_field_index cannot be nil.")
@@ -149,6 +156,9 @@ module AsposeCellsCloud
       if @value2.nil?
           invalid_properties.push("invalid value for 'value2', value2 cannot be nil.")
       end
+      if @top10_filter.nil?
+          invalid_properties.push("invalid value for 'top10_filter', top10_filter cannot be nil.")
+      end
 
       return invalid_properties
     end
@@ -160,11 +170,12 @@ module AsposeCellsCloud
       return false if @evaluation_order.nil?
       return false if @field_index.nil?
       return false if @filter_type.nil?
-      return false if @measure_fld_index.nil?
+      return false if @value_field_index.nil?
       return false if @member_property_field_index.nil?
       return false if @name.nil?
       return false if @value1.nil?
       return false if @value2.nil?
+      return false if @top10_filter.nil?
       return true
     end
 
@@ -177,11 +188,12 @@ module AsposeCellsCloud
           evaluation_order == o.evaluation_order &&
           field_index == o.field_index &&
           filter_type == o.filter_type &&
-          measure_fld_index == o.measure_fld_index &&
+          value_field_index == o.value_field_index &&
           member_property_field_index == o.member_property_field_index &&
           name == o.name &&
           value1 == o.value1 &&
-          value2 == o.value2 
+          value2 == o.value2 &&
+          top10_filter == o.top10_filter 
           std_dev == o.std_dev
     end
 
@@ -194,7 +206,7 @@ module AsposeCellsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [ auto_filter , evaluation_order , field_index , filter_type , measure_fld_index , member_property_field_index , name , value1 , value2 ].hash
+      [ auto_filter , evaluation_order , field_index , filter_type , value_field_index , member_property_field_index , name , value1 , value2 , top10_filter ].hash
     end
 
     # Builds the object from hash