com.google.api.services.vision.v1.model

Class Symbol

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.vision.v1.model.Symbol

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Symbol
extends com.google.api.client.json.GenericJson

A single symbol representation.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Vision API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Symbol()

Method Summary

Modifier and Type	Method and Description
Symbol	clone()
BoundingPoly	getBoundingBox() The bounding box for the symbol.
Float	getConfidence() Confidence of the OCR results for the symbol.
TextProperty	getProperty() Additional information detected for the symbol.
String	getText() The actual UTF-8 representation of the symbol.
Symbol	set(String fieldName, Object value)
Symbol	setBoundingBox(BoundingPoly boundingBox) The bounding box for the symbol.
Symbol	setConfidence(Float confidence) Confidence of the OCR results for the symbol.
Symbol	setProperty(TextProperty property) Additional information detected for the symbol.
Symbol	setText(String text) The actual UTF-8 representation of the symbol.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Symbol

public Symbol()

Method Detail

getBoundingBox

public BoundingPoly getBoundingBox()

The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom- right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3 ----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3).

Returns:

value or null for none

setBoundingBox

public Symbol setBoundingBox(BoundingPoly boundingBox)

The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom- right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3 ----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3).

Parameters:

boundingBox - boundingBox or null for none

getConfidence

public Float getConfidence()

Confidence of the OCR results for the symbol. Range [0, 1].

Returns:

value or null for none

setConfidence

public Symbol setConfidence(Float confidence)

Confidence of the OCR results for the symbol. Range [0, 1].

Parameters:

confidence - confidence or null for none

getProperty

public TextProperty getProperty()

Additional information detected for the symbol.

Returns:

value or null for none

setProperty

public Symbol setProperty(TextProperty property)

Additional information detected for the symbol.

Parameters:

property - property or null for none

getText

public String getText()

The actual UTF-8 representation of the symbol.

Returns:

value or null for none

setText

public Symbol setText(String text)

The actual UTF-8 representation of the symbol.

Parameters:

text - text or null for none

set

public Symbol set(String fieldName,
                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Symbol clone()

Overrides:

clone in class com.google.api.client.json.GenericJson