cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class GeneralSeriesModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralSeriesModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class GeneralSeriesModule
extends Module

\* The class GeneralSeriesModule.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
GeneralSeriesModule(IDataSet objIDataSet) Instantiates a new general series module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAnatomicalOrientationType() Retrieves Anatomical Orientation Type.
java.lang.String	getBodyPartExamined() Retrieves Body Part Examined.
java.lang.String	getCommentsOnThePerformedProcedureStep() Retrieves User-defined comments on the Performed Procedure Step in General Series Module..
short	getLargestPixelValueInSeries() Retrieves Largest Pixel Value In Series.
java.lang.String	getLaterality() Retrieves Laterality.
java.lang.String	getModality() Retrieves Modality.
OperatorIdentificationSequence	getOperatorIdentificationSequence() This method Returns provides the pre-initialized object of Operator Identification Sequence return OperatorIdentificationSequence - object of Operator Identification Sequence.
java.lang.String[]	getOperatorNames() Retrieves Operator Names.
java.lang.String	getPatientPosition() Retrieves Patient Position.
java.lang.String	getPerformedProcedureStepDescription() Retrieves Performed Procedure Step Description.
java.lang.String	getPerformedProcedureStepID() Retrieves Performed Procedure Step ID.
java.lang.String	getPerformedProcedureStepStartDate() Retrieves Performed Procedure Step Start Date.
java.lang.String	getPerformedProcedureStepStartTime() Retrieves Performed Procedure Step Start Time.
PerformedProtocolCodeSequence	getPerformedProtocolCodeSequence() This method Returns provides the pre-initialized object of Performed Protocol Code Sequence return PerformedProtocolCodeSequence - object of Performed Protocol Code Sequence.
PerformingPhysicianIdentificationSequence	getPerformingPhysicianIdentificationSequence() This method Returns provides the pre-initialized object of Performing Physician Identification Sequence return PerformingPhysicianIdentificationSequence - object of Performing Physician Identification Sequence.
java.lang.String[]	getPerformingPhysicianNames() Retrieves Performing Physician Names.
java.lang.String	getProtocolName() Retrieves Protocol Name.
ReferencedPerformedProcedureStepSequence	getReferencedPerformedProcedureStepSequence() This method Returns provides the pre-initialized object of Referenced Performed Procedure Step Sequence return ReferencedPerformedProcedureStepSequence - object of Referenced Performed Procedure Step Sequence.
RelatedSeriesSequence	getRelatedSeriesSequence() This method Returns provides the pre-initialized object of Related Series Sequence return RelatedSeriesSequence - object of Related Series Sequence.
RequestAttributesSequence	getRequestAttributesSequence() This method Returns provides the pre-initialized object of Request Attributes Sequence return RequestAttributesSequence - object of Performed Protocol Code Sequence.
java.lang.String	getSeriesDate() Retrieves Series Date.
java.lang.String	getSeriesDescription() Retrieves Series Description.
SeriesDescriptionCodeSequence	getSeriesDescriptionCodeSequence() This method provides the pre-initialized object of Series Description Code Sequence.
java.lang.String	getSeriesInstanceUID() Retrieves Series Instance UID.
java.lang.String	getSeriesNumber() Retrieves Series Number.
java.lang.String	getSeriesTime() Retrieves Series Time.
short	getSmallestPixelValueInSeries() Retrieves Smallest Pixel Value InSeries.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setAnatomicalOrientationType(EnumAnatomicalOrientationType enumAnatomicalOrientationType) Sets Anatomical Orientation Type.
void	setBodyPartExamined(EnumBodyPartExamined enumBodyPartExamined) Sets the body part examined.
void	setCommentsOnThePerformedProcedureStep(java.lang.String strCommentsonthePerformedProcedureStep) Sets the comments on the performed procedure step.
void	setLargestPixelValueInSeries(short shLargestPixelValueInSeries) Sets the largest pixel value in series.
void	setLaterality(EnumLaterality enumLaterality) Sets the laterality.
void	setModality(EnumModality enumModality) Sets the modality.
void	setOperatorNames(java.lang.String[] arrStrOperatorNames) Sets the operator names.
void	setPatientPosition(EnumPatientPosition enumPatientPosition) Sets the patient position.
void	setPerformedProcedureStepDescription(java.lang.String strPerformedProcedureStepDescription) Sets the performed procedure step description.
void	setPerformedProcedureStepID(java.lang.String strPerformedProcedureStepID) Sets the performed procedure step id.
void	setPerformedProcedureStepStartDate(java.lang.String strPerformedProcedureStepStartDate) Sets the performed procedure step start date.
void	setPerformedProcedureStepStartTime(java.lang.String strPerformedProcedureStepStartTime) Sets the performed procedure step start time.
void	setPerformingPhysicianNames(java.lang.String[] arrStrPerformingPhysicianNames) Sets the performing physician names.
void	setProtocolName(java.lang.String strProtocolName) Sets the protocol name.
void	setSeriesDate(java.lang.String strSeriesDate) Sets the series date.
void	setSeriesDescription(java.lang.String strSeriesDescription) Sets the series description.
void	setSeriesInstanceUID(java.lang.String strSeriesInstanceUID) This method is used to set the Series Instance UID in General Series Module.
void	setSeriesNumber(java.lang.String strSeriesNumber) Sets the series number.
void	setSeriesTime(java.lang.String strSeriesTime) Sets the series time.
void	setSmallestPixelValueInSeries(short shSmallestPixelValueInSeries) Sets the smallest pixel value in series.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

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

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

