Module org.apache.sis.util

Package org.apache.sis.measure

Class UnitServices

Object

ServiceProvider

UnitServices

All Implemented Interfaces:

Format­Service, System­Of­Units­Service

public class UnitServices
extends ServiceProvider
implements SystemOfUnitsService, FormatService

The central point from which all unit services (parsing, formatting, listing, etc) can be obtained. Apache SIS does not use this class (SIS rather uses Units predefined constants and Unit­Format directly since they are designed specifically for SIS needs). This class is provided for allowing other applications to discover Apache SIS implementation of JSR-385 without direct dependency. A Unit­Services instance can be obtained by call to Service­Provider.current().

Since:

0.8

Nested Class Summary

Nested classes/interfaces inherited from interface FormatService

Format­Service.Format­Type

Constructor Summary

Constructors

Constructor	Description
Unit­Services()	Creates a new service provider.

Method Summary

Modifier and Type	Method	Description
Set<String>	get­Available­Format­Names(Format­Service.Format­Type type)	Returns a list of available format names.
Collection<System­Of­Units>	get­Available­Systems­Of­Units()	Returns the list of all available systems of units.
Format­Service	get­Format­Service()	Returns the service to obtain a Unit­Format instances.
<Q extends Quantity<Q>> Quantity­Factory<Q>	get­Quantity­Factory(Class<Q> type)	Return a factory for the given Quantity type.
Quantity­Format	get­Quantity­Format()	Returns a quantity format for the default locale.
Quantity­Format	get­Quantity­Format(String name)	Returns the quantity format having the specified name or null if none.
System­Of­Units	get­System­Of­Units()	Returns the default system of units used by Apache SIS.
System­Of­Units	get­System­Of­Units(String name)	Returns the system of units having the specified name, or null if none.
System­Of­Units­Service	get­System­Of­Units­Service()	Returns the service to obtain a System­Of­Units instances.
Unit­Format	get­Unit­Format()	Returns an unit format instance for human-readable unit symbols in the default locale.
Unit­Format	get­Unit­Format(String name)	Returns the unit format for the given name.
Unit­Format	get­Unit­Format(String name, String variant)	Returns the unit format having the specified name or null if none.

Methods inherited from class ServiceProvider

available, current, get­Priority, of, set­Current

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

Methods inherited from interface SystemOfUnitsService

get­Prefixes

Constructor Details

UnitServices

public UnitServices()

Creates a new service provider. Unit­Services should not be instantiated directly unless the caller wants specifically the Apache SIS implementation. For obtaining the default implementation, use Service­Provider.current() instead.

Method Details

getSystemOfUnits

public SystemOfUnits getSystemOfUnits()

Returns the default system of units used by Apache SIS. This include the International System of Units (SI) together with some imperial units and other units. This system includes at least all the constants defined in the Units class.

Specified by:

get­System­Of­Units in interface System­Of­Units­Service

Returns:

the system of units used by Apache SIS.

getSystemOfUnits

public SystemOfUnits getSystemOfUnits(String name)

Returns the system of units having the specified name, or null if none. The argument can be any name in the following table:

Available system of units

Name	Examples
SI	m, km, m³, s, m∕s, K, °C, hPa, rad, µrad
SI + accepted	s, min, h, m∕s, km∕h, °, ′, ″, ha
Imperial	in, ft, mi (statute mile)
SI + other	m, m∕s, km∕h, ft, mi, M (nautical mile)

The search for name is case-insensitive and ignore whitespaces.

Specified by:

get­System­Of­Units in interface System­Of­Units­Service

Parameters:

name - the name of the desired system of units.

Returns:

the system of units for the given name, or null if none.

getAvailableSystemsOfUnits

public Collection<SystemOfUnits> getAvailableSystemsOfUnits()

Returns the list of all available systems of units.

Specified by:

get­Available­Systems­Of­Units in interface System­Of­Units­Service

Returns:

list of available systems of units.

getSystemOfUnitsService

