au.gov.nehta.model.clinical.etp.common.item

Class QuantityUnitDescriptionImpl

java.lang.Object

au.gov.nehta.model.clinical.etp.common.item.QuantityUnitDescriptionImpl

All Implemented Interfaces:

QuantityUnitDescription

public class QuantityUnitDescriptionImpl
extends Object
implements QuantityUnitDescription

A Class that represents either a Structured Dose or a Quantity Description that has optionally a Quantity, units, and a Quantity Description . This may be constructed with either a Real valued Physical Quantity or a quanity with units specified in a particular code system. Use the static create methods to ensure correctness
example:

 QuantityUnitDescription quantity = QuantityUnitDescriptionImpl.create( new RealQuantity(3,"tablets"));
 
 or
 
 QuantityUnitDescription quantity = QuantityUnitDescriptionImpl.create( 3, new SNOMED_AU_Code("385057009", "Film-coated tablet") );
 
 or
 
 QuantityUnitDescription quantity = QuantityUnitDescriptionImpl.create( "3 somethings " );

Constructor Summary

Constructors

Constructor and Description
QuantityUnitDescriptionImpl()

Method Summary

Modifier and Type	Method and Description
static QuantityUnitDescription	create(double value, Code code) Create a quantity that has units with a actual code such as SNOMED CT AU example: QuantityUnitDescriptionImpl.create( 3, new SNOMED_AU_Code("385057009", "Film-coated tablet") );
static QuantityUnitDescription	create(RealQuantity realQuantity) Create a quantity that has units in free text example: QuantityUnitDescriptionImpl.create( new RealQuantity(3,"tablets"));
static QuantityUnitDescription	create(String freeTextQuantityDescription) Create a quantity that has both units and value as a single free text field.
Code	getCodedUnit() The coded value in units for this Quantity.
String	getQuantityDescription() A free text description of the quantity involved
RealQuantity	getRealQuantity()
void	setQuantityDescription(String quantityDescription) A Plane text description of the quantity involved
void	setRealQuantity(RealQuantity quantityAndUnits) RealValued (eg decimal) Quantity of the amount involved.
void	setUnitCode(Code codeUnit) Set the coded value in units for this Quantity.

Methods inherited from class java.lang.Object

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

Constructor Detail

QuantityUnitDescriptionImpl

public QuantityUnitDescriptionImpl()

Method Detail

create

public static QuantityUnitDescription create(RealQuantity realQuantity)

Create a quantity that has units in free text example: QuantityUnitDescriptionImpl.create( new RealQuantity(3,"tablets"));

Parameters:

RealQuantity - a real valued amount of something with units represented by free text

create

public static QuantityUnitDescription create(double value,
                                             Code code)

Create a quantity that has units with a actual code such as SNOMED CT AU example: QuantityUnitDescriptionImpl.create( 3, new SNOMED_AU_Code("385057009", "Film-coated tablet") );

Parameters:

value - a double number remresenting the amount in coded units of something

code - a code identifing the units of the supplied value, usually a SNOMED CT-AU code

create

public static QuantityUnitDescription create(String freeTextQuantityDescription)

Create a quantity that has both units and value as a single free text field. This is the least usable quantity type. example : QuantityUnitDescriptionImpl.create( "3 football fields" )

getRealQuantity

public RealQuantity getRealQuantity()

Specified by:

getRealQuantity in interface QuantityUnitDescription

setRealQuantity

public void setRealQuantity(RealQuantity quantityAndUnits)

RealValued (eg decimal) Quantity of the amount involved. IF a Coded value of units exists, that should be used.

Parameters:

quantityAndUnits -

getCodedUnit

public Code getCodedUnit()

Description copied from interface: QuantityUnitDescription

The coded value in units for this Quantity. Usually this will be a SNOMED CT AU Code.

Specified by:

getCodedUnit in interface QuantityUnitDescription

Returns:

codeUnit SNOMED CT-AU Code

setUnitCode

public void setUnitCode(Code codeUnit)

Set the coded value in units for this Quantity. Usually this will be a SNOMED CT AU Code.

Parameters:

codeUnit - SNOMED CT-AU Code

getQuantityDescription

public String getQuantityDescription()

Description copied from interface: QuantityUnitDescription

A free text description of the quantity involved

Specified by:

getQuantityDescription in interface QuantityUnitDescription

Returns:

quantityDescription - free text description of the quantity

setQuantityDescription

public void setQuantityDescription(String quantityDescription)

A Plane text description of the quantity involved

Parameters:

quantityDescription -