org.geotools.measure

Class BaseUnitFormatter

Object

AbstractUnitFormat

SimpleUnitFormat

BaseUnitFormatter

All Implemented Interfaces:

UnitFormat, UnitFormatter

public class BaseUnitFormatter
extends SimpleUnitFormat

This class encapsulates the required machinations to initialize the unit formatter implementation of a certain third-party unit library.

GeoTools' unit formatters should be implemented by calling the provided constructors.

Nested Class Summary

Nested classes/interfaces inherited from class SimpleUnitFormat

SimpleUnitFormat.ASCIIFormat, SimpleUnitFormat.DefaultFormat, SimpleUnitFormat.Flavor

Constructor Summary

Constructors

Constructor and Description
BaseUnitFormatter(List<UnitDefinition> unitDefinitions) Create a new BaseUnitFormatter instance, initialized with provided the unit definitions.
BaseUnitFormatter(UnitDefinition... unitDefinitions) Create a new BaseUnitFormatter instance, initialized with provided the unit definitions.

Method Summary

Modifier and Type	Method and Description
protected void	addUnit(Unit<?> unit) Defaults to being a no-op, subclasses can override
Map<String,Unit<?>>	getSymbolToUnitMap()
Map<Unit<?>,String>	getUnitToSymbolMap()
void	label(Unit<?> unit, String label)

Methods inherited from class SimpleUnitFormat

format, getInstance, getInstance, isAllASCII, parseObject

Methods inherited from class AbstractUnitFormat

format

Methods inherited from class Object

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

Methods inherited from interface UnitFormatter

format, format, parse, parse

Methods inherited from interface UnitFormat

isLocaleSensitive

Constructor Detail

BaseUnitFormatter

public BaseUnitFormatter(UnitDefinition... unitDefinitions)

Create a new BaseUnitFormatter instance, initialized with provided the unit definitions.

Parameters:

unitDefinitions - unit definitions used to initialize this new instance

BaseUnitFormatter

public BaseUnitFormatter(List<UnitDefinition> unitDefinitions)

Create a new BaseUnitFormatter instance, initialized with provided the unit definitions.

Parameters:

unitDefinitions - a list of unit definitions used to initialize this new instance

Method Detail

getUnitToSymbolMap

public Map<Unit<?>,String> getUnitToSymbolMap()

Returns:

an immutable map that shows the units (associated with their symbols) that this unit formatter contains

getSymbolToUnitMap

public Map<String,Unit<?>> getSymbolToUnitMap()

Returns:

an immutable map that shows the symbols (associated with their units) that this unit formatter contains

label

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

Specified by:

label in interface UnitFormat

addUnit

protected void addUnit(Unit<?> unit)

Defaults to being a no-op, subclasses can override