cdac.medinfo.sdk.dcm30_04.baselibs

Class ImageReferenceMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.ImageReferenceMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class ImageReferenceMacro
extends Macro

This macro specifies the Attributes that convey a reference to a DICOM image.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CompositeObjectReferenceMacro	getCompositeObjectReferenceMacro() Retrieves the instance of Composite Object Reference Macro.
IconImageSequence	getIconImageSequence() Retrieves pre-initialized object of Icon Image Sequence.
java.lang.String[]	getReferencedFrameNumber() Return array of Referenced Frame Number
ReferencedSOPSequence	getReferencedSOPSequence() Retrieves pre-initialized object of Referenced SOP Sequence.
void	setReferencedFrameNumber(java.lang.String[] arrStrReferencedFrameNumber) Identifies the frame numbers within the Referenced SOP Instance to which the reference applies.
boolean	validate() Validates all the attributes in Image Reference Macro
boolean	validate(IDataSet objIDataSet) Validates all the attributes in Image Reference Macro that are present in the DataSet
boolean	validate(IItem objIItem) Validates all the attributes in Image Reference 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

ImageReferenceMacro

public ImageReferenceMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

ImageReferenceMacro

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

ImageReferenceMacro

public ImageReferenceMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

ImageReferenceMacro

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

getCompositeObjectReferenceMacro

public CompositeObjectReferenceMacro getCompositeObjectReferenceMacro()

Retrieves the instance of Composite Object Reference Macro. If the instance is not already present a new instance is created and returned. It is used to set the attribtues of Composite Object Reference Macro.

Returns:

- instance of CompositeObjectReferenceMacro.

setReferencedFrameNumber

public void setReferencedFrameNumber(java.lang.String[] arrStrReferencedFrameNumber)

Identifies the frame numbers within the Referenced SOP Instance to which the reference applies. The first frame shall be denoted as frame number 1.

Parameters:

arrStrReferencedFrameNumber - String array of Referenced Frame Number

getReferencedFrameNumber

public java.lang.String[] getReferencedFrameNumber()

Return array of Referenced Frame Number

Returns:

String - array of Referenced Frame Number

getReferencedSOPSequence

public ReferencedSOPSequence getReferencedSOPSequence()

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

ReferencedSOPSequence - instance of Referenced SOP Sequence.

getIconImageSequence

public IconImageSequence getIconImageSequence()

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

IconImageSequence - instance of Icon Image Sequence.

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in Image Reference Macro

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 Image Reference 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 boolean validate(IItem objIItem)
                 throws InvalidMacroException

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