cdac.medinfo.sdk.dcm30_04.baselibs

Class DocumentRelationshipMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.DocumentRelationshipMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class DocumentRelationshipMacro
extends Macro

This Macro contains attributes of Document Relationship Macro.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ContentSequence	getContentSequence() Retrieves pre-initialized object of Content 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
ContentTemplateSequence	getContentTemplateSequence() Retrieves pre-initialized object of Content Template 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	getObservationDateTime() Retrieves The date and time on which this Content Item was completed.
void	setObservationDateTime(java.lang.String strObservationDateTime) Sets The date and time on which this Content Item was completed.
boolean	validate() Validates all the attributes in Document Relationship Macro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in Document Relationship Macro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in Document Relationship 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

DocumentRelationshipMacro

public DocumentRelationshipMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of Data Elements

DocumentRelationshipMacro

public DocumentRelationshipMacro(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

DocumentRelationshipMacro

public DocumentRelationshipMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

DocumentRelationshipMacro

public DocumentRelationshipMacro(IItem objItem,
                         IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and Dictionary Reader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

setObservationDateTime

public void setObservationDateTime(java.lang.String strObservationDateTime)

Sets The date and time on which this Content Item was completed. For the purpose of recording measurements or logging events, completion time is defined as the time of data acquisition of the measurement, or the time of occurrence of the event.

Parameters:

strObservationDateTime - String value of Observation Date Time.

getObservationDateTime

public java.lang.String getObservationDateTime()

Retrieves The date and time on which this Content Item was completed.

Returns:

String - value of Observation DateTime.

getContentTemplateSequence

public ContentTemplateSequence getContentTemplateSequence()

Retrieves pre-initialized object of Content Template 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:

ContentTemplateSequence - instance of Content Template Sequence.

getContentSequence

public ContentSequence getContentSequence()

Retrieves pre-initialized object of Content 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:

ContentSequence - instance of Content Sequence.

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in Document Relationship Macro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IDataSet objIDataSet)
                        throws InvalidMacroException

Validates all the attributes in Document Relationship 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 Relationship 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.