cdac.medinfo.sdk.dcm30_04.baselibs

Class SpecimenMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.SpecimenMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class SpecimenMacro
extends Macro

This class represents Table C.7.6.22-1. Specimen Module Attributes.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
AlternateContainerIdentifierSequence	getAlternateContainerIdentifierSequence() Retrieves pre-initialized object of Alternate Container Identifier 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.
ContainerComponentSequence	getContainerComponentSequence() Retrieves pre-initialized object of Container Component 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	getContainerDescription() Return user-defined label identifier for Container Description.
java.lang.String	getContainerIdentifier() Return user-defined label identifier for Container Identifier.
ContainerTypeCodeSequence	getContainerTypeCodeSequence() Retrieves pre-initialized object of Container Type 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.
IssuerOfTheContainerIdentifierSequence	getIssuerOfTheContainerIdentifierSequence() Retrieves pre-initialized object of Issuer of the Container Identifier 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.
SpecimenDescriptionSequence	getSpecimenDescriptionSequence() Retrieves pre-initialized object of Specimen Description 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.
void	setContainerDescription(java.lang.String strContainerDescription) Sets Container Description.
void	setContainerIdentifier(java.lang.String strContainerIdentifier) Sets Container Identifier.
boolean	validate() Validates all the attributes in Specimen Macro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in Specimen Macro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in Specimen 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

SpecimenMacro

public SpecimenMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

SpecimenMacro

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

SpecimenMacro

public SpecimenMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

SpecimenMacro

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

setContainerIdentifier

public void setContainerIdentifier(java.lang.String strContainerIdentifier)

Sets Container Identifier.

Parameters:

strContainerIdentifier - String value of Container Identifier.

getContainerIdentifier

public java.lang.String getContainerIdentifier()

Return user-defined label identifier for Container Identifier.

Returns:

String - value of Container Identifier.

getIssuerOfTheContainerIdentifierSequence

public IssuerOfTheContainerIdentifierSequence getIssuerOfTheContainerIdentifierSequence()

Retrieves pre-initialized object of Issuer of the Container Identifier 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:

IssuerOfTheContainerIdentifierSequence - instance of Issuer of the Container Identifier Sequence.

getAlternateContainerIdentifierSequence

public AlternateContainerIdentifierSequence getAlternateContainerIdentifierSequence()

Retrieves pre-initialized object of Alternate Container Identifier 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:

AlternateContainerIdentifierSequence - instance of AlternateContainerIdentifierSequence.

getContainerTypeCodeSequence

public ContainerTypeCodeSequence getContainerTypeCodeSequence()

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

ContainerTypeCodeSequence - instance of Container Type Code Sequence.

getContainerComponentSequence

public ContainerComponentSequence getContainerComponentSequence()

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

ContainerComponentSequence - instance of Container Component Sequence.

getSpecimenDescriptionSequence

public SpecimenDescriptionSequence getSpecimenDescriptionSequence()

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

SpecimenDescriptionSequence - instance of Specimen Description Sequence.

setContainerDescription

public void setContainerDescription(java.lang.String strContainerDescription)

Sets Container Description.

Parameters:

strContainerDescription - String value of Container Description.

getContainerDescription

public java.lang.String getContainerDescription()

Return user-defined label identifier for Container Description.

Returns:

String - value of Container Description.

validate

public boolean validate()
                 throws InvalidMacroException

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