cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class GenericImplantTemplateDescriptionModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GenericImplantTemplateDescriptionModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class GenericImplantTemplateDescriptionModule
extends Module

\* This module is used for Generic Implant Template Description Module.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
GenericImplantTemplateDescriptionModule(IDataSet objIDataSet) Instantiates a new Generic Implant Template Description Module

Method Summary

Methods

Modifier and Type	Method and Description
CoatingMaterialsCodeSequence	getCoatingMaterialsCodeSequence() Retrieves pre-initialized object of CoatingMaterialsCodeSequence.
DerivationImplantTemplateSequence	getDerivationImplantTemplateSequence() Retrieves pre-initialized object of Derivation Implant Template Sequence.
java.lang.String	getEffectiveDateTime() Retrieves Effective DateTime
FixationMethodCodeSequence	getFixationMethodCodeSequence() Retrieves pre-initialized object of FixationMethodCodeSequence.
java.lang.String	getFrameOfReferenceUID() Retrieves a Frame of Reference UID
java.lang.String	getImplantName() Return Implant Name
java.lang.String	getImplantPartNumber() Return Implant Part Number
ImplantRegulatoryDisapprovalCodeSequence	getImplantRegulatoryDisapprovalCodeSequence() Retrieves pre-initialized object of ImplantRegulatoryDisapprovalCodeSequence.
java.lang.String	getImplantSize() Return Implant Size
ImplantTargetAnatomySequence	getImplantTargetAnatomySequence() Retrieves pre-initialized object of Implant TargetAnatomy Sequence.
java.lang.String	getImplantTemplateVersion() Return Implant Template Version
java.lang.String	getImplantType() Return Implant Type
ImplantTypeCodeSequence	getImplantTypeCodeSequence() Retrieves pre-initialized object of ImplantTypeCodeSequence.
InformationFromManufacturerSequence	getInformationFromManufacturerSequence() Retrieves pre-initialized object of InformationFromManufacturerSequence.
java.lang.String	getManufacturer() Return Manufacturer
MaterialsCodeSequence	getMaterialsCodeSequence() Retrieves pre-initialized object of MaterialsCodeSequence.
NotificationFromManufacturerSequence	getNotificationFromManufacturerSequence() Retrieves pre-initialized object of NotificationFromManufacturerSequence.
OriginalImplantTemplateSequence	getOriginalImplantTemplateSequence() Retrieves pre-initialized object of Original Implant Template Sequence.
double	getOverallTemplateSpatialTolerance() Retrieves OverallTemplateSpatialTolerance
ReplacedImplantTemplateSequence	getReplacedImplantTemplateSequence() Retrieves pre-initialized object of Replaced Implant Template Sequence.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setEffectiveDateTime(java.lang.String strEffectiveDateTime) Sets Effective DateTime
void	setFrameOfReferenceUID(java.lang.String strFrameOfReferenceUID) Sets a Frame of Reference UID
void	setImplantName(java.lang.String strImplantName) Sets Implant Name
void	setImplantPartNumber(java.lang.String strImplantSize) Sets Implant Part Number
void	setImplantSize(java.lang.String strImplantSize) Sets Implant Size
void	setImplantTemplateVersion(java.lang.String strImplantTemplateVersion) Sets Implant Template Version
void	setImplantType(EnumImplantType enumImplantType) Sets whether the Implant Template is derived from nother Implant Template.
void	setManufacturer(java.lang.String strManufacturer) Sets Manufacturer
void	setOverallTemplateSpatialTolerance(double dblOverallTemplateSpatialTolerance) Sets the OverallTemplateSpatialTolerance
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

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

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

GenericImplantTemplateDescriptionModule

public GenericImplantTemplateDescriptionModule(IDataSet objIDataSet)

Instantiates a new Generic Implant Template Description Module

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

- returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setManufacturer

public void setManufacturer(java.lang.String strManufacturer)

Sets Manufacturer

Parameters:

strManufacturer - String value of Manufacturer

getManufacturer

public java.lang.String getManufacturer()

Return Manufacturer

Returns:

String - value of Manufacturer

setFrameOfReferenceUID

public void setFrameOfReferenceUID(java.lang.String strFrameOfReferenceUID)

Sets a Frame of Reference UID

Parameters:

strFrameOfReferenceUID - String value of Frame of Reference UID

getFrameOfReferenceUID

public java.lang.String getFrameOfReferenceUID()

Retrieves a Frame of Reference UID

Returns:

String - value of Frame of Reference UID

setImplantName

public void setImplantName(java.lang.String strImplantName)

Sets Implant Name

Parameters:

