Package com.mindee.parsing.standard

Class BaseField

java.lang.Object

com.mindee.parsing.standard.BaseField

All Implemented Interfaces:

PositionData

Direct Known Subclasses:

AmountField, BankAccountDetailsV2Bban, BillOfLadingV1Carrier, BillOfLadingV1CarrierItem, BillOfLadingV1Consignee, BillOfLadingV1NotifyParty, BillOfLadingV1Shipper, BooleanField, CompanyRegistrationField, DateField, EnergyBillV1EnergyConsumer, EnergyBillV1EnergySupplier, EnergyBillV1EnergyUsage, EnergyBillV1MeterDetail, EnergyBillV1Subscription, EnergyBillV1TaxesAndContribution, FinancialDocumentV1LineItem, HealthcareCardV1Copay, InvoiceSplitterV1InvoicePageGroup, InvoiceV4LineItem, LocaleField, NutritionFactsLabelV1AddedSugar, NutritionFactsLabelV1Calorie, NutritionFactsLabelV1Cholesterol, NutritionFactsLabelV1DietaryFiber, NutritionFactsLabelV1Nutrient, NutritionFactsLabelV1Protein, NutritionFactsLabelV1SaturatedFat, NutritionFactsLabelV1ServingSize, NutritionFactsLabelV1Sodium, NutritionFactsLabelV1TotalCarbohydrate, NutritionFactsLabelV1TotalFat, NutritionFactsLabelV1TotalSugar, NutritionFactsLabelV1TransFat, PaymentDetailsField, PayslipV2BankAccountDetail, PayslipV2Employee, PayslipV2Employer, PayslipV2Employment, PayslipV2PayDetail, PayslipV2PayPeriod, PayslipV2Pto, PayslipV2SalaryDetail, PayslipV3BankAccountDetail, PayslipV3Employee, PayslipV3Employer, PayslipV3Employment, PayslipV3PaidTimeOff, PayslipV3PayDetail, PayslipV3PayPeriod, PayslipV3SalaryDetail, ReceiptV5LineItem, ResumeV1Certificate, ResumeV1Education, ResumeV1Language, ResumeV1ProfessionalExperience, ResumeV1SocialNetworksUrl, StringField, TaxField, UsMailV3RecipientAddress, UsMailV3SenderAddress

public abstract class BaseField
extends Object
implements PositionData

Represent basics of a field.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseField()	Default constructor.
protected	BaseField(Double confidence, Polygon polygon, Integer pageId)	JSON constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Polygon	getBoundingBox()	The bounding box equivalent of the polygon.
Double	getConfidence()	The confidence about the zone of the value extracted.
Integer	getPageId()	The index of the page where the current field was found.
Polygon	getPolygon()	Define the coordinates of the zone in the page where the value has been found.
int	hashCode()
abstract boolean	isEmpty()	Whether the field is empty or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseField

protected BaseField(Double confidence,
                    Polygon polygon,
                    Integer pageId)

JSON constructor.

BaseField

protected BaseField()

Default constructor.

Method Detail

isEmpty

public abstract boolean isEmpty()

Whether the field is empty or not.

Returns:

true if the field is empty, false otherwise.

getBoundingBox

public Polygon getBoundingBox()

The bounding box equivalent of the polygon.

Specified by:

getBoundingBox in interface PositionData

getPolygon

public Polygon getPolygon()

Define the coordinates of the zone in the page where the value has been found.

Specified by:

getPolygon in interface PositionData

getConfidence

public Double getConfidence()

The confidence about the zone of the value extracted. A value from 0 to 1.

getPageId

public Integer getPageId()

The index of the page where the current field was found.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object