class CloudmersiveOcrApiClient::FormFieldDefinition

Definition of a form field for OCR data extraction from images

Attributes

allow_numeric_digits[RW]

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

alternate_anchor[RW]

Optional - alterate match text for the specified anchor

anchor_mode[RW]

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.

bottom_anchor[RW]

Optional - the bottom anchor of the field

data_type[RW]

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)

field_id[RW]

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.

horizontal_alignment_type[RW]

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

ignore[RW]

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

left_anchor[RW]

Optional - the left-hand anchor of the field

minimum_character_count[RW]

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

options[RW]

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)

target_digit_count[RW]

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

target_field_height_relative[RW]

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

target_field_horizontal_adjustment[RW]

Optional - horizontal adjestment in relative width of the field

target_field_vertical_adjustment[RW]

Optional - vertical adjestment in relative height of the field

target_field_width_relative[RW]

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.

top_anchor[RW]

Optional - the top anchor of the field

vertical_alignment_type[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 73
def self.attribute_map
  {
    :'field_id' => :'FieldID',
    :'left_anchor' => :'LeftAnchor',
    :'top_anchor' => :'TopAnchor',
    :'bottom_anchor' => :'BottomAnchor',
    :'alternate_anchor' => :'AlternateAnchor',
    :'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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 122
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?(:'AlternateAnchor')
    self.alternate_anchor = attributes[:'AlternateAnchor']
  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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 97
def self.swagger_types
  {
    :'field_id' => :'String',
    :'left_anchor' => :'String',
    :'top_anchor' => :'String',
    :'bottom_anchor' => :'String',
    :'alternate_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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 218
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 &&
      alternate_anchor == o.alternate_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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 277
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) click to toggle source

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/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 343
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 256
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 243
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 249
def hash
  [field_id, left_anchor, top_anchor, bottom_anchor, alternate_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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 205
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 323
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 329
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 317
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cloudmersive-ocr-api-client/models/form_field_definition.rb, line 212
def valid?
  true
end