public SystemOfUnitsService getSystemOfUnitsService()

Returns the service to obtain a System­Of­Units instances. The default implementation returns this since this Unit­Services class implements directly all relevant interfaces. The methods related to system of units are:

• get­System­Of­Units()
• get­System­Of­Units(String)
• get­Available­Systems­Of­Units()

Specified by:

get­System­Of­Units­Service in class Service­Provider

Returns:

the service to obtain a System­Of­Units, or null if none.

getUnitFormat

public UnitFormat getUnitFormat()

Returns an unit format instance for human-readable unit symbols in the default locale. The format style is Unit­Format.Style.SYMBOL. This style requires support for Unicode characters; for example square metres are formatted as “m²”, not “m2”.

Specified by:

get­Unit­Format in interface Format­Service

Returns:

a Unit­Format instance for unit symbols.

getUnitFormat

public UnitFormat getUnitFormat(String name)

Returns the unit format for the given name. The argument can be the name of any value in the Unit­Format.Style enumeration. The argument can be any name in the following table:

Available unit format name

Name	Examples
SYMBOL	km, m³, m∕s, N⋅m, K, °C, hPa, rad, µrad
UCUM	km, m3, m/s, N.m
NAME	kilometre, cubic metre, metres per second

The "NAME" format is locale-sensitive. The format locale can be modified by a call to Unit­Format.set­Locale(Locale) on the returned object.

Specified by:

get­Unit­Format in interface Format­Service

Parameters:

name - the name of the desired format.

Returns:

the corresponding unit format, or null if none.

getUnitFormat

public UnitFormat getUnitFormat(String name,
 String variant)

Returns the unit format having the specified name or null if none. The variant is an optional argument for requesting e.g. ASCII-only format, or for choosing case-sensitive versus case-insensitive variants. In current implementation the variant argument is ignored.

Specified by:

get­Unit­Format in interface Format­Service

Parameters:

name - the name of the desired format.

variant - indicates a variation of a unit format.

Returns:

the corresponding unit format, or null if none.

Since:

1.4

getQuantityFormat

public QuantityFormat getQuantityFormat()

Returns a quantity format for the default locale.

Specified by:

get­Quantity­Format in interface Format­Service

Returns:

a Quantity­Format instance for quantities.

Since:

1.4

getQuantityFormat

public QuantityFormat getQuantityFormat(String name)

Returns the quantity format having the specified name or null if none. The names accepted by this method are those documented in get­Unit­Format(String).

Specified by:

get­Quantity­Format in interface Format­Service

Parameters:

name - the name of the format.

Returns:

the corresponding quantity format, or null if none.

Since:

1.4

getAvailableFormatNames

public Set<String> getAvailableFormatNames(FormatService.FormatType type)

Returns a list of available format names. The default implementation returns the names of all values in the Unit­Format.Style enumeration.

Specified by:

get­Available­Format­Names in interface Format­Service

Parameters:

type - the type of formats (for units or for quantities).

Returns:

list of available formats.

getFormatService

public FormatService getFormatService()

Returns the service to obtain a Unit­Format instances. The default implementation returns this since this Unit­Services class implements directly all relevant interfaces. The methods related to unit formats are:

• get­Unit­Format()
• get­Unit­Format(String)
• get­Available­Format­Names(Format­Type)

Specified by:

get­Format­Service in class Service­Provider

Returns:

the service to obtain a Unit­Format, or null if none.

getQuantityFactory

public <Q extends Quantity<Q>> QuantityFactory<Q> getQuantityFactory(Class<Q> type)

Return a factory for the given Quantity type. In the particular case of Apache SIS implementation, Quantities.create(double, Unit) provides a more direct way to instantiate quantities.

Specified by:

get­Quantity­Factory in class Service­Provider

Type Parameters:

Q - compile-time value of the type argument.

Parameters:

type - type of the desired the quantity.

Returns:

the service to obtain Quantity instances.

See Also:

• Quantities.create(double, Unit)