cdac.medinfo.sdk.dcm30_04.baselibs

Class HierarchicalSeriesReferenceMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.HierarchicalSeriesReferenceMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class HierarchicalSeriesReferenceMacro
extends Macro

This class is for Hierarchical Series Reference Macro Attributes.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ReferencedSOPSequence	getReferencedSOPSequence() References to Composite Object SOP Class/SOP Instance pairs thatare part of the Study defined by Study Instance UID and the Seriesdefined by Series Instance UID (0020,000E).
java.lang.String[]	getRetrieveAETitle() Retrieves Retrieve AE Title.
java.lang.String	getRetrieveLocationUID() Retrieves a Unique identifier of the system where the Composite Object(s) maybe retrieved on the network.
java.lang.String	getRetrieveURL() Retrieves URI/URL specifying the location of the referenced instance(s).
java.lang.String	getSeriesInstanceUID() Retrieves Unique identifier of a Series that is part of this Study and contains thereferenced Composite Object(s).
java.lang.String	getStorageMediaFileSetID() Retrieves the user or implementation specific human readable identifier thatidentifies the Storage Media on which the Composite Object (s) reside.
java.lang.String	getStorageMediaFileSetUID() Retrieves a uniquely identified Storage Media on which the Composite Object(s)reside.
void	setRetrieveAETitle(java.lang.String[] strArrRetrieveAETitle) Sets Title of the DICOM Application Entity where the Composite Object(s)may be retrieved on the network.
void	setRetrieveLocationUID(java.lang.String strRetrieveLocationUID) Sets Unique identifier of the system where the Composite Object(s) maybe retrieved on the network.
void	setRetrieveURL(java.lang.String strRetrieveURL) Sets URI/URL specifying the location of the referenced instance(s).
void	setSeriesInstanceUID(java.lang.String strSeriesInstanceUID) Sets Unique identifier of a Series that is part of this Study and contains thereferenced Composite Object(s).
void	setStorageMediaFileSetID(java.lang.String strStorageMediaFileSetID) Sets the user or implementation specific human readable identifier thatidentifies the Storage Media on which the Composite Object (s) reside.
void	setStorageMediaFileSetUID(java.lang.String strStorageMediaFileSetUID) Sets a uniquely identified Storage Media on which the Composite Object(s)reside.
boolean	validate() Validates all the attributes in HierarchicalSeriesReferenceMacro
boolean	validate(IDataSet objIDataSet) Validates all the attributes in HierarchicalSeriesReferenceMacro that are present in the DataSet
boolean	validate(IItem objIItem)

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

HierarchicalSeriesReferenceMacro

public HierarchicalSeriesReferenceMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified Data Set.

Parameters:

objDataSet - Collection of Data Elements

HierarchicalSeriesReferenceMacro

public HierarchicalSeriesReferenceMacro(IDataSet objDataSet,
                                IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified Data Set and Dictionary Reader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

HierarchicalSeriesReferenceMacro

public HierarchicalSeriesReferenceMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

HierarchicalSeriesReferenceMacro

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

setSeriesInstanceUID

public void setSeriesInstanceUID(java.lang.String strSeriesInstanceUID)

Sets Unique identifier of a Series that is part of this Study and contains thereferenced Composite Object(s).

Parameters:

strSeriesInstanceUID - String value of Series Instance UID.

getSeriesInstanceUID

public java.lang.String getSeriesInstanceUID()

Retrieves Unique identifier of a Series that is part of this Study and contains thereferenced Composite Object(s).

Returns:

String - value of Series Instance UID.

setRetrieveAETitle

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

Sets Title of the DICOM Application Entity where the Composite Object(s)may be retrieved on the network.

Parameters:

strArrRetrieveAETitle - String array of Retrieve AE Title.

getRetrieveAETitle

public java.lang.String[] getRetrieveAETitle()

Retrieves Retrieve AE Title.

Returns:

String - value of Retrieve AE Title.

setRetrieveLocationUID

public void setRetrieveLocationUID(java.lang.String strRetrieveLocationUID)

Sets Unique identifier of the system where the Composite Object(s) maybe retrieved on the network.

Parameters:

strRetrieveLocationUID - String value of Retrieve Location UID.

getRetrieveLocationUID

public java.lang.String getRetrieveLocationUID()

Retrieves a Unique identifier of the system where the Composite Object(s) maybe retrieved on the network.

Returns:

String - value of Retrieve Location UID.

setRetrieveURL

public void setRetrieveURL(java.lang.String strRetrieveURL)

Sets URI/URL specifying the location of the referenced instance(s).

Parameters:

strRetrieveURL - String value of Retrieve URL.

getRetrieveURL

public java.lang.String getRetrieveURL()

Retrieves URI/URL specifying the location of the referenced instance(s).

Returns:

String - value of Retrieve URL.

setStorageMediaFileSetID

public void setStorageMediaFileSetID(java.lang.String strStorageMediaFileSetID)

Sets the user or implementation specific human readable identifier thatidentifies the Storage Media on which the Composite Object (s) reside.

Parameters:

strStorageMediaFileSetID -

getStorageMediaFileSetID

public java.lang.String getStorageMediaFileSetID()

Retrieves the user or implementation specific human readable identifier thatidentifies the Storage Media on which the Composite Object (s) reside.

Returns:

String - value of Storage Media File-Set ID.

setStorageMediaFileSetUID

public void setStorageMediaFileSetUID(java.lang.String strStorageMediaFileSetUID)

Sets a uniquely identified Storage Media on which the Composite Object(s)reside.

Parameters:

strStorageMediaFileSetUID - String value ofStorage Media File-Set UID.

getStorageMediaFileSetUID

public java.lang.String getStorageMediaFileSetUID()

Retrieves a uniquely identified Storage Media on which the Composite Object(s)reside.

Returns:

String - value of Storage Media File-Set UID.

getReferencedSOPSequence

public ReferencedSOPSequence getReferencedSOPSequence()

References to Composite Object SOP Class/SOP Instance pairs thatare part of the Study defined by Study Instance UID and the Seriesdefined by Series Instance UID (0020,000E).

Returns:

ReferencedSOPSequence - instance of ReferencedSOPSequence.

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in HierarchicalSeriesReferenceMacro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public boolean validate(IDataSet objIDataSet)
                 throws InvalidMacroException

Validates all the attributes in HierarchicalSeriesReferenceMacro 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 boolean validate(IItem objIItem)
                 throws InvalidMacroException

Throws:

InvalidMacroException