Module

java.lang.Object
- cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

Direct Known Subclasses:

AcquisitionContextModule, AnnotationListModule, ApprovalModule, AudioModule, AutorefractionMeasurementsModule, AutorefractionMeasurementsSeriesModule, BasicAnnotationPresentationModule, BasicFilmBoxPresentationModule, BasicFilmBoxRelationshipModule, BasicFilmSessionPresentationModule, BasicFilmSessionRelationshipModule, BasicPrintImageOverlayBoxModule, BillingandMaterialManagementCodesModule, BitmapDisplayShutterModule, BreastTomosynthesisAcquisitionModule, BreastTomosynthesisContributingSourcesModule, BreastViewModule, BulkMotionSynchronizationModule, CalculatedDoseReferenceRecordModule, CardiacSynchronizationModule, CineModule, ClinicalTrialSeriesModule, ClinicalTrialStudyModule, ClinicalTrialSubjectModule, ColorPaletteDefinitionModule, CommonInstanceReferenceModule, ContrastBolusModule, CornealTopographyMapAnalysisModule, CornealTopographyMapImageModule, CornealTopographyMapSeriesModule, CRImageModule, CRSeriesModule, CTImageModule, CTSeriesModule, CurveIdentificationModule, CurveModule, DeformableSpatialRegistrationModule, DeviceModule, DirectoryInformationModule, DisplayedAreaModule, DisplayShutterModule, DisplaySystemModule, DoubleFloatingPointImagePixelModule, DXAnatomyImagedModule, DXDetectorModule, DXImageModule, DXPositioningModule, DXSeriesModule, EncapsulatedDocumentModule, EncapsulatedDocumentSeriesModule, EnhancedContrastBolusModule, EnhancedCTImageModule, EnhancedGeneralEquipmentModule, EnhancedMammographyImageModule, EnhancedMammographySeriesModule, EnhancedMRImageModule, EnhancedPaletteColorLookupTableModule, EnhancedPETAcquisitionModule, EnhancedPETCorrectionsModule, EnhancedPETImageModule, EnhancedPETIsotopeModule, EnhancedPETSeriesModule, EnhancedSeriesModule, EnhancedUSImageModule, EnhancedUSSeriesModule, EnhancedXAOrXRFImageModule, ExcludedIntervalsModule, FileSetIdentificationModule, FilmBoxModule, FloatingPointImagePixelModule, FrameExtractionModule, FrameOfReferenceModule, FramePointersModule, GeneralEquipmentModule, GeneralImageModule, GeneralOphthalmicRefractiveMeasurementsModule, GeneralPurposePerformedProcedureStepInformationModule, GeneralPurposePerformedProcedureStepRelationshipModule, GeneralPurposeResultsModule, GeneralPurposeScheduledProcedureStepInformationModule, GeneralPurposeScheduledProcedureStepRelationshipModule, GeneralQueueModule, GeneralSeriesModule, GeneralStudyModule, GenericImplantTemplate2DDrawingsModule, GenericImplantTemplate3DModelsModule, GenericImplantTemplateDescriptionModule, GenericImplantTemplateMatingFeaturesModule, GenericImplantTemplatePlanningLandmarksModule, GraphicAnnotationModule, GraphicGroupModule, GraphicLayerModule, HangingProtocolDefinitionModule, HangingProtocolDisplayModule, HangingProtocolEnvironmentModule, HardcopyEquipmentModule, HardcopyGrayscaleImageModule, HCColorImageModule, ICCProfileModule, ImageAcquisitionResultsModule, ImageBoxListModule, ImageBoxPixelPresentationModule, ImageEquipmentCoordinateRelationshipModule, ImageHistogramModule, ImageOverlayBoxListModule, ImagePixelModule, ImagePlaneModule, ImagingServiceRequestModule, ImplantAssemblyTemplateModule, ImplantTemplateGroupModule, InstanceAvailabilityNotificationModule, InterpretationApprovalModule, InterpretationIdentificationModule, InterpretationRecordingModule, InterpretationRelationshipModule, InterpretationStateModule, InterpretationTranscriptionModule, InterventionModule, IntraocularLensCalculationsModule, IntraocularLensCalculationsSeriesModule, IntraOralImageModule, IntraOralSeriesModule, IntravascularImageAcquisitionParametersModule, IntravascularOCTAcquisitionParametersModule, IntravascularOCTImageModule, IntravascularOCTProcessingParametersModule, IntravascularOCTSeriesModule, IVUSImageModule, KeratometryMeasurementsModule, KeratometryMeasurementsSeriesModule, KeyObjectDocumentModule, KeyObjectDocumentSeriesModule, LensometryMeasurementsModule, LensometryMeasurementsSeriesModule, LUTIdentificationModule, MammographyImageModule, MammographySeriesModule, MaskModule, MeasuredDoseReferenceRecordModule, MediaCreationManagementModule, ModalityLUTModule, MRImageModule, MRPulseSequenceModule, MRSeriesModule, MRSpectroscopyDataModule, MRSpectroscopyModule, MRSpectroscopyPulseSequenceModule, MultiFrameDimensionModule, MultiFrameFunctionalGroupsModule, MultiFrameModule, MultiFrameOverlayModule, MultiResolutionNavigationModule, NMDetectorModule, NMImageModule, NMImagePixelModule, NMIsotopeModule, NMMultiFrameModule, NMMultiGatedAcquisitionModule, NMOrPETPatientOrientationModule, NMPhaseModule, NMReconstructionModule, NMTOMOAcquisitionModule, OcularRegionImagedModule, OphthalmicAxialMeasurementsModule, OphthalmicAxialMeasurementsSeriesModule, OphthalmicPatientClinicalInformationandTestLensParametersModule, OphthalmicPhotographicParametersModule, OphthalmicPhotographyAcquisitionParametersModule, OphthalmicPhotographyImageModule, OphthalmicPhotographySeriesModule, OphthalmicThicknessMapModule, OphthalmicThicknessMapQualityRatingModule, OphthalmicThicknessMapSeriesModule, OphthalmicTomographyAcquisitionParametersModule, OphthalmicTomographyImageModule, OphthalmicTomographyParametersModule, OphthalmicTomographySeriesModule, OpticalPathModule, OpticalSurfaceScannerSeriesModule, OverlayActivationModule, OverlayCurveActivationModule, OverlayIdentificationModule, OverlayPlaneModule, PaletteColorLookupTableModule, ParametricMapImageModule, ParametricMapSeriesModule, PatientDemographicModule, PatientIdentificationModule, PatientMedicalModule, PatientModule, PatientOrientationModule, PatientRelationshipModule, PatientStudyModule, PatientSummaryModule, PerformedProcedureStepInformationModule, PerformedProcedureStepRelationshipModule, PETCurveModule, PETImageModule, PETIsotopeModule, PETMultiGatedAcquisitionModule, PETSeriesModule, PointCloudModule, PresentationLUTListModule, PresentationLUTModule, PresentationSeriesModule, PresentationStateBlendingModule, PresentationStateIdentificationModule, PresentationStateMaskModule, PresentationStateModule, PresentationStateRelationshipModule, PresentationStateShutterModule, PrinterCharacteristicsModule, PrinterConfigurationModule, PrinterModule, PrintJobModule, PrintQueueModule, PrintRequestModule, ProductCharacteristicsModule, QAResultsModule, RadiationDoseModule, RawDataModule, RealWorldValueMappingModule, RealWorldValueMappingSeriesModule, RequestedProcedureModule, RespiratorySynchronizationModule, ResultsIdentificationModule, ResultsImpressionModule, ResultsRelationshipModule, ROIContourModule, RTBeamsDeliveryInstructionModule, RTBeamsModule, RTBeamsSessionRecordModule, RTBrachyApplicationSetupsModule, RTBrachySessionRecordModule, RTConventionalMachineVerificationModule, RTDoseModule, RTDoseROIModule, RTDVHModule, RTFractionSchemeModule, RTGeneralMachineVerificationModule, RTGeneralPlanModule, RTGeneralTreatmentRecordModule, RTImageModule, RTIonBeamsModule, RTIonBeamsSessionRecordModule, RTIonMachineVerificationModule, RTIonToleranceTablesModule, RTPatientSetupModule, RTPrescriptionModule, RTROIObservationsModule, RTSeriesModule, RTToleranceTablesModule, RTTreatmentMachineRecordModule, RTTreatmentSummaryRecordModule, ScanProcedureModule, SCEquipmentModule, ScheduledProcedureStepModule, SCImageModule, SCMultiFrameImageModule, SCMultiFrameVectorModule, SegmentationImageModule, SegmentationSeriesModule, SlideCoordinatesModule, SlideLabelModule, SoftcopyPresentationLUTModule, SoftcopyVOILUTModule, SOPCommonModule, SpatialFiducialsModule, SpatialFiducialsSeriesModule, SpatialRegistrationModule, SpatialRegistrationSeriesModule, SpatialTransformationModule, SpecimenIdentificationModule, SpecimenModule, SRDocumentContentModule, SRDocumentGeneralModule, SRDocumentSeriesModule, StereometricRelationshipModule, StereometricSeriesModule, StorageCommitmentModule, StructuredDisplayAnnotationModule, StructuredDisplayImageBoxModule, StructuredDisplayModule, StructureSetModule, StudyAcquisitionModule, StudyClassificationModule, StudyComponentAcquisitionModule, StudyComponentModule, StudyComponentRelationshipModule, StudyContentModule, StudyIdentificationModule, StudyReadModule, StudyRelationshipModule, StudySchedulingModule, SubjectiveRefractionMeasurementsModule, SubjectiveRefractionMeasurementsSeriesModule, SubstanceAdministrationLogModule, SubstanceAdministrationModule, SubstanceApprovalModule, SupplementalPaletteColorLookupTableModule, SurfaceMeshModule, SurfaceSegmentationModule, SynchronizationModule, TargetLuminanceCharacteristicsModule, UltrasoundFrameofReferenceModule, UnifiedProcedureStepPerformedProcedureInformationModule, UnifiedProcedureStepProgressInformationModule, UnifiedProcedureStepRelationshipModule, UnifiedProcedureStepScheduledProcedureInformationModule, USImageModule, USRegionCalibrationModule, UVMappingModule, VisitAdmissionModule, VisitDischargeModule, VisitIdentificationModule, VisitRelationshipModule, VisitSchedulingModule, VisitStatusModule, VisualAcuityMeasurementsModule, VisualAcuityMeasurementsSeriesModule, VisualFieldStaticPerimetryMeasurementsSeriesModule, VisualFieldStaticPerimetryTestMeasurementsModule, VisualFieldStaticPerimetryTestParametersModule, VisualFieldStaticPerimetryTestReliabilityModule, VisualFieldStaticPerimetryTestResultsModule, VLImageModule, VOILUTModule, WaveformAnnotationModule, WaveformIdentificationModule, WaveformModule, WholeSlideMicroscopyImageModule, WholeSlideMicroscopySeriesModule, WideFieldOphthalmicPhotography3DCoordinatesModule, WideFieldOphthalmicPhotographyQualityRatingModule, WideFieldOphthalmicPhotographyStereographicProjectionModule, XAOrXRFAcquisitionModule, XAOrXRFMultiframePresentationModule, XAOrXRFSeriesModule, XAPositionerModule, XAXRFPresentationStateMaskModule, XAXRFPresentationStatePresentationModule, XAXRFPresentationStateShutterModule, XRay3DAngiographicAcquisitionModule, XRay3DAngiographicImageContributingSourcesModule, XRay3DCraniofacialAcquisitionModule, XRay3DCraniofacialImageContributingSourcesModule, XRay3DImageModule, XRay3DReconstructionModule, XRayAcquisitionDoseModule, XRayAcquisitionModule, XRayCollimatorModule, XRayDetectorModule, XRayFiltrationModule, XRayGenerationModule, XRayGridModule, XRayImageIntensifierModule, XRayImageModule, XRayTableModule, XRayTomographyAcquisitionModule, XRFPositionerModule
```
public abstract class Module
extends java.lang.Object
implements IModule
```
This class provides basic functionality needed by all the modules i.e. Adding DataElement, validating module, iterating over the

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(java.lang.String strDataElementName, java.lang.Object objValue)` This method adds the data element in module.
`void`	`dumpDICOMInfo(IDicomStream objIDicomStream)` This method dumps all Attributes of the Module in readable form to the specified Stream.
`IDictionaryReader`	`getDictionaryReader()` Returns the DictionaryReader instance.
`ITransferSyntax`	`getTransferSyntax()` Retrieves the TransferSyntax.
`ISingleCollection<ITag>`	`getVectorOfKeys()` Gets the vector of keys.
`boolean`	`isPresent(int iGroupNumber, int iElementNumber)` Checks if the DataElement for the given GroupNumber,ElementNumber pair exists in the Module.
`boolean`	`isPresent(java.lang.String strDataElementName)` Checks if the DataElement is present in the Module.
`ICollectionIterator<IDataElement>`	`iterator()` This method returns the iterator over the Module.
`boolean`	`remove(java.lang.String strDataElementName, boolean isForeceFullyDelete)` This method removes the data element from module.
`abstract boolean`	`validateModule()` Validates the Module's DataElement according to Dicom Standard.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - validateModule
```
public abstract boolean validateModule()
```
    Description copied from interface: IModule
    
    Validates the Module's DataElement according to Dicom Standard.
    
    Specified by:
    
    validateModule in interface IModule
    
    Returns:
    boolean - shows status as success or failure.
  - getDictionaryReader
```
public IDictionaryReader getDictionaryReader()
```
    Returns the DictionaryReader instance.
    
    Returns:
    the dictionary reader
  - remove
```
public boolean remove(java.lang.String strDataElementName,
             boolean isForeceFullyDelete)
