cdac.medinfo.sdk.dcm30_04.baselibs

Class PerformedSeriesSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.PerformedSeriesSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class PerformedSeriesSequenceItem
extends Item

This item class contains methods to validate, set and get attributes in PerformedSeriesSequence

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getArchiveRequested() Retrieves type of the value encoded in this Item
OperatorIdentificationSequence	getOperatorIdentificationSequence() Retrieves pre-initialized 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
java.lang.String[]	getOperatorsName() Return Name(s) of the operator(s) who supporting this Series.
PerformingPhysicianIdentificationSequence	getPerformingPhysicianIdentificationSequence() Retrieves pre-initialized 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
java.lang.String[]	getPerformingPhysiciansName() Return Name of the physician(s) administering this Series.
java.lang.String	getProtocolName() Return User-defined description of the conditions under which the Series was performed.
ReferencedImageSequence	getReferencedImageSequence() Retrieves pre-initialized object of Referenced Image 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
ReferencedNonImageCompositeSOPInstanceSequence	getReferencedNonImageCompositeSOPInstanceSequence() Retrieves pre-initialized object of Referenced Non Image Composite SOP Instance 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[]	getRetrieveAETitle() Return Title of the DICOM Application Entity where the Images and Standalone SOP Instances in this Series may be retrieved on the network.
java.lang.String	getSeriesDescription() Return User provided description of the Series
SeriesDescriptionCodeSequence	getSeriesDescriptionCodeSequence() Retrieves pre-initialized 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.
java.lang.String	getSeriesInstanceUID() Return Unique Identifier of the Series.
void	setArchiveRequested(EnumArchiveRequested enumArchiveRequested) Sets the ArchiveRequested Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME
void	setOperatorsName(java.lang.String[] arrStrOperatorsName) Sets Name(s) of the operator(s) who supporting this Series.
void	setPerformingPhysiciansName(java.lang.String[] arrStrPerformingPhysiciansName) Sets Name of the physician(s) administering this Series.
void	setProtocolName(java.lang.String StrProtocolName) Sets attribute identifies User-defined description of the conditions under which the Series was performed.
void	setRetrieveAETitle(java.lang.String[] arrStrRetrieveAETitle) Sets Title of the DICOM Application Entity where the Images and Standalone SOP Instances in this Series may be retrieved on the network.
void	setSeriesDescription(java.lang.String StrSeriesDescription) Sets attribute identifies User provided description of the Series
void	setSeriesInstanceUID(java.lang.String StrSeriesInstanceUID) Sets attribute identifies Unique Identifier of the Series.
boolean	validateForModule() Validates all the attributes in Presentation LUT Sequence Item that are present in the DataSet

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

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

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

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in Presentation LUT Sequence Item that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

setPerformingPhysiciansName

public void setPerformingPhysiciansName(java.lang.String[] arrStrPerformingPhysiciansName)

Sets Name of the physician(s) administering this Series.

Parameters:

arrStrPerformingPhysiciansName - String array of Name of the physician(s) administering this Series.

getPerformingPhysiciansName

public java.lang.String[] getPerformingPhysiciansName()

Return Name of the physician(s) administering this Series.

Returns:

String[]- String array of Name of the physician(s) administering this Series.

getPerformingPhysicianIdentificationSequence

public PerformingPhysicianIdentificationSequence getPerformingPhysicianIdentificationSequence()

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

PerformingPhysicianIdentificationSequence - instance of Performing Physician Identification Sequence

setOperatorsName

public void setOperatorsName(java.lang.String[] arrStrOperatorsName)

Sets Name(s) of the operator(s) who supporting this Series.

Parameters:

arrStrOperatorsName - String array of Name(s) of the operator(s).

getOperatorsName

public java.lang.String[] getOperatorsName()

Return Name(s) of the operator(s) who supporting this Series.

Returns:

String[]- String array of Name(s) of the operator(s).

getOperatorIdentificationSequence

public OperatorIdentificationSequence getOperatorIdentificationSequence()

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

OperatorIdentificationSequence - instance of Operator Identification Sequence

setProtocolName

public void setProtocolName(java.lang.String StrProtocolName)

Sets attribute identifies User-defined description of the conditions under which the Series was performed.

Parameters:

StrProtocolName - String User-defined description

getProtocolName

public java.lang.String getProtocolName()

Return User-defined description of the conditions under which the Series was performed.

Returns:

String - User-defined description.

setSeriesInstanceUID

public void setSeriesInstanceUID(java.lang.String StrSeriesInstanceUID)

Sets attribute identifies Unique Identifier of the Series.

Parameters:

StrSeriesInstanceUID - String Unique Identifier.

getSeriesInstanceUID

public java.lang.String getSeriesInstanceUID()

Return Unique Identifier of the Series.

Returns:

String - Unique Identifier.

setSeriesDescription

public void setSeriesDescription(java.lang.String StrSeriesDescription)

Sets attribute identifies User provided description of the Series

Parameters:

StrSeriesDescription - String User provided description

getSeriesDescription

public java.lang.String getSeriesDescription()

Return User provided description of the Series

Returns:

String - User provided description

getSeriesDescriptionCodeSequence

public SeriesDescriptionCodeSequence getSeriesDescriptionCodeSequence()

Retrieves pre-initialized 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.

Returns:

SeriesDescriptionCodeSequence - instance of SeriesDescriptionCodeSequence.

setRetrieveAETitle

public void setRetrieveAETitle(java.lang.String[] arrStrRetrieveAETitle)

Sets Title of the DICOM Application Entity where the Images and Standalone SOP Instances in this Series may be retrieved on the network.

Parameters:

arrStrRetrieveAETitle - String array of Title of the DICOM Application Entity

getRetrieveAETitle

public java.lang.String[] getRetrieveAETitle()

Return Title of the DICOM Application Entity where the Images and Standalone SOP Instances in this Series may be retrieved on the network.

Returns:

String[]- String array of Title of the DICOM Application Entity

setArchiveRequested

public void setArchiveRequested(EnumArchiveRequested enumArchiveRequested)

Sets the ArchiveRequested Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME

Parameters:

enumArchiveRequested - Specifies type of the value encoded in this Item

getArchiveRequested

public java.lang.String getArchiveRequested()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

getReferencedImageSequence

public ReferencedImageSequence getReferencedImageSequence()

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

ReferencedImageSequence - instance of Referenced Image Sequence

getReferencedNonImageCompositeSOPInstanceSequence

public ReferencedNonImageCompositeSOPInstanceSequence getReferencedNonImageCompositeSOPInstanceSequence()

Retrieves pre-initialized object of Referenced Non Image Composite SOP Instance 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:

ReferencedNonImageCompositeSOPInstanceSequence - instance of Referenced Non-Image Composite SOP Instance Sequence