Package com.oracle.bmc.aidocument.model

Class Page

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.aidocument.model.Page

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20221109")
public final class Page
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

One page document analysis result.
Note: Objects should always be created or deserialized using the Page.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Page.Builder, which maintain a set of all explicitly set fields called Page.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Page.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
Page(Integer pageNumber, Dimensions dimensions, List<DetectedDocumentType> detectedDocumentTypes, List<DetectedLanguage> detectedLanguages, List<Word> words, List<Line> lines, List<Table> tables, List<DocumentField> documentFields, List<Signature> signatures, List<BarCode> barCodes, List<SelectionMark> selectionMarks)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Page.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<BarCode>	getBarCodes()	The bar codes detected on the page.
List<DetectedDocumentType>	getDetectedDocumentTypes()	An array of detected document types.
List<DetectedLanguage>	getDetectedLanguages()	An array of detected languages.
Dimensions	getDimensions()
List<DocumentField>	getDocumentFields()	The form fields detected on the page.
List<Line>	getLines()	The lines of text detected on the page.
Integer	getPageNumber()	The document page number.
List<SelectionMark>	getSelectionMarks()	The checkboxes and selection marks detected on the page.
List<Signature>	getSignatures()	The signatures detected on the page.
List<Table>	getTables()	The tables detected on the page.
List<Word>	getWords()	The words detected on the page.
int	hashCode()
Page.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Page

@Deprecated
@ConstructorProperties({"pageNumber","dimensions","detectedDocumentTypes","detectedLanguages","words","lines","tables","documentFields","signatures","barCodes","selectionMarks"})
public Page(Integer pageNumber,
            Dimensions dimensions,
            List<DetectedDocumentType> detectedDocumentTypes,
            List<DetectedLanguage> detectedLanguages,
            List<Word> words,
            List<Line> lines,
            List<Table> tables,
            List<DocumentField> documentFields,
            List<Signature> signatures,
            List<BarCode> barCodes,
            List<SelectionMark> selectionMarks)

Deprecated.

Method Detail

builder

public static Page.Builder builder()

Create a new builder.

toBuilder

public Page.Builder toBuilder()

getPageNumber

public Integer getPageNumber()

The document page number.

Returns:

the value

getDimensions

public Dimensions getDimensions()

getDetectedDocumentTypes

public List<DetectedDocumentType> getDetectedDocumentTypes()

An array of detected document types.

Returns:

the value

getDetectedLanguages

public List<DetectedLanguage> getDetectedLanguages()

An array of detected languages.

Returns:

the value

getWords

public List<Word> getWords()

The words detected on the page.

Returns:

the value

getLines

public List<Line> getLines()

The lines of text detected on the page.

Returns:

the value

getTables

public List<Table> getTables()

The tables detected on the page.

Returns:

the value

getDocumentFields

public List<DocumentField> getDocumentFields()

The form fields detected on the page.

Returns:

the value

getSignatures

public List<Signature> getSignatures()

The signatures detected on the page.

Returns:

the value

getBarCodes

public List<BarCode> getBarCodes()

The bar codes detected on the page.

Returns:

the value

getSelectionMarks

public List<SelectionMark> getSelectionMarks()

The checkboxes and selection marks detected on the page.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel