cdac.medinfo.sdk.dcm30_04.baselibs

Class DocumentContentMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.DocumentContentMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class DocumentContentMacro
extends Macro

This Macro contains attributes of Document Content Macro.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentContentMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
DocumentContentMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
DocumentContentMacro(IItem objItem) This constructor constructs a Macro with the specified Item
DocumentContentMacro(IItem objItem, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with the specified Item and DictionaryReader

Method Summary

Methods

Modifier and Type	Method and Description
CodeMacro	getCodeMacro() Retrieves the instance of Code Macro.
CompositeObjectReferenceMacro	getCompositeObjectReferenceMacro() Retrieves the instance of Composite Object Reference Macro.
ConceptNameCodeSequence	getConceptNameCodeSequence() Retrieves pre-initialized object of Concept Name Code Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
java.lang.String	getContinuityOfContent() Retrieves whether or not its contained Content Items are logically linked in a continuous textual flow, or are separate items.
java.lang.String	getDate() Retrieves the value of the Content Item.
java.lang.String	getDateTime() Retrieves the value of the Content Item.
ImageReferenceMacro	getImageReferenceMacro() Retrieves the instance of Image Reference Macro.
NumericMeasurementMacro	getNumericMeasurementMacro() Retrieves the instance of Numeric Measurement Macro.
java.lang.String	getPersonName() Retrieves the value of the Content Item.
SpatialCoordinatesMacro	getSpatialCoordinatesMacro() Retrieves the instance of Spatial Coordinates Macro.
TemporalCoordinatesMacro	getTemporalCoordinatesMacro() Retrieves the instance of Temporal Coordinates Macro.
java.lang.String	getTextValue() Retrieves the value of the Content Item.
java.lang.String	getTime() Retrieves the value of the Content Item.
java.lang.String	getUID() Retrieves the value of the Content Item.
java.lang.String	getValueType() Retrieves The type of the value encoded in this Content Item.
WaveformReferenceMacro	getWaveformReferenceMacro() Retrieves the instance of Waveform Reference Macro.
void	setContinuityOfContent(EnumContinuityOfContent enumContinuityOfContent) This flag specifies for a CONTAINER whether or not its contained Content Items are logically linked in a continuous textual flow, or are separate items.
void	setDate(java.lang.String strDate) This is the value of the Content Item.
void	setDateTime(java.lang.String strDateTime) This is the value of the Content Item.
void	setPersonName(java.lang.String strPersonName) This is the value of the Content Item.
void	setTextValue(java.lang.String strTextValue) Sets the value of the Content Item.
void	setTime(java.lang.String strDate) This is the value of the Content Item.
void	setUID(java.lang.String strUID) This is the value of the Content Item.
void	setValueType(EnumValueType enumValueType) Sets The type of the value encoded in this Content Item.
boolean	validate() Validates all the attributes in Document Content Macro
boolean	validate(IDataSet objIDataSet) Validates all the attributes in Document Content Macro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in Document Content Macro that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Macro

addDataElement, clone, contains, getDataElement, getTransferSyntax

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentContentMacro

public DocumentContentMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

DocumentContentMacro

public DocumentContentMacro(IDataSet objDataSet,
                    IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified DataSet and DictionaryReader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

DocumentContentMacro

public DocumentContentMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

DocumentContentMacro

public DocumentContentMacro(IItem objItem,
                    IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and DictionaryReader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

setValueType

public void setValueType(EnumValueType enumValueType)

Sets The type of the value encoded in this Content Item. Defined Terms: TEXT, NUM, CODE, DATETIME, DATE, TIME, UIDREF, PNAME, COMPOSITE, IMAGE, WAVEFORM, SCOORD, TCOORD, CONTAINER

Parameters:

enumValueType - Enum value of type of the value encoded in this Content Item.

getValueType

public java.lang.String getValueType()

Retrieves The type of the value encoded in this Content Item.

Returns:

String - value of type of the value encoded in this Content Item.

getConceptNameCodeSequence

public ConceptNameCodeSequence getConceptNameCodeSequence()

Retrieves pre-initialized object of Concept Name Code Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ConceptNameCodeSequence - instance of Concept Name Code Sequence.

setContinuityOfContent

public void setContinuityOfContent(EnumContinuityOfContent enumContinuityOfContent)

This flag specifies for a CONTAINER whether or not its contained Content Items are logically linked in a continuous textual flow, or are separate items. Enumerated Values: SEPARATE, CONTINUOUS

Parameters:

enumContinuityOfContent - Enum value of Continuity of Content.

getContinuityOfContent

public java.lang.String getContinuityOfContent()

Retrieves whether or not its contained Content Items are logically linked in a continuous textual flow, or are separate items.

Returns:

String - value of Continuity of Content.

setTextValue

public void setTextValue(java.lang.String strTextValue)

Sets the value of the Content Item.

Parameters:

strTextValue - String value of Content Item.

getTextValue

public java.lang.String getTextValue()

Retrieves the value of the Content Item.

Returns:

String - value of the value of the Content Item.

setDateTime

public void setDateTime(java.lang.String strDateTime)

This is the value of the Content Item.

Parameters:

strDateTime - String value of Date Time.

getDateTime

public java.lang.String getDateTime()

Retrieves the value of the Content Item.

Returns:

String - value of the value of Date Time.

setDate

public void setDate(java.lang.String strDate)

This is the value of the Content Item.

Parameters:

strDate - String value of Date.

getDate

public java.lang.String getDate()

Retrieves the value of the Content Item.

Returns:

String - value of the value of Date.

setTime

public void setTime(java.lang.String strDate)

This is the value of the Content Item.

Parameters:

strDate - String value of Time.

getTime

public java.lang.String getTime()

Retrieves the value of the Content Item.

Returns:

String - value of the value of Time.

setPersonName

public void setPersonName(java.lang.String strPersonName)

This is the value of the Content Item.

Parameters:

strPersonName - String value of Person Name.

getPersonName

public java.lang.String getPersonName()

Retrieves the value of the Content Item.

Returns:

String - value of Person Name.

setUID

public void setUID(java.lang.String strUID)

This is the value of the Content Item.

Parameters:

strUID - String value of UID.

getUID

public java.lang.String getUID()

Retrieves the value of the Content Item.

Returns:

String - value of UID.

getNumericMeasurementMacro

public NumericMeasurementMacro getNumericMeasurementMacro()

Retrieves the instance of Numeric Measurement Macro. If the instance is not already present a new instance is created and returned. It is used to set the attribtues of Numeric Measurement Macro.

Returns:

- instance of NumericMeasurementMacro.

getCodeMacro

public CodeMacro getCodeMacro()

Retrieves the instance of Code Macro. If the instance is not already present a new instance is created and returned. It is used to set the attribtues of Code Macro.

Returns:

- instance of CodeMacro.

getCompositeObjectReferenceMacro

public CompositeObjectReferenceMacro getCompositeObjectReferenceMacro()

Retrieves the instance of Composite Object Reference Macro. If the instance is not already present a new instance is created and returned. It is used to set the attribtues of Composite Object Reference Macro.

Returns:

- instance of CompositeObjectReferenceMacro.

getImageReferenceMacro

public ImageReferenceMacro getImageReferenceMacro()

Retrieves the instance of Image Reference Macro. If the instance is not already present a new instance is created and returned. It is used to set the attribtues of Image Reference Macro.

Returns:

- instance of ImageReferenceMacro.

getWaveformReferenceMacro

public WaveformReferenceMacro getWaveformReferenceMacro()

Retrieves the instance of Waveform Reference Macro. If the instance is not already present a new instance is created and returned. It is used to set the attribtues of Waveform Reference Macro.

Returns:

- instance of WaveformReferenceMacro.

getSpatialCoordinatesMacro

public SpatialCoordinatesMacro getSpatialCoordinatesMacro()

Retrieves the instance of Spatial Coordinates Macro. If the instance is not already present a new instance is created and returned. It is used to set the attribtues of Spatial Coordinates Macro.

Returns:

- instance of SpatialCoordinatesMacro.

getTemporalCoordinatesMacro

public TemporalCoordinatesMacro getTemporalCoordinatesMacro()

Retrieves the instance of Temporal Coordinates Macro. If the instance is not already present a new instance is created and returned. It is used to set the attribtues of Temporal Coordinates Macro.

Returns:

- instance of TemporalCoordinatesMacro.

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in Document Content Macro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public boolean validate(IDataSet objIDataSet)
                 throws InvalidMacroException

Validates all the attributes in Document Content Macro that are present in the DataSet

Parameters:

objIDataSet - collection of DataElements

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IItem objIItem)
                        throws InvalidMacroException

Validates all the attributes in Document Content Macro that are present in the DataSet

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

boolean Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.