strImplantName - String value of Implant Name

getImplantName

public java.lang.String getImplantName()

Return Implant Name

Returns:

String - value of Implant Name

setImplantSize

public void setImplantSize(java.lang.String strImplantSize)

Sets Implant Size

Parameters:

strImplantSize - String value of Implant Size

getImplantSize

public java.lang.String getImplantSize()

Return Implant Size

Returns:

String - value of Implant Size

setImplantPartNumber

public void setImplantPartNumber(java.lang.String strImplantSize)

Sets Implant Part Number

Parameters:

strImplantPartNumber - String value of ImplantPartNumber

getImplantPartNumber

public java.lang.String getImplantPartNumber()

Return Implant Part Number

Returns:

String - value of ImplantPartNumber

setImplantTemplateVersion

public void setImplantTemplateVersion(java.lang.String strImplantTemplateVersion)

Sets Implant Template Version

Parameters:

strImplantTemplateVersion - String value of ImplantTemplateVersion

getImplantTemplateVersion

public java.lang.String getImplantTemplateVersion()

Return Implant Template Version

Returns:

String - value of ImplantTemplateVersion

setImplantType

public void setImplantType(EnumImplantType enumImplantType)

Sets whether the Implant Template is derived from nother Implant Template. Enumerated Values: ORIGINAL DERIVED

Parameters:

enumImplantType - enum value of Setup Device Type.

getImplantType

public java.lang.String getImplantType()

Return Implant Type

Returns:

String - value of ImplantType

setEffectiveDateTime

public void setEffectiveDateTime(java.lang.String strEffectiveDateTime)

Sets Effective DateTime

Parameters:

strEffectiveDateTime - String value of Effective DateTime

getEffectiveDateTime

public java.lang.String getEffectiveDateTime()

Retrieves Effective DateTime

Returns:

String - value of Effective DateTime

setOverallTemplateSpatialTolerance

public void setOverallTemplateSpatialTolerance(double dblOverallTemplateSpatialTolerance)

Sets the OverallTemplateSpatialTolerance

Parameters:

dblOverallTemplateSpatialTolerance - Double value of OverallTemplateSpatialTolerance

getOverallTemplateSpatialTolerance

public double getOverallTemplateSpatialTolerance()

Retrieves OverallTemplateSpatialTolerance

Returns:

double - double value of OverallTemplateSpatialTolerance

getReplacedImplantTemplateSequence

public ReplacedImplantTemplateSequence getReplacedImplantTemplateSequence()

Retrieves pre-initialized object of Replaced Implant Template 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:

ReplacedImplantTemplateSequence - Replaced Implant Template Sequence.

getOriginalImplantTemplateSequence

public OriginalImplantTemplateSequence getOriginalImplantTemplateSequence()

Retrieves pre-initialized object of Original Implant Template 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:

OriginalImplantTemplateSequence - Original Implant Template Sequence.

getDerivationImplantTemplateSequence

public DerivationImplantTemplateSequence getDerivationImplantTemplateSequence()

Retrieves pre-initialized object of Derivation Implant Template 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:

DerivationImplantTemplateSequence - Derivation Implant Template Sequence.

getImplantTargetAnatomySequence

public ImplantTargetAnatomySequence getImplantTargetAnatomySequence()

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

ImplantTargetAnatomySequence - Implant TargetAnatomy Sequence

getNotificationFromManufacturerSequence

public NotificationFromManufacturerSequence getNotificationFromManufacturerSequence()

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

NotificationFromManufacturerSequence - NotificationFromManufacturerSequence

getInformationFromManufacturerSequence

public InformationFromManufacturerSequence getInformationFromManufacturerSequence()

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

InformationFromManufacturerSequence

getImplantRegulatoryDisapprovalCodeSequence

public ImplantRegulatoryDisapprovalCodeSequence getImplantRegulatoryDisapprovalCodeSequence()

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

ImplantRegulatoryDisapprovalCodeSequence

getMaterialsCodeSequence

public MaterialsCodeSequence getMaterialsCodeSequence()

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

MaterialsCodeSequence

getCoatingMaterialsCodeSequence

public CoatingMaterialsCodeSequence getCoatingMaterialsCodeSequence()

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

CoatingMaterialsCodeSequence

getImplantTypeCodeSequence

public ImplantTypeCodeSequence getImplantTypeCodeSequence()

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

ImplantTypeCodeSequence

getFixationMethodCodeSequence

public FixationMethodCodeSequence getFixationMethodCodeSequence()

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

FixationMethodCodeSequence

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the collection of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

ISingleCollection - the customized collection containing the dataelement tags that beling to this module