GeneralSeriesModule

public GeneralSeriesModule(IDataSet objIDataSet)

Instantiates a new general series module.

Parameters:

objIDataSet - the obj i data set

Method Detail

setModality

public void setModality(EnumModality enumModality)

Sets the modality.

Parameters:

enumModality - the enum modality This method is used to set the Modality in General Series Module. The function accepts a String Value as the Modality and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getModality

public java.lang.String getModality()

Retrieves Modality.

Returns:

String - String value of Modality.

setSeriesInstanceUID

public void setSeriesInstanceUID(java.lang.String strSeriesInstanceUID)

This method is used to set the Series Instance UID in General Series Module. The function accepts a String Value as the Series Instance UID and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

Parameters:

strSeriesInstanceUID - : Unique identifier of the Series.

getSeriesInstanceUID

public java.lang.String getSeriesInstanceUID()

Retrieves Series Instance UID.

Returns:

String - String value of SeriesInstanceUID.

setSeriesNumber

public void setSeriesNumber(java.lang.String strSeriesNumber)

Sets the series number.

Parameters:

strSeriesNumber - : Series Number This method is used to set the Series Number in General Series Module. The function accepts a String Value as the Series Number and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getSeriesNumber

public java.lang.String getSeriesNumber()

Retrieves Series Number.

Returns:

String - String value of SeriesNumber.

setLaterality

public void setLaterality(EnumLaterality enumLaterality)

Sets the laterality.

Parameters:

enumLaterality - :Laterality of (paired) body part examined. Required if the body part examined is a paired structure and Image Laterality (0020,0062) or Frame Laterality (0020,9072) are not sent. Enumerated Values:R = right L = left This method is used to set the Laterality in General Series Module. The function accepts a String Value as the Laterality and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getLaterality

public java.lang.String getLaterality()

Retrieves Laterality.

Returns:

String - String value of Laterality

setSeriesDate

public void setSeriesDate(java.lang.String strSeriesDate)

Sets the series date.

Parameters:

strSeriesDate - : Date the Series started. This method is used to set the Series Date in General Series Module. The function accepts a String Value as the Series Date and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getSeriesDate

public java.lang.String getSeriesDate()

Retrieves Series Date.

Returns:

String - String value of SeriesDate

setSeriesTime

public void setSeriesTime(java.lang.String strSeriesTime)

Sets the series time.

Parameters:

strSeriesTime - : Time the Series started. This method is used to set the Series Time in General Series Module. The function accepts a String Value as the Series Time and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getSeriesTime

public java.lang.String getSeriesTime()

Retrieves Series Time.

Returns:

String - String value of Series Time.

setPerformingPhysicianNames

public void setPerformingPhysicianNames(java.lang.String[] arrStrPerformingPhysicianNames)

Sets the performing physician names.

Parameters:

arrStrPerformingPhysicianNames - : Name of the physician(s) administering the Series. This method is used to set the Performing Physicians' Names in General Series Module. The function accepts a String Array Value as the Series Time and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getPerformingPhysicianNames

public java.lang.String[] getPerformingPhysicianNames()

Retrieves Performing Physician Names.

Returns:

String[] - String array of PerformingPhysicianNames.

setProtocolName

public void setProtocolName(java.lang.String strProtocolName)

Sets the protocol name.

Parameters:

strProtocolName - : User-defined description of the conditions under which the Series was performed. This method is used to set the Protocol Name in General Series Module. The function accepts a String Value as the Protocol Name and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getProtocolName

public java.lang.String getProtocolName()

Retrieves Protocol Name.

Returns:

String - String value of Protocol Name.

setSeriesDescription

