cdac.medinfo.sdk.dcm30_04.baselibs

Class GeneralAnatomyOptionalMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.GeneralAnatomyOptionalMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class GeneralAnatomyOptionalMacro
extends Macro

This Sequence describes the attributes for identifying the general region of the patient anatomy examined using coded terminology, as well as the principal structure(s) within that region that is the target of the current SOP Instance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeneralAnatomyOptionalMacro(IDataSet objDataSet) Creates General Anatomy Optical Macro with Default DataSet.
GeneralAnatomyOptionalMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) Creates General Anatomy Required Macro with Default DataSet and DictionaryReader.
GeneralAnatomyOptionalMacro(IItem objItem) Creates General Anatomy Required Macro with Default Item.
GeneralAnatomyOptionalMacro(IItem objItem, IDictionaryReader objDictionaryReader) Creates General Anatomy Required Macro with Default Item and DictionaryReader.

Method Summary

Methods

Modifier and Type	Method and Description
AnatomicRegionSequence	getAnatomicRegionSequence() Retrieves pre-initialized object of Anatomic Region 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
PrimaryAnatomicStructureMacro	getPrimaryAnatomicStructureMacro() Return the Primary Anatomic Structure Macro instance.
static boolean	isMacroPresent(IDataSet objIDataSet) This method checks if any of the DataElements belonging to this Macro is present in the DataSet.
static boolean	isMacroPresent(IItem objIItem) This method checks if any of the DataElements belonging to this Macro is present in the Item.
boolean	validate() Validates all the attributes in CodeSequenceMacro
boolean	validate(IDataSet objIDataSet) This method checks for the DataElements of the DataSet according to the General Anatomy Optional Macro
boolean	validate(IItem objIItem) This method checks for the DataElements of the Item according to the General Anatomy Optional Macro

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

GeneralAnatomyOptionalMacro

public GeneralAnatomyOptionalMacro(IDataSet objDataSet)

Creates General Anatomy Optical Macro with Default DataSet.

Parameters:

objDataSet - Collection of DataElements

GeneralAnatomyOptionalMacro

public GeneralAnatomyOptionalMacro(IDataSet objDataSet,
                           IDictionaryReader objDictionaryReader)

Creates General Anatomy Required Macro with Default DataSet and DictionaryReader.

Parameters:

objDataSet - Collection of DataElements.

objDictionaryReader - specifies the DICOM Dictionary reader to be used

GeneralAnatomyOptionalMacro

public GeneralAnatomyOptionalMacro(IItem objItem)

Creates General Anatomy Required Macro with Default Item.

Parameters:

objItem - Collection of DataElements in Sequence.

GeneralAnatomyOptionalMacro

public GeneralAnatomyOptionalMacro(IItem objItem,
                           IDictionaryReader objDictionaryReader)

Creates General Anatomy Required Macro with Default Item and DictionaryReader.

Parameters:

objItem - Collection of DataElements in Sequence.

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

getAnatomicRegionSequence

public AnatomicRegionSequence getAnatomicRegionSequence()

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

AnatomicRegionSequence - instance of AnatomicRegionSequence.

validate

public boolean validate(IDataSet objIDataSet)
                 throws InvalidMacroException

This method checks for the DataElements of the DataSet according to the General Anatomy Optional Macro

Parameters:

objIDataSet - object of DataSet for which the the validation is to be done according to the rules of General Anatomy Optional Macro

Returns:

boolean - status of the function as success or failure

Throws:

InvalidMacroException - If Validation of Macro fails.

isMacroPresent

public static boolean isMacroPresent(IDataSet objIDataSet)

This method checks if any of the DataElements belonging to this Macro is present in the DataSet. If such is the case, then the Macro is present in the DataSet.

Parameters:

objIDataSet - object of DataSet in which the Macro is to be searched

Returns:

status indicating success or failure

isMacroPresent

public static boolean isMacroPresent(IItem objIItem)

This method checks if any of the DataElements belonging to this Macro is present in the Item. If such is the case, then the Macro is present in the Item.

Parameters:

objIItem - object of Item in which the Macro is to be searched

Returns:

status indicating success or failure

validate

public boolean validate(IItem objIItem)
                 throws InvalidMacroException

This method checks for the DataElements of the Item according to the General Anatomy Optional Macro

Parameters:

objIItem - object of Item for which the the validation is to be done according to the rules of General Anatomy Optional Macro

Returns:

boolean- status of the function as success or failure

Throws:

InvalidMacroException

getPrimaryAnatomicStructureMacro

public PrimaryAnatomicStructureMacro getPrimaryAnatomicStructureMacro()

Return the Primary Anatomic Structure Macro instance.

Returns:

- instance of PrimaryAnatomicStructureMacro.

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in CodeSequenceMacro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.