MoneyEntity

AI-generated Key Takeaways

• MoneyEntity is a type of entity extracted from text representing an amount of money.

• It provides the integer and fractional parts of the amount, as well as the currency.

• You can retrieve the fractional part, integer part, and unnormalized currency using dedicated methods.

public final class MoneyEntity extends Entity

A money entity extracted from a piece of text. It provides the values extracted for the amount (split between the integer and fractional parts) and a canonical format for the currency.

Inherited Constant Summary

From class com.google.mlkit.nl.entityextraction.Entity

int	TYPE_ADDRESS	Identifies a physical address.
int	TYPE_DATE_TIME	Identifies a time reference that includes a specific time.
int	TYPE_EMAIL	Identifies an e-mail address.
int	TYPE_FLIGHT_NUMBER	Identifies a flight number in IATA format.
int	TYPE_IBAN	Identifies an International Bank Account Number (IBAN).
int	TYPE_ISBN	Identifies an International Standard Book Number (ISBN).
int	TYPE_MONEY	Identifies an amount of money.
int	TYPE_PAYMENT_CARD	Identifies a payment card.
int	TYPE_PHONE	Identifies a phone number.
int	TYPE_TRACKING_NUMBER	Identifies a shipment tracking number.
int	TYPE_URL	Identifies a URL.

Public Method Summary

int	getFractionalPart() Returns the decimal part of the detected annotation.
int	getIntegerPart() Returns the whole part of the detected annotation.
String	getUnnormalizedCurrency() Returns the currency part of the detected annotation.

Inherited Method Summary

From class com.google.mlkit.nl.entityextraction.Entity

DateTimeEntity	asDateTimeEntity() Convenience method that returns the current entity cast to a DateTimeEntity.
FlightNumberEntity	asFlightNumberEntity() Convenience method that returns the current entity cast to a FlightNumberEntity.
IbanEntity	asIbanEntity() Convenience method that returns the current entity cast to a IbanEntity.
IsbnEntity	asIsbnEntity() Convenience method that returns the current entity cast to a IsbnEntity.
MoneyEntity	asMoneyEntity() Convenience method that returns the current entity cast to a MoneyEntity.
PaymentCardEntity	asPaymentCardEntity() Convenience method that returns the current entity cast to a PaymentCardEntity.
TrackingNumberEntity	asTrackingNumberEntity() Convenience method that returns the current entity cast to a TrackingNumberEntity.
int	getType() Returns the type(e.g.
String	toString()

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public int getFractionalPart ()

Returns the decimal part of the detected annotation. The amount is split between whole part and decimal part since different dividers could be used.

public int getIntegerPart ()

Returns the whole part of the detected annotation. The amount is split between whole part and decimal part since different dividers could be used.

public String getUnnormalizedCurrency ()

Returns the currency part of the detected annotation. No formatting is applied so this will return a subset of the initial String.