Class: CloudmersiveOcrApiClient::FormTableColumnDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb

Overview

Definition of a column within a table for OCR data extraction from images

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormTableColumnDefinition

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 62

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?(:'ColumnID')
    self.column_id = attributes[:'ColumnID']
  end

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

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

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

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

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

Instance Attribute Details

#allow_numeric_digits ⇒ Object

Optional - set to false to block values that contain numeric digits, set to true to allow numeric digits



34
35
36
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 34

def allow_numeric_digits
  @allow_numeric_digits
end

#anchor_mode ⇒ Object

Optional - the matching mode for the anchor. Possible values are Complete (requires the entire anchor to match) and Partial (allows only part of the anchor to match). Default is Partial.



25
26
27
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 25

def anchor_mode
  @anchor_mode
end

#column_id ⇒ Object

The identifier of the field; use this to identify which field is being referenced



19
20
21
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 19

def column_id
  @column_id
end

#data_type ⇒ Object

The data type of the field; possible values are INTEGER (Integer value), STRING (Arbitrary string value, spaces are permitted), DATE (Date in a structured format), DECIMAL (Decimal number), ALPHANUMERIC (Continuous alphanumeric string with no spaces), STRINGNOWHITESPACE (A string that contains no whitespace characters), SERIALNUMBER (A serial-number style string that contains letters and numbers, and certain symbols; must contain at least one number), ALPHAONLY (Alphabet characters only, no numbers or symbols or whitespace)



28
29
30
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 28

def data_type
  @data_type
end

#minimum_character_count ⇒ Object

Optional - the target number of digits in the field; useful for fixed-length fields



31
32
33
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 31

def minimum_character_count
  @minimum_character_count
end

#top_anchor ⇒ Object

Optional - the top anchor of the column heading



22
23
24
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 22

def top_anchor
  @top_anchor
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 37

def self.attribute_map
  {
    :'column_id' => :'ColumnID',
    :'top_anchor' => :'TopAnchor',
    :'anchor_mode' => :'AnchorMode',
    :'data_type' => :'DataType',
    :'minimum_character_count' => :'MinimumCharacterCount',
    :'allow_numeric_digits' => :'AllowNumericDigits'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 49

def self.swagger_types
  {
    :'column_id' => :'String',
    :'top_anchor' => :'String',
    :'anchor_mode' => :'String',
    :'data_type' => :'String',
    :'minimum_character_count' => :'Integer',
    :'allow_numeric_digits' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 108

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      column_id == o.column_id &&
      top_anchor == o.top_anchor &&
      anchor_mode == o.anchor_mode &&
      data_type == o.data_type &&
      minimum_character_count == o.minimum_character_count &&
      allow_numeric_digits == o.allow_numeric_digits
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 155

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 221

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 134

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


121
122
123
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 121

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



127
128
129
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 127

def hash
  [column_id, top_anchor, anchor_mode, data_type, minimum_character_count, allow_numeric_digits].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



95
96
97
98
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 95

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



201
202
203
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 201

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



207
208
209
210
211
212
213
214
215
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 207

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

Returns:

  • (String) —

    String presentation of the object



195
196
197
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 195

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



102
103
104
 
# File 'lib/cloudmersive-ocr-api-client/models/form_table_column_definition.rb', line 102

def valid?
  true
end