Class Paragraph (3.4.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

Implements

ParagraphOrBuilder

Static Fields

BOUNDING_BOX_FIELD_NUMBER

public static final int BOUNDING_BOX_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
TypeDescription
int

PROPERTY_FIELD_NUMBER

public static final int PROPERTY_FIELD_NUMBER
Field Value
TypeDescription
int

WORDS_FIELD_NUMBER

public static final int WORDS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Paragraph getDefaultInstance()
Returns
TypeDescription
Paragraph

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Paragraph.Builder newBuilder()
Returns
TypeDescription
Paragraph.Builder

newBuilder(Paragraph prototype)

public static Paragraph.Builder newBuilder(Paragraph prototype)
Parameter
NameDescription
prototypeParagraph
Returns
TypeDescription
Paragraph.Builder

parseDelimitedFrom(InputStream input)

public static Paragraph parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Paragraph
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Paragraph parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Paragraph
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Paragraph parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Paragraph
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Paragraph parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Paragraph
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Paragraph parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Paragraph
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Paragraph parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Paragraph
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Paragraph parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Paragraph
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Paragraph parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Paragraph
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Paragraph parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Paragraph
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Paragraph parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Paragraph
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Paragraph parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Paragraph
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Paragraph parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Paragraph
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Paragraph> parser()
Returns
TypeDescription
Parser<Paragraph>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
BoundingPolyOrBuilder

getConfidence()

public float getConfidence()

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

float confidence = 4;

Returns
TypeDescription
float

The confidence.

getDefaultInstanceForType()

public Paragraph getDefaultInstanceForType()
Returns
TypeDescription
Paragraph

getParserForType()

public Parser<Paragraph> getParserForType()
Returns
TypeDescription
Parser<Paragraph>
Overrides

getProperty()

public TextAnnotation.TextProperty getProperty()

Additional information detected for the paragraph.

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

Returns
TypeDescription
TextAnnotation.TextProperty

The property.

getPropertyOrBuilder()

public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()

Additional information detected for the paragraph.

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

Returns
TypeDescription
TextAnnotation.TextPropertyOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
NameDescription
indexint
Returns
TypeDescription
Word

getWordsCount()

public int getWordsCount()

List of all words in this paragraph.

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

Returns
TypeDescription
int

getWordsList()

public List<Word> getWordsList()

List of all words in this paragraph.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
WordOrBuilder

getWordsOrBuilderList()

public List<? extends WordOrBuilder> getWordsOrBuilderList()

List of all words in this paragraph.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the property field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Paragraph.Builder newBuilderForType()
Returns
TypeDescription
Paragraph.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Paragraph.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Paragraph.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Paragraph.Builder toBuilder()
Returns
TypeDescription
Paragraph.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException