Class: CloudmersiveOcrApiClient::FormFieldDefinition

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

Overview

Definition of a form field for OCR data extraction from images

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormFieldDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 118

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

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

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

  if attributes.has_key?(:'BottomAnchor')
    self.bottom_anchor = attributes[:'BottomAnchor']
  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?(:'TargetDigitCount')
    self.target_digit_count = attributes[:'TargetDigitCount']
  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

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

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

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

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

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

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

  if attributes.has_key?(:'Ignore')
    if (value = attributes[:'Ignore']).is_a?(Array)
      self.ignore = value
    end
  end

  if attributes.has_key?(:'Options')
    self.options = attributes[:'Options']
  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



43
44
45
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 43

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) and Horizontal (anchor must be laid out horizontally). Default is Partial.



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

def anchor_mode
  @anchor_mode
end

#bottom_anchor ⇒ Object

Optional - the bottom anchor of the field



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

def bottom_anchor
  @bottom_anchor
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)



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

def data_type
  @data_type
end

#field_id ⇒ Object

The identifier of the field; use this to identify which field is being referenced. Set to SkipField if you do not wish to return the value of this field in the result.



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

def field_id
  @field_id
end

#horizontal_alignment_type ⇒ Object

Horizontal alignment of target value area relative to the field anchor; Possible values are Left, Right



49
50
51
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 49

def horizontal_alignment_type
  @horizontal_alignment_type
end

#ignore ⇒ Object

Optional - Ignore any result items that contain a partial or complete match with these text strings



64
65
66
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 64

def ignore
  @ignore
end

#left_anchor ⇒ Object

Optional - the left-hand anchor of the field



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

def left_anchor
  @left_anchor
end

#minimum_character_count ⇒ Object

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



40
41
42
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 40

def minimum_character_count
  @minimum_character_count
end

#options ⇒ Object

Optional - additional options that can be set for this field definition, separated by commas. Possible values are AllowMultiMatch (allow the same anchor to be matched to multiple fields)



67
68
69
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 67

def options
  @options
end

#target_digit_count ⇒ Object

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



37
38
39
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 37

def target_digit_count
  @target_digit_count
end

#target_field_height_relative ⇒ Object

Optional - scale factor for target field height - relative to height of field title



55
56
57
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 55

def target_field_height_relative
  @target_field_height_relative
end

#target_field_horizontal_adjustment ⇒ Object

Optional - horizontal adjestment in relative width of the field



58
59
60
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 58

def target_field_horizontal_adjustment
  @target_field_horizontal_adjustment
end

#target_field_vertical_adjustment ⇒ Object

Optional - vertical adjestment in relative height of the field



61
62
63
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 61

def target_field_vertical_adjustment
  @target_field_vertical_adjustment
end

#target_field_width_relative ⇒ Object

Optional - scale factor for target field width - relative to width of field title; a value of 1.0 indicates the target value area has the same width as the field value as occurring in the image; a value of 2.0 would indicate that the target value area has 2 times the width of the field value as occurring in the image.



52
53
54
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 52

def target_field_width_relative
  @target_field_width_relative
end

#top_anchor ⇒ Object

Optional - the top anchor of the field



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

def top_anchor
  @top_anchor
end

#vertical_alignment_type ⇒ Object

Vertical alignment of target value area relative to the field anchor; Possible values are VCenter, Top, Bottom



46
47
48
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 46

def vertical_alignment_type
  @vertical_alignment_type
end

Class Method Details

.attribute_map ⇒ Object

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



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_field_definition.rb', line 71

def self.attribute_map
  {
    :'field_id' => :'FieldID',
    :'left_anchor' => :'LeftAnchor',
    :'top_anchor' => :'TopAnchor',
    :'bottom_anchor' => :'BottomAnchor',
    :'anchor_mode' => :'AnchorMode',
    :'data_type' => :'DataType',
    :'target_digit_count' => :'TargetDigitCount',
    :'minimum_character_count' => :'MinimumCharacterCount',
    :'allow_numeric_digits' => :'AllowNumericDigits',
    :'vertical_alignment_type' => :'VerticalAlignmentType',
    :'horizontal_alignment_type' => :'HorizontalAlignmentType',
    :'target_field_width_relative' => :'TargetFieldWidth_Relative',
    :'target_field_height_relative' => :'TargetFieldHeight_Relative',
    :'target_field_horizontal_adjustment' => :'TargetFieldHorizontalAdjustment',
    :'target_field_vertical_adjustment' => :'TargetFieldVerticalAdjustment',
    :'ignore' => :'Ignore',
    :'options' => :'Options'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 94

def self.swagger_types
  {
    :'field_id' => :'String',
    :'left_anchor' => :'String',
    :'top_anchor' => :'String',
    :'bottom_anchor' => :'String',
    :'anchor_mode' => :'String',
    :'data_type' => :'String',
    :'target_digit_count' => :'Integer',
    :'minimum_character_count' => :'Integer',
    :'allow_numeric_digits' => :'BOOLEAN',
    :'vertical_alignment_type' => :'String',
    :'horizontal_alignment_type' => :'String',
    :'target_field_width_relative' => :'Float',
    :'target_field_height_relative' => :'Float',
    :'target_field_horizontal_adjustment' => :'Float',
    :'target_field_vertical_adjustment' => :'Float',
    :'ignore' => :'Array<String>',
    :'options' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      field_id == o.field_id &&
      left_anchor == o.left_anchor &&
      top_anchor == o.top_anchor &&
      bottom_anchor == o.bottom_anchor &&
      anchor_mode == o.anchor_mode &&
      data_type == o.data_type &&
      target_digit_count == o.target_digit_count &&
      minimum_character_count == o.minimum_character_count &&
      allow_numeric_digits == o.allow_numeric_digits &&
      vertical_alignment_type == o.vertical_alignment_type &&
      horizontal_alignment_type == o.horizontal_alignment_type &&
      target_field_width_relative == o.target_field_width_relative &&
      target_field_height_relative == o.target_field_height_relative &&
      target_field_horizontal_adjustment == o.target_field_horizontal_adjustment &&
      target_field_vertical_adjustment == o.target_field_vertical_adjustment &&
      ignore == o.ignore &&
      options == o.options
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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 269

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 335

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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 248

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


235
236
237
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 241

def hash
  [field_id, left_anchor, top_anchor, bottom_anchor, anchor_mode, data_type, target_digit_count, minimum_character_count, allow_numeric_digits, vertical_alignment_type, horizontal_alignment_type, target_field_width_relative, target_field_height_relative, target_field_horizontal_adjustment, target_field_vertical_adjustment, ignore, options].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



198
199
200
201
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 198

def list_invalid_properties
  invalid_properties = Array.new
  return 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



315
316
317
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 315

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



321
322
323
324
325
326
327
328
329
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 321

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



309
310
311
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 309

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



205
206
207
 
# File 'lib/cloudmersive-ocr-api-client/models/form_field_definition.rb', line 205

def valid?
  return true
end