public void setSeriesDescription(java.lang.String strSeriesDescription)

Sets the series description.

Parameters:

strSeriesDescription - : User provided description of the Series This method is used to set the Series Description in General Series Module. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getSeriesDescription

public java.lang.String getSeriesDescription()

Retrieves Series Description.

Returns:

String - String value of SeriesDescription.

getSeriesDescriptionCodeSequence

public SeriesDescriptionCodeSequence getSeriesDescriptionCodeSequence()

This method provides the pre-initialized object of Series Description Code Sequence.

Returns:

- object of Series Description 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

setOperatorNames

public void setOperatorNames(java.lang.String[] arrStrOperatorNames)

Sets the operator names.

Parameters:

arrStrOperatorNames - : Name(s) of the operator(s) supporting the Series. This method is used to set the Operator Names in General Series Module. The function accepts a String Array Value as the Series Time and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap.

getOperatorNames

public java.lang.String[] getOperatorNames()

Retrieves Operator Names.

Returns:

String[] - String array of OperatorNames.

setBodyPartExamined

public void setBodyPartExamined(EnumBodyPartExamined enumBodyPartExamined)

Sets the body part examined.

Parameters:

enumBodyPartExamined - : Text description of the part of the body examined. Defined Terms:SKULL, CSPINE, TSPINE, LSPINE,SSPINE, COCCYX, CHEST, CLAVICLE,BREAST,ABDOMEN,PELVIS, HIP,SHOULDER, ELBOW, KNEE, ANKLE,HAND,FOOT, EXTREMITY, HEAD,HEART, NECK, LEG, ARM, JAW. setBodyPartExamined method is used to set the Body Part Examined in General Series Module. The function accepts a String Value as the Body Part Examined and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getBodyPartExamined

public java.lang.String getBodyPartExamined()

Retrieves Body Part Examined.

Returns:

String - String value of Body part Examined.

setPatientPosition

public void setPatientPosition(EnumPatientPosition enumPatientPosition)

Sets the patient position.

Parameters:

enumPatientPosition - the enum patient position setPatientPosition method is used to set the Patient Position in General Series Module. The function accepts a String Value as the Patient Position and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getPatientPosition

public java.lang.String getPatientPosition()

Retrieves Patient Position.

Returns:

String - String value of Patient Position.

setSmallestPixelValueInSeries

public void setSmallestPixelValueInSeries(short shSmallestPixelValueInSeries)

Sets the smallest pixel value in series.

Parameters:

shSmallestPixelValueInSeries - : The minimum value of all images in this Series. setSmallestPixelValueInSeries method is used to set the Smallest Pixel Value In Series in General Series Module. The function accepts a String Value as the Smallest Pixel Value In Series and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getSmallestPixelValueInSeries

public short getSmallestPixelValueInSeries()

Retrieves Smallest Pixel Value InSeries.

Returns:

short - short value of SmallestPixelValueInSeries.

setLargestPixelValueInSeries

public void setLargestPixelValueInSeries(short shLargestPixelValueInSeries)

Sets the largest pixel value in series.

Parameters:

shLargestPixelValueInSeries - : The maximum value of all images in this Series. setLargestPixelValueInSeries method is used to set the Smallest Pixel Value In Series in General Series Module. The function accepts a String Value as the Largest Pixel Value In Series and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getLargestPixelValueInSeries

public short getLargestPixelValueInSeries()

Retrieves Largest Pixel Value In Series.

Returns:

short - short value of LargestPixelValueInSeries.

setPerformedProcedureStepID

public void setPerformedProcedureStepID(java.lang.String strPerformedProcedureStepID)

Sets the performed procedure step id.

Parameters:

strPerformedProcedureStepID - : User or equipment generated identifier of that part of a Procedure that has been carried out within this step. setPerformedProcedureStepID method is used to set the Performed Procedure Step ID in General Series Module. The function accepts a String Value as the Performed Procedure Step ID and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getPerformedProcedureStepID

public java.lang.String getPerformedProcedureStepID()

Retrieves Performed Procedure Step ID.

Returns:

String - String value of Performed Procedure Step ID.

setPerformedProcedureStepStartDate

public void setPerformedProcedureStepStartDate(java.lang.String strPerformedProcedureStepStartDate)

Sets the performed procedure step start date.

Parameters:

strPerformedProcedureStepStartDate - : Date on which the Performed Procedure Step started. setPerformedProcedureStepStartDate method is used to set the Performed Procedure Step Start Date in General Series Module. The function accepts a String Value as the Performed Procedure Step Start Date and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

getPerformedProcedureStepStartDate

public java.lang.String getPerformedProcedureStepStartDate()

