Package com.google.cloud.vision.v1p2beta1

Class Word

  • All Implemented Interfaces:
    WordOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Word
extends com.google.protobuf.GeneratedMessageV3
implements WordOrBuilder
     A word representation.
    Protobuf type google.cloud.vision.v1p2beta1.Word
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Word.Builder
      A word representation.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int BOUNDING_BOX_FIELD_NUMBER  
      static int CONFIDENCE_FIELD_NUMBER  
      static int PROPERTY_FIELD_NUMBER  
      static int SYMBOLS_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasProperty

        public boolean hasProperty()
         Additional information detected for the word.
        .google.cloud.vision.v1p2beta1.TextAnnotation.TextProperty property = 1;
        Specified by:
        hasProperty in interface WordOrBuilder
        Returns:
        Whether the property field is set.

      • getProperty

        public TextAnnotation.TextProperty getProperty()
         Additional information detected for the word.
        .google.cloud.vision.v1p2beta1.TextAnnotation.TextProperty property = 1;
        Specified by:
        getProperty in interface WordOrBuilder
        Returns:
        The property.

      • hasBoundingBox

        public boolean hasBoundingBox()
         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 vertice order will still be (0, 1, 2, 3).
        .google.cloud.vision.v1p2beta1.BoundingPoly bounding_box = 2;
        Specified by:
        hasBoundingBox in interface WordOrBuilder
        Returns:
        Whether the boundingBox field is set.

      • 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 vertice order will still be (0, 1, 2, 3).
        .google.cloud.vision.v1p2beta1.BoundingPoly bounding_box = 2;
        Specified by:
        getBoundingBox in interface WordOrBuilder
        Returns:
        The boundingBox.

      • getBoundingBoxOrBuilder

        public BoundingPolyOrBuilder getBoundingBoxOrBuilder()
         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 vertice order will still be (0, 1, 2, 3).
        .google.cloud.vision.v1p2beta1.BoundingPoly bounding_box = 2;
        Specified by:
        getBoundingBoxOrBuilder in interface WordOrBuilder

      • getSymbolsList

        public List<Symbol> getSymbolsList()
         List of symbols in the word.
 The order of the symbols follows the natural reading order.
        repeated .google.cloud.vision.v1p2beta1.Symbol symbols = 3;
        Specified by:
        getSymbolsList in interface WordOrBuilder

      • getSymbolsOrBuilderList

        public List<? extends SymbolOrBuilder> getSymbolsOrBuilderList()
         List of symbols in the word.
 The order of the symbols follows the natural reading order.
        repeated .google.cloud.vision.v1p2beta1.Symbol symbols = 3;
        Specified by:
        getSymbolsOrBuilderList in interface WordOrBuilder

      • getSymbolsCount

        public int getSymbolsCount()
         List of symbols in the word.
 The order of the symbols follows the natural reading order.
        repeated .google.cloud.vision.v1p2beta1.Symbol symbols = 3;
        Specified by:
        getSymbolsCount in interface WordOrBuilder

      • getSymbols

        public Symbol getSymbols​(int index)
         List of symbols in the word.
 The order of the symbols follows the natural reading order.
        repeated .google.cloud.vision.v1p2beta1.Symbol symbols = 3;
        Specified by:
        getSymbols in interface WordOrBuilder

      • getSymbolsOrBuilder

        public SymbolOrBuilder getSymbolsOrBuilder​(int index)
         List of symbols in the word.
 The order of the symbols follows the natural reading order.
        repeated .google.cloud.vision.v1p2beta1.Symbol symbols = 3;
        Specified by:
        getSymbolsOrBuilder in interface WordOrBuilder

      • getConfidence

        public float getConfidence()
         Confidence of the OCR results for the word. Range [0, 1].
        float confidence = 4;
        Specified by:
        getConfidence in interface WordOrBuilder
        Returns:
        The confidence.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Word parseFrom​(ByteBuffer data)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Word parseFrom​(ByteBuffer data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Word parseFrom​(com.google.protobuf.ByteString data)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Word parseFrom​(com.google.protobuf.ByteString data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Word parseFrom​(byte[] data)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Word parseFrom​(byte[] data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Word parseFrom​(com.google.protobuf.CodedInputStream input,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Word.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Word.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Word.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Word getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Word> parser()

      • getParserForType

        public com.google.protobuf.Parser<Word> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Word getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder