Package com.mindee.parsing.standard

Class AddressField

java.lang.Object

com.mindee.parsing.standard.BaseField

com.mindee.parsing.standard.StringField

com.mindee.parsing.standard.AddressField

All Implemented Interfaces:

PositionData

public final class AddressField
extends StringField

Represent a postal address field broken down into its individual components.

Constructor Summary

Constructors

Constructor	Description
AddressField(String value, Double confidence, Polygon polygon)	Address field constructor only containing the value.
AddressField(String value, String rawValue, String streetNumber, String streetName, String poBox, String addressComplement, String city, String postalCode, String state, String country, Double confidence, Polygon polygon, Integer pageId)

Method Summary

Modifier and Type	Method	Description
String	getAddressComplement()	Additional address complement.
String	getCity()	City or locality.
String	getCountry()	Country.
String	getPoBox()	PO-box number.
String	getPostalCode()	Postal or ZIP code.
String	getRawValue()	The address exactly as it appears on the document.
String	getState()	State, province or region.
String	getStreetName()	Street name.
String	getStreetNumber()	Street number.

Methods inherited from class com.mindee.parsing.standard.StringField

getValue, isEmpty, toString

Methods inherited from class com.mindee.parsing.standard.BaseField

canEqual, equals, getBoundingBox, getConfidence, getPageId, getPolygon, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

AddressField

public AddressField(String value,
                    String rawValue,
                    String streetNumber,
                    String streetName,
                    String poBox,
                    String addressComplement,
                    String city,
                    String postalCode,
                    String state,
                    String country,
                    Double confidence,
                    Polygon polygon,
                    Integer pageId)

AddressField

public AddressField(String value,
                    Double confidence,
                    Polygon polygon)

Address field constructor only containing the value.

Method Detail

getRawValue

public String getRawValue()

The address exactly as it appears on the document.

Overrides:

getRawValue in class StringField

getStreetNumber

public String getStreetNumber()

Street number.

getStreetName

public String getStreetName()

Street name.

getPoBox

public String getPoBox()

PO-box number.

getAddressComplement

public String getAddressComplement()

Additional address complement.

getCity

public String getCity()

City or locality.

getPostalCode

public String getPostalCode()

Postal or ZIP code.

getState

public String getState()

State, province or region.

getCountry

public String getCountry()

Country.