UcumEssenceService (HAPI FHIR - Utilities 3.4.0 API)

java.lang.Object
- org.fhir.ucum.UcumEssenceService

All Implemented Interfaces:

UcumService
```
public class UcumEssenceService
extends Object
implements UcumService
```
implements UCUM services. Applications must provide a copy of ucum-essence.xml as either a stream or a file name to create the services. the provided ucum-essence.xml must be released on 25 Apr 2008 or more recent. Note that if the ucum-essence.xml file does not contain a release date on an attribute of the root element, it is not more recent than this date (Gunther added it on this date for this usage, thanks) See UcumService for documentation concerning the services this class provides

Author:

Grahame Grieve

Nested Class Summary
- Nested classes/interfaces inherited from interface org.fhir.ucum.UcumService
  UcumService.UcumVersionDetails

Field Summary

Fields
Modifier and Type Field and Description

static String UCUM_OID

Fields
Modifier and Type	Field and Description
`static String`	`UCUM_OID`

Constructor Summary

Constructors
Constructor and Description
`UcumEssenceService(InputStream stream)` Create an instance of Ucum services.
`UcumEssenceService(String filename)` Create an instance of Ucum services.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`analyse(String unit)` given a unit, return a formal description of what the units stand for using full names
`Decimal`	`convert(Decimal value, String sourceUnit, String destUnit)` given a value and source unit, return the value in the given dest unit an exception is thrown if the conversion is not possible
`Pair`	`getCanonicalForm(Pair value)` given a value/unit pair, return the canonical form as a value/unit pair 1 mm -> 1e-3 m
`String`	`getCanonicalUnits(String unit)` given a set of units, return their canonical form
`String`	`getCommonDisplay(String code)` given a set of UCUM units, return a likely preferred human dense form SI units - as is.
`List<DefinedUnit>`	`getDefinedForms(String code)` for a given canonical unit, return all the defined units that have the same canonical unit.
`UcumModel`	`getModel()` provided for various utility/QA uses.
`Set<String>`	`getProperties()` return a list of the defined types of units in this UCUM version
`boolean`	`isComparable(String units1, String units2)` given two pairs of units, return true if they sahre the same canonical base
`Pair`	`multiply(Pair o1, Pair o2)` multiply two value/units pairs together and return the result in canonical units Note: since the units returned are canonical,
`List<Concept>`	`search(ConceptKind kind, String text, boolean isRegex)` Search through the UCUM concepts for any concept containing matching text.
`UcumService.UcumVersionDetails`	`ucumIdentification()` return Ucum Identification details for the version in use
`String`	`validate(String unit)` validate whether a unit code are valid UCUM units
`String`	`validateCanonicalUnits(String unit, String canonical)` validate whether a units are valid UCUM units and additionally require that the units match a particular base canonical unit
`String`	`validateInProperty(String unit, String property)` validate whether a units are valid UCUM units and additionally require that the units from a particular property
`List<String>`	`validateUCUM()` Check UCUM.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UCUM_OID
```
public static final String UCUM_OID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UcumEssenceService
```
public UcumEssenceService(InputStream stream)
                   throws UcumException
```
    Create an instance of Ucum services. Stream must point to a valid ucum-essence file (see class documentation)
    
    Throws:
    
    UcumException
  - UcumEssenceService
```
public UcumEssenceService(String filename)
                   throws UcumException
```
    Create an instance of Ucum services. filename must point to a valid ucum-essence file (see class documentation)
    
    Throws:
    
    UcumException
- Method Detail
  - ucumIdentification
```
public UcumService.UcumVersionDetails ucumIdentification()
```
    Description copied from interface: UcumService
    
    return Ucum Identification details for the version in use
    
    Specified by:
    
    ucumIdentification in interface UcumService
  - getModel
```
public UcumModel getModel()
```
    Description copied from interface: UcumService
    
    provided for various utility/QA uses. Should not be used for general use
    
    Specified by:
    
    getModel in interface UcumService
    
    Returns:
    
    the model
  - search
```
public List<Concept> search(ConceptKind kind,
                            String text,
                            boolean isRegex)
