Class Paragraph (3.42.0)

public final class Paragraph extends GeneratedMessageV3 implements ParagraphOrBuilder

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

Protobuf type google.cloud.vision.v1.Paragraph

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Paragraph

Implements

ParagraphOrBuilder

Static Fields

BOUNDING_BOX_FIELD_NUMBER

public static final int BOUNDING_BOX_FIELD_NUMBER
Field Value
Type Description
int

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
Type Description
int

PROPERTY_FIELD_NUMBER

public static final int PROPERTY_FIELD_NUMBER
Field Value
Type Description
int

WORDS_FIELD_NUMBER

public static final int WORDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Paragraph getDefaultInstance()
Returns
Type Description
Paragraph

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Paragraph.Builder newBuilder()
Returns
Type Description
Paragraph.Builder

newBuilder(Paragraph prototype)

public static Paragraph.Builder newBuilder(Paragraph prototype)
Parameter
Name Description
prototype Paragraph
Returns
Type Description
Paragraph.Builder

parseDelimitedFrom(InputStream input)

public static Paragraph parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Paragraph
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Paragraph parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Paragraph
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Paragraph parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Paragraph
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Paragraph parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Paragraph
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Paragraph parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Paragraph
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Paragraph parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Paragraph
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Paragraph parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Paragraph
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Paragraph parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Paragraph
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Paragraph parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Paragraph
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Paragraph parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Paragraph
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Paragraph parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Paragraph
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Paragraph parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Paragraph
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Paragraph> parser()
Returns
Type Description
Parser<Paragraph>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
Type Description
BoundingPoly

The boundingBox.

getBoundingBoxOrBuilder()

public BoundingPolyOrBuilder getBoundingBoxOrBuilder()

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

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
Type Description
BoundingPolyOrBuilder

getConfidence()

public float getConfidence()

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

float confidence = 4;

Returns
Type Description
float

The confidence.

getDefaultInstanceForType()

public Paragraph getDefaultInstanceForType()
Returns
Type Description
Paragraph

getParserForType()

public Parser<Paragraph> getParserForType()
Returns
Type Description
Parser<Paragraph>
Overrides

getProperty()

public TextAnnotation.TextProperty getProperty()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
Type Description
TextAnnotation.TextProperty

The property.

getPropertyOrBuilder()

public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
Type Description
TextAnnotation.TextPropertyOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getWords(int index)

public Word getWords(int index)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
Name Description
index int
Returns
Type Description
Word

getWordsCount()

public int getWordsCount()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
Type Description
int

getWordsList()

public List<Word> getWordsList()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
Type Description
List<Word>

getWordsOrBuilder(int index)

public WordOrBuilder getWordsOrBuilder(int index)

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Parameter
Name Description
index int
Returns
Type Description
WordOrBuilder

getWordsOrBuilderList()

public List<? extends WordOrBuilder> getWordsOrBuilderList()

List of all words in this paragraph.

repeated .google.cloud.vision.v1.Word words = 3;

Returns
Type Description
List<? extends com.google.cloud.vision.v1.WordOrBuilder>

hasBoundingBox()

public boolean hasBoundingBox()

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

.google.cloud.vision.v1.BoundingPoly bounding_box = 2;

Returns
Type Description
boolean

Whether the boundingBox field is set.

hasProperty()

public boolean hasProperty()

Additional information detected for the paragraph.

.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;

Returns
Type Description
boolean

Whether the property field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Paragraph.Builder newBuilderForType()
Returns
Type Description
Paragraph.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Paragraph.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Paragraph.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Paragraph.Builder toBuilder()
Returns
Type Description
Paragraph.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException