au.gov.nehta.model.cda.common.time

Class SimplifiedPeriodicIntervalTime

java.lang.Object

au.gov.nehta.model.cda.common.time.CDATimeStamp

au.gov.nehta.model.cda.common.time.SetComponentTime

au.gov.nehta.model.cda.common.time.SimplifiedPeriodicIntervalTime

public class SimplifiedPeriodicIntervalTime
extends SetComponentTime

A simplified version of PeriodicIntervalTime that encodes only a period with a value

 eg:
 
                   
 

 

Author:

NeHTA

See Also:

{@link PeriodicIntervalTime}, {@link TimeQuantity}, {@link SetComponentTime}

Field Summary

Fields inherited from class au.gov.nehta.model.cda.common.time.SetComponentTime

operator

Fields inherited from class au.gov.nehta.model.cda.common.time.CDATimeStamp

value

Constructor Summary

Constructors

Constructor and Description
SimplifiedPeriodicIntervalTime(int period, TimeUnitOfMeasure unit) A period based time value, for example 8 weeks
SimplifiedPeriodicIntervalTime(TimeQuantity quantity) An alternative constructor that allows you to include a custom narrative.

Method Summary

Modifier and Type	Method and Description
String	getNarrative()
String	getPeriod()
String	getUnit()
void	setNarrative(String narrative)

Methods inherited from class au.gov.nehta.model.cda.common.time.SetComponentTime

getOperator, setOperator

Methods inherited from class au.gov.nehta.model.cda.common.time.CDATimeStamp

getValue, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

SimplifiedPeriodicIntervalTime

public SimplifiedPeriodicIntervalTime(int period,
                                      TimeUnitOfMeasure unit)

A period based time value, for example 8 weeks

SimplifiedPeriodicIntervalTime periodicTime = new SimplifiedPeriodicIntervalTime(8, "wk");

Parameters:

period - an integer value specifying the number of units

unit - the unit of time

SimplifiedPeriodicIntervalTime

public SimplifiedPeriodicIntervalTime(TimeQuantity quantity)

An alternative constructor that allows you to include a custom narrative.
example:

 TimeQuantity qty = new TimeQuantity(8, TimeUnitOfMeasure.WEEK)
 qty.setNarrative(" 8 weeks ");
 SimplifiedPeriodicIntervalTime drugSupplyPeriod = new SimplifiedPeriodicIntervalTime(qty);
 

Parameters:

quantity - an integer value specifying the number of units

Method Detail

getPeriod

public String getPeriod()

getUnit

public String getUnit()

getNarrative

public String getNarrative()

Overrides:

getNarrative in class SetComponentTime

setNarrative

public void setNarrative(String narrative)

Overrides:

setNarrative in class SetComponentTime