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

Class Paragraph

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Structural unit of text representing a number of words in certain order.

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
Paragraph()

Method Summary

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

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

Paragraph

public Paragraph()

Method Detail

getBoundingBox

public BoundingPoly getBoundingBox()

The bounding box for the paragraph. 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 Paragraph setBoundingBox(BoundingPoly boundingBox)

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

Returns:

value or null for none

setConfidence

public Paragraph setConfidence(Float confidence)

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

Parameters:

confidence - confidence or null for none

getProperty

public TextProperty getProperty()

Additional information detected for the paragraph.

Returns:

value or null for none

setProperty

public Paragraph setProperty(TextProperty property)

Additional information detected for the paragraph.

Parameters:

property - property or null for none

getWords

public List<Word> getWords()

List of words in this paragraph.

Returns:

value or null for none

setWords

public Paragraph setWords(List<Word> words)

List of words in this paragraph.

Parameters:

words - words or null for none

set

public Paragraph set(String fieldName,
                     Object value)

Overrides:

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

clone

public Paragraph clone()

Overrides:

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