```
    This method removes the data element from module. If the data element is part of module it is deleted, otherwise it is not deleted. The removal of data element from the data set is according to the boolean variable passed. If boolean variable isForeceFullyDelete is true the data element is forcefully deleted from the module irrespective of DICOM validation rules. If boolean variable isForeceFullyDelete is false then removal is done based on DICOM Validation rules. In this case if the removal of the data element makes the module invalid then it is not deleted.
    
    Parameters:
    strDataElementName - Data Element Name that is to be removed from the module.
    isForceFullyDelete - boolean variable which decides to delete the data element forcefully or not. if isForceFullyDelete is true then the data element is forcefully deleted. if isForceFullyDelete is false then the data element is deleted based on Validation Mode specified (LOW/HIGH/STRICT)
    
    Returns:
    boolean - returns true if the data element strDataElementName is deleted from the module otherwise false is returned.
  - add
```
public boolean add(java.lang.String strDataElementName,
          java.lang.Object objValue)
```
    This method adds the data element in module. If the data element is part of module it is added, otherwise it is not added.
    
    Parameters:
    strDataElementName - Data Element Name that is to be added to the module.
    objValue - - The value of the data element to be added in data set.
    
    Returns:
    boolean - true if the data element is added in module other wise false is returned.
  - iterator
```
public ICollectionIterator<IDataElement> iterator()
```
    This method returns the iterator over the Module.
    
    Specified by:
    
    iterator in interface ICollectionIterable
    
    Specified by:
    
    iterator in interface java.lang.Iterable
    
    Returns:
    the i collection iterator< i data element>
  - getVectorOfKeys
```
public ISingleCollection<ITag> getVectorOfKeys()
```
    Gets the vector of keys.
    
    Returns:
    the vector of keys
  - isPresent
```
public boolean isPresent(int iGroupNumber,
                int iElementNumber)
