Package com.oracle.bmc.aidocument.model

Class FieldValue

java.lang.Object

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

com.oracle.bmc.aidocument.model.FieldValue

Direct Known Subclasses:

ValueArray, ValueDate, ValueInteger, ValueNumber, ValuePhoneNumber, ValueString, ValueTime

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

The value of a form field.
Note: Objects should always be created or deserialized using the 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 Builder, which maintain a set of all explicitly set fields called 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	FieldValue.ValueType	The type of data detected.

Field Summary

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

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FieldValue(String text, Float confidence, BoundingPolygon boundingPolygon, List<Integer> wordIndexes, String normalizedValue, Float normalizedConfidence)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
BoundingPolygon	getBoundingPolygon()
Float	getConfidence()	The confidence score between 0 and 1.
Float	getNormalizedConfidence()	The normalized value confidence score between 0 and 1.
String	getNormalizedValue()	The normalized value.
String	getText()	The detected text of a field.
List<Integer>	getWordIndexes()	The indexes of the words in the field value.
int	hashCode()
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

FieldValue

@Deprecated
@ConstructorProperties({"text","confidence","boundingPolygon","wordIndexes","normalizedValue","normalizedConfidence"})
protected FieldValue(String text,
                     Float confidence,
                     BoundingPolygon boundingPolygon,
                     List<Integer> wordIndexes,
                     String normalizedValue,
                     Float normalizedConfidence)

Deprecated.

Method Detail

getText

public String getText()

The detected text of a field.

Returns:

the value

getConfidence

public Float getConfidence()

The confidence score between 0 and 1.

Returns:

the value

getBoundingPolygon

public BoundingPolygon getBoundingPolygon()

getWordIndexes

public List<Integer> getWordIndexes()

The indexes of the words in the field value.

Returns:

the value

getNormalizedValue

public String getNormalizedValue()

The normalized value.

Returns:

the value

getNormalizedConfidence

public Float getNormalizedConfidence()

The normalized value confidence score between 0 and 1.

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