cdac.medinfo.sdk.dcm30_04.baselibs

Class ContentIdentificationMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.ContentIdentificationMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class ContentIdentificationMacro
extends Macro

This class contains the macro which describe the attributes for identifying a SOP Instance potentially created by a human user interacting with an application.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
AlternateContentDescriptionSequence	getAlternateContentDescriptionSequence() Retrieves pre-initialized object of Alternate Content 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.
ContentCreatorsIdentificationCodeSequence	getContentCreatorsIdentificationCodeSequence() Retrieves pre-initialized object of Content Creators Identification 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	getContentCreatorsName() Retrieves Content Creators Name.
java.lang.String	getContentDescription() Return Content Description.
java.lang.String	getContentLabel() Retrieves Content Label.
java.lang.String	getInstanceNumber() Retrieves Instance Number.
void	setContentCreatorsName(java.lang.String strContentCreatorsName) Sets Content Creators Name.
void	setContentDescription(java.lang.String strRescaleType) Sets Content Description.
void	setContentLabel(java.lang.String strContentLabel) Sets the Content Label.
void	setInstanceNumber(java.lang.String strInstanceNumber) Sets Instance Number.
boolean	validate() Validates all the attributes in ContentIdentificationMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in ContentIdentificationMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in ContentIdentificationMacro 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

ContentIdentificationMacro

public ContentIdentificationMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

ContentIdentificationMacro

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

ContentIdentificationMacro

public ContentIdentificationMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

ContentIdentificationMacro

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

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in ContentIdentificationMacro

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 ContentIdentificationMacro 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 ContentIdentificationMacro 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.

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

Sets Instance Number. A number that identifies this SOP Instance.

Parameters:

strInstanceNumber - String value of Instance Number.

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves Instance Number. A number that identifies this SOP Instance.

Returns:

String - value of Instance Number.

setContentLabel

public void setContentLabel(java.lang.String strContentLabel)

Sets the Content Label. A label that is used to identify this SOP Instance.

Parameters:

strContentLabel - Specifies Content Label

getContentLabel

public java.lang.String getContentLabel()

Retrieves Content Label. A label that is used to identify this SOP Instance.

Returns:

String - Content Label

setContentDescription

public void setContentDescription(java.lang.String strRescaleType)

Sets Content Description. A description of the content of the SOP Instance.

Parameters:

strRescaleType - String value of Content Description.

getContentDescription

public java.lang.String getContentDescription()

Return Content Description. A description of the content of the SOP Instance.

Returns:

String - value of Content Description.

getAlternateContentDescriptionSequence

public AlternateContentDescriptionSequence getAlternateContentDescriptionSequence()

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

AlternateContentDescriptionSequence - instance of AlternateContentDescriptionSequence.

setContentCreatorsName

public void setContentCreatorsName(java.lang.String strContentCreatorsName)

Sets Content Creators Name. Name of operator (such as a technologist or physician) creating the content of the SOP Instance.

Parameters:

strContentCreatorsName - String Content Creators Name.

getContentCreatorsName

public java.lang.String getContentCreatorsName()

Retrieves Content Creators Name. Name of operator (such as a technologist or physician) creating the content of the SOP Instance.

Returns:

String - Content Creators Name.

getContentCreatorsIdentificationCodeSequence

public ContentCreatorsIdentificationCodeSequence getContentCreatorsIdentificationCodeSequence()

Retrieves pre-initialized object of Content Creators Identification 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:

ContentCreatorsIdentificationCodeSequence - instance of ContentCreatorsIdentificationCodeSequence.