Area

An area, held in square metres to 6 places, written 12sqm or 2ha; a Length times a Length.

Physical quantities; ordered; since Jadpo 0.1.0.

Make one

text.parse(raw, as: Area) reads one from its text; text that isn't one at all fails malformed, such as 5, "" or 1.2.3.

These operations give one: geo.area, units.of and units.sum.

Text, JSON and storage

text.from writes its canonical text, the one form text.parse reads back. JSON sends an object of its parts.

It is stored in one column named for the field, of type numeric(38, 6), holding the area in square metres (m²). 12 sqm is stored as 12.

Shown to people

text.format(value, locale:) shows it to people in their locale. A call may also give unit:.

With locale: Locale.en_gb:

Operations

• geo.area(shape: T) -> Area: A Polygon's or MultiPolygon's area on the ellipsoid, each edge a geodesic and each ring the smaller of the two sides it bounds, holes taken away, rounded half to even to the square millimetre.
• units.in(value: Quantity, unit: QuantityUnit, scale: Int, rounding: Rounding) -> Decimal: value in unit, a unit of its kind, as a Decimal of scale places rounded by rounding: units.in(5km, LengthUnit.mile, scale: 2, rounding: Rounding.half_even) is 3.11.
• units.of(value: Number, unit: QuantityUnit) -> Quantity: value of unit, an Int or a Decimal, as the quantity of unit's kind, converted exactly to the base unit and rounded half to even to the kind's scale: units.of(5, LengthUnit.mile).
• units.sum(items: List<Quantity>) -> Quantity: The items added up, all of one kind; nothing for no items. A Temperature or a SoundLevel doesn't add to itself, so neither is summed.

Like every standard type, it also has the contract's own operations: text.parse, text.from, text.format, json.read, json.write and ==. It is ordered, so < and sorting take it. Every standard type meets one contract says how they work.