cdac.medinfo.sdk.dcm30_04.baselibs

Class TemplateIdentificationMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.TemplateIdentificationMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class TemplateIdentificationMacro
extends Macro

Template Identification Macro specifies the set of Attributes that identify Templates. These Attributes comprise the Template Macro.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getMappingResource() Return Mapping Resource that defines the template.
java.lang.String	getTemplateIdentifier() Return Template identifier.
void	setMappingResource(java.lang.String strMappingResource) Sets Mapping Resource that defines the template.
void	setTemplateIdentifier(java.lang.String strTemplateIdentifier) Sets Template identifier.
boolean	validate() Validates all the attributes in Template Identification Macro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in Template Identification Macro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in Template Identification 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

TemplateIdentificationMacro

public TemplateIdentificationMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

TemplateIdentificationMacro

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

TemplateIdentificationMacro

public TemplateIdentificationMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

TemplateIdentificationMacro

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

setTemplateIdentifier

public void setTemplateIdentifier(java.lang.String strTemplateIdentifier)

Sets Template identifier.

Parameters:

strTemplateIdentifier - String value of Template identifier

getTemplateIdentifier

public java.lang.String getTemplateIdentifier()

Return Template identifier.

Returns:

String - value of Template identifier

setMappingResource

public void setMappingResource(java.lang.String strMappingResource)

Sets Mapping Resource that defines the template.

Parameters:

strMappingResource - String value of Mapping Resource

getMappingResource

public java.lang.String getMappingResource()

Return Mapping Resource that defines the template.

Returns:

String - value of Mapping Resource

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in Template Identification Macro

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 Template Identification 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 static boolean validate(IItem objIItem)
                        throws InvalidMacroException

Validates all the attributes in Template Identification 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.