Class: CloudmersiveOcrApiClient::FormTableDefinition
- Inherits:
-
Object
- Object
- CloudmersiveOcrApiClient::FormTableDefinition
- Defined in:
- lib/cloudmersive-ocr-api-client/models/form_table_definition.rb
Overview
Definition of a form table for OCR data extraction from images
Instance Attribute Summary collapse
-
#column_definitions ⇒ Object
Definition of the columns in the table.
-
#table_id ⇒ Object
Optional; the ID of the table.
-
#target_row_height_relative ⇒ Object
Optional - scale factor for target row height - relative to height of column header.
-
#target_table_height_relative ⇒ Object
Optional - scale factor for target table height - relative to maximum height of headers of columns.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ FormTableDefinition
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ FormTableDefinition
Initializes the object
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 52 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?(:'TableID') self.table_id = attributes[:'TableID'] end if attributes.has_key?(:'ColumnDefinitions') if (value = attributes[:'ColumnDefinitions']).is_a?(Array) self.column_definitions = value end end if attributes.has_key?(:'TargetTableHeight_Relative') self.target_table_height_relative = attributes[:'TargetTableHeight_Relative'] end if attributes.has_key?(:'TargetRowHeight_Relative') self.target_row_height_relative = attributes[:'TargetRowHeight_Relative'] end end |
Instance Attribute Details
#column_definitions ⇒ Object
Definition of the columns in the table
22 23 24 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 22 def column_definitions @column_definitions end |
#table_id ⇒ Object
Optional; the ID of the table
19 20 21 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 19 def table_id @table_id end |
#target_row_height_relative ⇒ Object
Optional - scale factor for target row height - relative to height of column header
28 29 30 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 28 def target_row_height_relative @target_row_height_relative end |
#target_table_height_relative ⇒ Object
Optional - scale factor for target table height - relative to maximum height of headers of columns
25 26 27 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 25 def target_table_height_relative @target_table_height_relative end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
31 32 33 34 35 36 37 38 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 31 def self.attribute_map { :'table_id' => :'TableID', :'column_definitions' => :'ColumnDefinitions', :'target_table_height_relative' => :'TargetTableHeight_Relative', :'target_row_height_relative' => :'TargetRowHeight_Relative' } end |
.swagger_types ⇒ Object
Attribute type mapping.
41 42 43 44 45 46 47 48 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 41 def self.swagger_types { :'table_id' => :'String', :'column_definitions' => :'Array<FormTableColumnDefinition>', :'target_table_height_relative' => :'Float', :'target_row_height_relative' => :'Float' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
92 93 94 95 96 97 98 99 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 92 def ==(o) return true if self.equal?(o) self.class == o.class && table_id == o.table_id && column_definitions == o.column_definitions && target_table_height_relative == o.target_table_height_relative && target_row_height_relative == o.target_row_height_relative end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 137 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 = CloudmersiveOcrApiClient.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
203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 203 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
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 116 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 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
103 104 105 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 103 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
109 110 111 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 109 def hash [table_id, column_definitions, target_table_height_relative, target_row_height_relative].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
79 80 81 82 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 79 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
183 184 185 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 183 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
189 190 191 192 193 194 195 196 197 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 189 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
177 178 179 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 177 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
86 87 88 |
# File 'lib/cloudmersive-ocr-api-client/models/form_table_definition.rb', line 86 def valid? true end |