systems.uom.ucum.format

Class UCUMFormat

java.lang.Object

tech.units.indriya.format.AbstractUnitFormat

systems.uom.ucum.format.UCUMFormat

All Implemented Interfaces:

javax.measure.format.UnitFormat

public abstract class UCUMFormat
extends tech.units.indriya.format.AbstractUnitFormat

This class provides the interface for formatting and parsing units according to the Uniform Code for CommonUnits of Measure (UCUM).

For a technical/historical overview of this format please read CommonUnits of Measure in Clinical Information Systems.

As of revision 1.16, the BNF in the UCUM standard contains an error. I've attempted to work around the problem by modifying the BNF productions for <Term>. Once the error in the standard is corrected, it may be necessary to modify the productions in the UCUMFormatParser.jj file to conform to the standard.

Version:

2.3, 7 December 2020

Author:

Eric Russell, Werner Keil, Andi Huber

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UCUMFormat.Variant Variant of unit representation in the UCUM standard

Method Summary

Modifier and Type	Method and Description
Appendable	format(javax.measure.Unit<?> unknownUnit, Appendable appendable)
static UCUMFormat	getInstance(UCUMFormat.Variant variant) Returns the instance for formatting/parsing using the given variant
static UCUMFormat	getInstance(UCUMFormat.Variant variant, tech.units.indriya.format.SymbolMap symbolMap) Returns an instance for formatting and parsing using user defined symbols
protected tech.units.indriya.format.SymbolMap	getSymbols() Get the symbol map used by this instance to map between Units and Strings, etc...
boolean	isLocaleSensitive()
void	label(javax.measure.Unit<?> unit, String label)
abstract javax.measure.Unit<? extends javax.measure.Quantity<?>>	parse(CharSequence csq)
protected javax.measure.Unit<?>	parse(CharSequence csq, int index)
abstract javax.measure.Unit<? extends javax.measure.Quantity<?>>	parse(CharSequence csq, ParsePosition cursor)

Methods inherited from class tech.units.indriya.format.AbstractUnitFormat

format

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static UCUMFormat getInstance(UCUMFormat.Variant variant)

Returns the instance for formatting/parsing using the given variant

Parameters:

variant - the UCUM variant to use

Returns:

a UCUMFormat instance

getInstance

public static UCUMFormat getInstance(UCUMFormat.Variant variant,
                                     tech.units.indriya.format.SymbolMap symbolMap)

Returns an instance for formatting and parsing using user defined symbols

Parameters:

variant - the UCUM variant to use

symbolMap - the map of user defined symbols to use

Returns:

a UCUMFormat instance

getSymbols

protected tech.units.indriya.format.SymbolMap getSymbols()

Get the symbol map used by this instance to map between Units and Strings, etc...

Returns:

SymbolMap the current symbol map

parse

public abstract javax.measure.Unit<? extends javax.measure.Quantity<?>> parse(CharSequence csq,
                                                                              ParsePosition cursor)
                                                                       throws javax.measure.format.MeasurementParseException

Specified by:

parse in interface javax.measure.format.UnitFormat

Specified by:

parse in class tech.units.indriya.format.AbstractUnitFormat

Throws:

javax.measure.format.MeasurementParseException

parse

protected javax.measure.Unit<?> parse(CharSequence csq,
                                      int index)
                               throws javax.measure.format.MeasurementParseException

Specified by:

parse in class tech.units.indriya.format.AbstractUnitFormat

Throws:

javax.measure.format.MeasurementParseException

parse

public abstract javax.measure.Unit<? extends javax.measure.Quantity<?>> parse(CharSequence csq)
                                                                       throws javax.measure.format.MeasurementParseException

Throws:

javax.measure.format.MeasurementParseException

format

public Appendable format(javax.measure.Unit<?> unknownUnit,
                         Appendable appendable)
                  throws IOException

Specified by:

format in interface javax.measure.format.UnitFormat

Specified by:

format in class tech.units.indriya.format.AbstractUnitFormat

Throws:

IOException

label

public void label(javax.measure.Unit<?> unit,
                  String label)

Specified by:

label in interface javax.measure.format.UnitFormat

Overrides:

label in class tech.units.indriya.format.AbstractUnitFormat

isLocaleSensitive

public boolean isLocaleSensitive()