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

Class Word

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.Word

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A word 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
Word()

Method Summary

Modifier and Type	Method and Description
Word	clone()
BoundingPoly	getBoundingBox() The bounding box for the word.
Float	getConfidence() Confidence of the OCR results for the word.
TextProperty	getProperty() Additional information detected for the word.
List<Symbol>	getSymbols() List of symbols in the word.
Word	set(String fieldName, Object value)
Word	setBoundingBox(BoundingPoly boundingBox) The bounding box for the word.
Word	setConfidence(Float confidence) Confidence of the OCR results for the word.
Word	setProperty(TextProperty property) Additional information detected for the word.
Word	setSymbols(List<Symbol> symbols) List of symbols in the word.

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

Word

public Word()

Method Detail

getBoundingBox

public BoundingPoly getBoundingBox()

The bounding box for the word. 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 vertex order will still be (0, 1, 2, 3).

Returns:

value or null for none

setBoundingBox

public Word setBoundingBox(BoundingPoly boundingBox)

The bounding box for the word. 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 vertex 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 word. Range [0, 1].

Returns:

value or null for none

setConfidence

public Word setConfidence(Float confidence)

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

Parameters:

confidence - confidence or null for none

getProperty

public TextProperty getProperty()

Additional information detected for the word.

Returns:

value or null for none

setProperty

public Word setProperty(TextProperty property)

Additional information detected for the word.

Parameters:

property - property or null for none

getSymbols

public List<Symbol> getSymbols()

List of symbols in the word. The order of the symbols follows the natural reading order.

Returns:

value or null for none

setSymbols

public Word setSymbols(List<Symbol> symbols)

List of symbols in the word. The order of the symbols follows the natural reading order.

Parameters:

symbols - symbols or null for none

set

public Word set(String fieldName,
                Object value)

Overrides:

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

clone

public Word clone()

Overrides:

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