```
    Description copied from interface: UcumService
    
    Search through the UCUM concepts for any concept containing matching text. Search will be limited to the kind of concept defined by kind, or all if kind is null
    
    Specified by:
    
    search in interface UcumService
    
    Parameters:
    
    kind - - can be null. scope of search
    
    text - - required
    
    Returns:
  - validateUCUM
```
public List<String> validateUCUM()
```
    Description copied from interface: UcumService
    
    Check UCUM. Note that this stands as a test of the service more than UCUM itself (for version 1.7, there are no known semantic errors in UCUM). But you should always run this test at least once with the version of UCUM you are using to ensure that the service implementation correctly understands the UCUM data to which it is bound
    
    Specified by:
    
    validateUCUM in interface UcumService
    
    Returns:
    
    a list of internal errors in the UCUM spec.
  - getProperties
```
public Set<String> getProperties()
```
    Description copied from interface: UcumService
    
    return a list of the defined types of units in this UCUM version
    
    Specified by:
    
    getProperties in interface UcumService
    
    Returns:
  - validate
```
public String validate(String unit)
```
    Description copied from interface: UcumService
    
    validate whether a unit code are valid UCUM units
    
    Specified by:
    
    validate in interface UcumService
    
    Returns:
    
    nil if valid, or an error message describing the problem
  - validateInProperty
```
public String validateInProperty(String unit,
                                 String property)
```
    Description copied from interface: UcumService
    
    validate whether a units are valid UCUM units and additionally require that the units from a particular property
    
    Specified by:
    
    validateInProperty in interface UcumService
    
    Returns:
    
    nil if valid, or an error message describing the problem
  - validateCanonicalUnits
```
public String validateCanonicalUnits(String unit,
                                     String canonical)
```
    Description copied from interface: UcumService
    
    validate whether a units are valid UCUM units and additionally require that the units match a particular base canonical unit
    
    Specified by:
    
    validateCanonicalUnits in interface UcumService
    
    Returns:
    
    nil if valid, or an error message describing the problem
  - analyse
```
public String analyse(String unit)
               throws UcumException
```
    given a unit, return a formal description of what the units stand for using full names
    
    Specified by:
    
    analyse in interface UcumService
    
    Parameters:
    
    units - the unit code
    
    Returns:
    
    formal description
    
    Throws:
    
    UcumException
  - getCanonicalUnits
```
public String getCanonicalUnits(String unit)
                         throws UcumException
```
    Description copied from interface: UcumService
    
    given a set of units, return their canonical form
    
    Specified by:
    
    getCanonicalUnits in interface UcumService
    
    Returns:
    
    the canonical form
    
    Throws:
    
    UcumException
  - getDefinedForms
```
public List<DefinedUnit> getDefinedForms(String code)
                                  throws UcumException
```
    Description copied from interface: UcumService
    
    for a given canonical unit, return all the defined units that have the same canonical unit.
    
    Specified by:
    
    getDefinedForms in interface UcumService
    
    Returns:
    
    Throws:
    
    UcumException
  - getCanonicalForm
```
public Pair getCanonicalForm(Pair value)
                      throws UcumException
```
    Description copied from interface: UcumService
    
    given a value/unit pair, return the canonical form as a value/unit pair 1 mm -> 1e-3 m
    
    Specified by:
    
    getCanonicalForm in interface UcumService
    
    Returns:
    
    Throws:
    
    UcumException
  - convert
```
public Decimal convert(Decimal value,
                       String sourceUnit,
                       String destUnit)
                throws UcumException
```
    Description copied from interface: UcumService
    
    given a value and source unit, return the value in the given dest unit an exception is thrown if the conversion is not possible
    
    Specified by:
    
    convert in interface UcumService
    
    Returns:
    
    the value if a conversion is possible
    
    Throws:
    
    UcumException
  - multiply
```
public Pair multiply(Pair o1,
                     Pair o2)
              throws UcumException
```
    Description copied from interface: UcumService
    
    multiply two value/units pairs together and return the result in canonical units Note: since the units returned are canonical,
    
    Specified by:
    
    multiply in interface UcumService
    
    Returns:
    
    Throws:
    
    UcumException
  - getCommonDisplay
```
public String getCommonDisplay(String code)
```
    Description copied from interface: UcumService
    
    given a set of UCUM units, return a likely preferred human dense form SI units - as is. Other units - improved by manual fixes, or the removal of []
    
    Specified by:
    
    getCommonDisplay in interface UcumService
    
    Returns:
    
    the preferred human display form
  - isComparable
```
public boolean isComparable(String units1,
                            String units2)
                     throws UcumException
```
    Description copied from interface: UcumService
    
    given two pairs of units, return true if they sahre the same canonical base
    
    Specified by:
    
    isComparable in interface UcumService
    
    Returns:
    
    Throws:
    
    UcumException

Class UcumEssenceService

Nested Class Summary

Nested classes/interfaces inherited from interface org.fhir.ucum.UcumService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UCUM_OID

Constructor Detail

UcumEssenceService

UcumEssenceService

Method Detail

ucumIdentification

getModel

search

validateUCUM

getProperties

validate

validateInProperty

validateCanonicalUnits

analyse

getCanonicalUnits

getDefinedForms

getCanonicalForm

convert

multiply

getCommonDisplay

isComparable