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

Class Block

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Logical element on the page.

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

Method Summary

Modifier and Type	Method and Description
Block	clone()
String	getBlockType() Detected block type (text, image etc) for this block.
BoundingPoly	getBoundingBox() The bounding box for the block.
Float	getConfidence() Confidence of the OCR results on the block.
List<Paragraph>	getParagraphs() List of paragraphs in this block (if this blocks is of type text).
TextProperty	getProperty() Additional information detected for the block.
Block	set(String fieldName, Object value)
Block	setBlockType(String blockType) Detected block type (text, image etc) for this block.
Block	setBoundingBox(BoundingPoly boundingBox) The bounding box for the block.
Block	setConfidence(Float confidence) Confidence of the OCR results on the block.
Block	setParagraphs(List<Paragraph> paragraphs) List of paragraphs in this block (if this blocks is of type text).
Block	setProperty(TextProperty property) Additional information detected for the block.

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

Block

public Block()

Method Detail

getBlockType

public String getBlockType()

Detected block type (text, image etc) for this block.

Returns:

value or null for none

setBlockType

public Block setBlockType(String blockType)

Detected block type (text, image etc) for this block.

Parameters:

blockType - blockType or null for none

getBoundingBox

public BoundingPoly getBoundingBox()

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

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

Returns:

value or null for none

setConfidence

public Block setConfidence(Float confidence)

Confidence of the OCR results on the block. Range [0, 1].

Parameters:

confidence - confidence or null for none

getParagraphs

public List<Paragraph> getParagraphs()

List of paragraphs in this block (if this blocks is of type text).

Returns:

value or null for none

setParagraphs

public Block setParagraphs(List<Paragraph> paragraphs)

List of paragraphs in this block (if this blocks is of type text).

Parameters:

paragraphs - paragraphs or null for none

getProperty

public TextProperty getProperty()

Additional information detected for the block.

Returns:

value or null for none

setProperty

public Block setProperty(TextProperty property)

Additional information detected for the block.

Parameters:

property - property or null for none

set

public Block set(String fieldName,
                 Object value)

Overrides:

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

clone

public Block clone()

Overrides:

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