com.azure.ai.formrecognizer.models

Class FieldValue

java.lang.Object

com.azure.ai.formrecognizer.models.FieldValue

public final class FieldValue
extends Object

Represents the strongly-typed value of a field recognized from the input document and provides methods for converting it to the appropriate type.

Constructor Summary

Constructors

Constructor and Description
FieldValue(Object value, FieldValueType valueType) Constructs a FieldValue object

Method Summary

Modifier and Type	Method and Description
String	asCountryRegion() Gets the value of the field as a country or region in the world.
LocalDate	asDate() Gets the value of the field as a LocalDate.
Float	asFloat() Gets the value of the field as a Float.
List<FormField>	asList() Gets the value of the field as a List.
Long	asLong() Gets the value of the field as a Long.
Map<String,FormField>	asMap() Gets the value of the field as a Map.
String	asPhoneNumber() Gets the value of the field as a phone number.
SelectionMarkState	asSelectionMarkState() Gets the value of the field as a selection mark state.
String	asString() Gets the value of the field as a String.
LocalTime	asTime() Gets the value of the field as a LocalTime.
FieldValueType	getValueType() Gets the type of the value of the field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldValue

public FieldValue(Object value,
                  FieldValueType valueType)

Constructs a FieldValue object

Parameters:

value - The actual value of the field.

valueType - The type of the field.

Method Detail

getValueType

public FieldValueType getValueType()

Gets the type of the value of the field.

Returns:

the type of the field.

asString

public String asString()

Gets the value of the field as a String.

Returns:

the value of the field as a String.

Throws:

UnsupportedOperationException - if FieldValue.getValueType() is not FieldValueType.STRING.

asLong

public Long asLong()

Gets the value of the field as a Long.

Returns:

the value of the field as a Long.

Throws:

UnsupportedOperationException - if FieldValue.getValueType() is not FieldValueType.LONG.

asFloat

public Float asFloat()

Gets the value of the field as a Float.

Returns:

the value of the field as a Float.

Throws:

UnsupportedOperationException - if FieldValue.getValueType() is not FieldValueType.FLOAT.

asDate

public LocalDate asDate()

Gets the value of the field as a LocalDate.

Returns:

the value of the field as a LocalDate.

Throws:

UnsupportedOperationException - if FieldValue.getValueType() is not FieldValueType.DATE.

asTime

public LocalTime asTime()

Gets the value of the field as a LocalTime.

Returns:

the value of the field as a LocalTime.

Throws:

UnsupportedOperationException - if FieldValue.getValueType() is not FieldValueType.TIME.

asPhoneNumber

public String asPhoneNumber()

Gets the value of the field as a phone number.

Returns:

the value of the field as a phone number.

Throws:

UnsupportedOperationException - if FieldValue.getValueType() is not FieldValueType.PHONE_NUMBER.

asList

public List<FormField> asList()

Gets the value of the field as a List.

Returns:

the value of the field as an unmodifiable List.

Throws:

UnsupportedOperationException - if FieldValue.getValueType() is not FieldValueType.LIST.

asMap

public Map<String,FormField> asMap()

Gets the value of the field as a Map.

Returns:

the value of the field as an unmodifiable Map.

Throws:

UnsupportedOperationException - if FieldValue.getValueType() is not FieldValueType.MAP.

asSelectionMarkState

public SelectionMarkState asSelectionMarkState()

Gets the value of the field as a selection mark state.

Returns:

the value of the field as an unmodifiable selection mark state.

Throws:

UnsupportedOperationException - if FieldValue.getValueType() is not FieldValueType.SELECTION_MARK_STATE.

asCountryRegion

public String asCountryRegion()

Gets the value of the field as a country or region in the world.

Returns:

the value of the field as COUNTRY_REGION.

Throws:

UnsupportedOperationException - if FieldValue.getValueType() is not FieldValueType.COUNTRY_REGION.