UcumService (HAPI FHIR - Utilities 3.8.0 API)

All Known Implementing Classes:

UcumEssenceService
```
public interface UcumService
```
General Ucum Service UCUM functionality that is useful for applications that make use of UCUM codes This is a tightly bound interface - consumers use the internal model classes

Author:

Grahame Grieve

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class UcumService.UcumVersionDetails

Nested Classes
Modifier and Type	Interface and Description
`static class`	`UcumService.UcumVersionDetails`

Method Summary

All Methods Instance Methods Abstract 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.

- Method Detail
  - getModel
```
UcumModel getModel()
```
    provided for various utility/QA uses. Should not be used for general use
    
    Returns:
    
    the model
  - ucumIdentification
```
UcumService.UcumVersionDetails ucumIdentification()
```
    return Ucum Identification details for the version in use
  - validateUCUM
```
List<String> validateUCUM()
```
    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
    
    Returns:
    
    a list of internal errors in the UCUM spec.
  - search
```
List<Concept> search(ConceptKind kind,
                     String text,
                     boolean isRegex)
```
    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
    
    Parameters:
    
    kind - - can be null. scope of search
    
    text - - required
    
    isRegex -
    
    Returns:
  - getProperties
```
Set<String> getProperties()
```
    return a list of the defined types of units in this UCUM version
    
    Returns:
  - validate
```
String validate(String unit)
```
    validate whether a unit code are valid UCUM units
    
    Parameters:
    
    units - - the unit code to check
    
    Returns:
    
    nil if valid, or an error message describing the problem
  - analyse
```
String analyse(String unit)
        throws UcumException
```
    given a unit, return a formal description of what the units stand for using full names
    
    Parameters:
    
    units - the unit code
    
    Returns:
    
    formal description
    
    Throws:
    
    UcumException
    
    OHFException
  - validateInProperty
```
String validateInProperty(String unit,
                          String property)
```
    validate whether a units are valid UCUM units and additionally require that the units from a particular property
    
    Parameters:
    
    units - - the unit code to check
    
    Returns:
    
    nil if valid, or an error message describing the problem
  - validateCanonicalUnits
```
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
    
    Parameters:
    
    units - - the unit code to check
    
    Returns:
    
    nil if valid, or an error message describing the problem
  - getCanonicalUnits
```
String getCanonicalUnits(String unit)
                  throws UcumException
```
    given a set of units, return their canonical form
    
    Parameters:
    
    unit -
    
    Returns:
    
    the canonical form
    
    Throws:
    
    UcumException
    
    OHFException
  - isComparable
```
boolean isComparable(String units1,
                     String units2)
              throws UcumException
```
    given two pairs of units, return true if they sahre the same canonical base
    
    Parameters:
    
    units1 -
    
    units2 -
    
    Returns:
    
    Throws:
    
    UcumException
  - getDefinedForms
```
List<DefinedUnit> getDefinedForms(String code)
                           throws UcumException
```
    for a given canonical unit, return all the defined units that have the same canonical unit.
    
    Parameters:
    
    code -
    
    Returns:
    
    Throws:
    
    UcumException
    
    OHFException
  - getCanonicalForm
```
Pair getCanonicalForm(Pair value)
               throws UcumException
```
    given a value/unit pair, return the canonical form as a value/unit pair 1 mm -> 1e-3 m
    
    Parameters:
    
    value -
    
    Returns:
    
    Throws:
    
    UcumException
    
    OHFException
  - convert
```
Decimal convert(Decimal value,
                String sourceUnit,
                String destUnit)
         throws UcumException
```
    given a value and source unit, return the value in the given dest unit an exception is thrown if the conversion is not possible
    
    Parameters:
    
    value -
    
    sourceUnit -
    
    destUnit -
    
    Returns:
    
    the value if a conversion is possible
    
    Throws:
    
    UcumException
    
    OHFException
  - multiply
```
Pair multiply(Pair o1,
              Pair o2)
       throws UcumException
```
    multiply two value/units pairs together and return the result in canonical units Note: since the units returned are canonical,
    
    Parameters:
    
    o1 -
    
    o2 -
    
    Returns:
    
    Throws:
    
    UcumException
  - getCommonDisplay
```
String getCommonDisplay(String code)
```
    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 []
    
    Parameters:
    
    code -
    
    Returns:
    
    the preferred human display form

Interface UcumService

Nested Class Summary

Method Summary

Method Detail

getModel

ucumIdentification

validateUCUM

search

getProperties

validate

analyse

validateInProperty

validateCanonicalUnits

getCanonicalUnits

isComparable

getDefinedForms

getCanonicalForm

convert

multiply

getCommonDisplay