class CloudmersiveOcrApiClient::OcrWordElement

A single word in an OCR document

Attributes

block_number[RW]

Index of the containing block

confidence_level[RW]

Confidence level of the machine learning result; possible values are 0.0 (lowest accuracy) - 1.0 (highest accuracy)

height[RW]

Height of the word in pixels

line_number[RW]

Line number of the word

page_number[RW]

Index of the containing page

paragraph_number[RW]

Index of the containing paragraph

width[RW]

Width of the word in pixels

word_number[RW]

Index of the word in the line

word_text[RW]

Text of the word

x_left[RW]

X location of the left edge of the word in pixels

y_top[RW]

Y location of the top edge of the word in pixels

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/ocr_word_element.rb, line 52
def self.attribute_map
  {
    :'word_text' => :'WordText',
    :'line_number' => :'LineNumber',
    :'word_number' => :'WordNumber',
    :'x_left' => :'XLeft',
    :'y_top' => :'YTop',
    :'width' => :'Width',
    :'height' => :'Height',
    :'confidence_level' => :'ConfidenceLevel',
    :'block_number' => :'BlockNumber',
    :'paragraph_number' => :'ParagraphNumber',
    :'page_number' => :'PageNumber'
  }
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/ocr_word_element.rb, line 87
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?(:'WordText')
    self.word_text = attributes[:'WordText']
  end

  if attributes.has_key?(:'LineNumber')
    self.line_number = attributes[:'LineNumber']
  end

  if attributes.has_key?(:'WordNumber')
    self.word_number = attributes[:'WordNumber']
  end

  if attributes.has_key?(:'XLeft')
    self.x_left = attributes[:'XLeft']
  end

  if attributes.has_key?(:'YTop')
    self.y_top = attributes[:'YTop']
  end

  if attributes.has_key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.has_key?(:'Height')
    self.height = attributes[:'Height']
  end

  if attributes.has_key?(:'ConfidenceLevel')
    self.confidence_level = attributes[:'ConfidenceLevel']
  end

  if attributes.has_key?(:'BlockNumber')
    self.block_number = attributes[:'BlockNumber']
  end

  if attributes.has_key?(:'ParagraphNumber')
    self.paragraph_number = attributes[:'ParagraphNumber']
  end

  if attributes.has_key?(:'PageNumber')
    self.page_number = attributes[:'PageNumber']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb, line 69
def self.swagger_types
  {
    :'word_text' => :'String',
    :'line_number' => :'Integer',
    :'word_number' => :'Integer',
    :'x_left' => :'Integer',
    :'y_top' => :'Integer',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'confidence_level' => :'Float',
    :'block_number' => :'Integer',
    :'paragraph_number' => :'Integer',
    :'page_number' => :'Integer'
  }
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/ocr_word_element.rb, line 153
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      word_text == o.word_text &&
      line_number == o.line_number &&
      word_number == o.word_number &&
      x_left == o.x_left &&
      y_top == o.y_top &&
      width == o.width &&
      height == o.height &&
      confidence_level == o.confidence_level &&
      block_number == o.block_number &&
      paragraph_number == o.paragraph_number &&
      page_number == o.page_number
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/ocr_word_element.rb, line 205
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/ocr_word_element.rb, line 271
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/ocr_word_element.rb, line 184
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/ocr_word_element.rb, line 171
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/ocr_word_element.rb, line 177
def hash
  [word_text, line_number, word_number, x_left, y_top, width, height, confidence_level, block_number, paragraph_number, page_number].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/ocr_word_element.rb, line 140
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/ocr_word_element.rb, line 251
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/ocr_word_element.rb, line 257
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/ocr_word_element.rb, line 245
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/ocr_word_element.rb, line 147
def valid?
  true
end