```
    Checks if the DataElement for the given GroupNumber,ElementNumber pair exists in the Module.
    
    Parameters:
    iGroupNumber - - Group Number of the DataElement.
    iElementNumber - - Element Number of the DataElement.
    
    Returns:
    - true,if DataElement is present. false, if DataElement is absent.
  - isPresent
```
public boolean isPresent(java.lang.String strDataElementName)
```
    Checks if the DataElement is present in the Module.
    
    Parameters:
    strDataElementName - - Name of the Data Element.
    
    Returns:
    - true,if DataElement is present. false, if DataElement is absent.
  - getTransferSyntax
```
public ITransferSyntax getTransferSyntax()
```
    Retrieves the TransferSyntax.
    
    Returns:
    ITransferSyntax- instance of TransferSyntax.
  - dumpDICOMInfo
```
public void dumpDICOMInfo(IDicomStream objIDicomStream)
                   throws java.io.IOException
```
    This method dumps all Attributes of the Module in readable form to the specified Stream.
    
    Parameters:
    objIDicomStream - : the Stream on which the Data is to be written.
    
    Throws:
    
    java.io.IOException

Class Module

Method Summary

Methods inherited from class java.lang.Object

Method Detail

validateModule

getDictionaryReader

remove

add

iterator

getVectorOfKeys

isPresent

isPresent

getTransferSyntax

dumpDICOMInfo