Retrieves Performed Procedure Step Start Date.

Returns:

String - String value of Performed Procedure Step Start Date.

setPerformedProcedureStepStartTime

public void setPerformedProcedureStepStartTime(java.lang.String strPerformedProcedureStepStartTime)

Sets the performed procedure step start time.

Parameters:

strPerformedProcedureStepStartTime - : Time on which the Performed Procedure Step started. setPerformedProcedureStepStartTime method is used to set the Performed Procedure Step Start Time in General Series Module. The function accepts a String Value as the Performed Procedure Step Start Time and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap.

getPerformedProcedureStepStartTime

public java.lang.String getPerformedProcedureStepStartTime()

Retrieves Performed Procedure Step Start Time.

Returns:

String - String value of Performed Procedure Step Start Time.

setPerformedProcedureStepDescription

public void setPerformedProcedureStepDescription(java.lang.String strPerformedProcedureStepDescription)

Sets the performed procedure step description.

Parameters:

strPerformedProcedureStepDescription - : Institution-generated description or classification of the Procedure Step that was performed. setPerformedProcedureStepDescription method is used to set the Performed Procedure Step Description in General Series Module. The function accepts a String Value as the Performed Procedure Step Description and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap.

getPerformedProcedureStepDescription

public java.lang.String getPerformedProcedureStepDescription()

Retrieves Performed Procedure Step Description.

Returns:

String - String value of Performed Procedure Step Description.

setCommentsOnThePerformedProcedureStep

public void setCommentsOnThePerformedProcedureStep(java.lang.String strCommentsonthePerformedProcedureStep)

Sets the comments on the performed procedure step.

Parameters:

strCommentsonthePerformedProcedureStep - the str performed procedure step description Set User-defined comments on the Performed Procedure Step in General Series Module. The function accepts a String Value as the Comments On The Performed Procedure Step and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap.

getCommentsOnThePerformedProcedureStep

public java.lang.String getCommentsOnThePerformedProcedureStep()

Retrieves User-defined comments on the Performed Procedure Step in General Series Module..

Returns:

String - User-defined comments on the Performed Procedure Step in General Series Module.

getPerformingPhysicianIdentificationSequence

public PerformingPhysicianIdentificationSequence getPerformingPhysicianIdentificationSequence()

This method Returns provides the pre-initialized object of Performing Physician Identification Sequence return PerformingPhysicianIdentificationSequence - object of Performing Physician Identification 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:

the performing physician identification sequence

getOperatorIdentificationSequence

public OperatorIdentificationSequence getOperatorIdentificationSequence()

This method Returns provides the pre-initialized object of Operator Identification Sequence return OperatorIdentificationSequence - object of Operator Identification 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:

the operator identification sequence

getReferencedPerformedProcedureStepSequence

public ReferencedPerformedProcedureStepSequence getReferencedPerformedProcedureStepSequence()

This method Returns provides the pre-initialized object of Referenced Performed Procedure Step Sequence return ReferencedPerformedProcedureStepSequence - object of Referenced Performed Procedure Step 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:

the referenced performed procedure step sequence

getRelatedSeriesSequence

public RelatedSeriesSequence getRelatedSeriesSequence()

This method Returns provides the pre-initialized object of Related Series Sequence return RelatedSeriesSequence - object of Related Series 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:

the related series sequence

getRequestAttributesSequence

public RequestAttributesSequence getRequestAttributesSequence()

This method Returns provides the pre-initialized object of Request Attributes Sequence return RequestAttributesSequence - object of Performed Protocol 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:

the request attributes sequence

getPerformedProtocolCodeSequence

public PerformedProtocolCodeSequence getPerformedProtocolCodeSequence()

This method Returns provides the pre-initialized object of Performed Protocol Code Sequence return PerformedProtocolCodeSequence - object of Performed Protocol 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:

the performed protocol code sequence

setAnatomicalOrientationType

public void setAnatomicalOrientationType(EnumAnatomicalOrientationType enumAnatomicalOrientationType)

Sets Anatomical Orientation Type. The anatomical orientation type used in instances generated by equipment. Enumerated Values: 1) BIPED 2) QUADRUPED

Parameters:

enumAnatomicalOrientationType - the enum Anatomical Orientation Type

getAnatomicalOrientationType

public java.lang.String getAnatomicalOrientationType()

Retrieves Anatomical Orientation Type. The anatomical orientation type used in instances generated by equipment.

Returns:

String - String value of Anatomical Orientation Type.

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

Boolean - status indicating success or failure

Throws:

InvalidModuleException - the invalid module exception

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the CT Image Module