/*******************************************************************************
 *  Copyright 2017-2018 Centre for Development of Advanced Computing(C-DAC), Pune
 *  
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *  
 *   http://www.apache.org/licenses/LICENSE-2.0
 *  
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
package cdac.medinfo.sdk.dcm30_04.dicommodel.visiblelight;

import java.io.IOException;
import java.util.Locale;

import cdac.medinfo.sdk.dcm30_04.baselibs.CodeSequenceMacroDependentItem;
import cdac.medinfo.sdk.dcm30_04.baselibs.OpticalPathSequenceItem;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDicomStream;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IItem;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.AcquisitionContextModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ClinicalTrialSeriesModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ClinicalTrialStudyModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ClinicalTrialSubjectModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CommonInstanceReferenceModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.EnhancedGeneralEquipmentModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.FrameExtractionModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.FrameOfReferenceModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralEquipmentModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralImageModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralSeriesModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralStudyModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImageIOD;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImagePixelModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MultiFrameDimensionModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MultiFrameFunctionalGroupsModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MultiResolutionNavigationModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.OpticalPathModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PatientModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PatientStudyModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SOPCommonModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SlideLabelModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SpecimenModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.WholeSlideMicroscopyImageModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.WholeSlideMicroscopySeriesModule;
import cdac.medinfo.sdk.dcm30_04.enums.EnumModuleNames;
import cdac.medinfo.sdk.dcm30_04.enums.EnumSOPClassUIDs;

import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidIODException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
import cdac.medinfo.sdk.dcm30_04.exceptions.ParseException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConfig;
import cdac.medinfo.sdk.dcm30_04.utils.DicomLogger;
import cdac.medinfo.sdk.dcm30_04.utils.ICollectionIterator;
import cdac.medinfo.sdk.dcm30_04.utils.ResourceBundleWrapper;
/**
 * The VL Whole Slide Microscopy Image IOD specifies the Attributes of a multi-frame visible light whole slide microscopy image encodedas a tiled decomposition.
 * @author saloni
 *
 */
public class VLWholeSlideMicroscopyImageIOD extends ImageIOD 
{
	
	/**
	 * The Constant VL_WHOLE_SLIDE_MICROSCOPY_IMAGE_IOD.
	 */
	public static final String VL_WHOLE_SLIDE_MICROSCOPY_IMAGE_IOD = "VL Whole Slide Microscopy Image IOD";

	
	/**
	 * The obj Whole Slide Microscopy Series module.
	 */
	WholeSlideMicroscopySeriesModule objWholeSlideMicroscopySeriesModule ;
	
	/**
	 * The obj clinical trial series module.
	 */
	ClinicalTrialSeriesModule objClinicalTrialSeriesModule;
	
	/**
	 * The obj frame of reference module.
	 */
	FrameOfReferenceModule objFrameOfReferenceModule = null;
	
	/**
	 * The obj general equipment module.
	 */
	GeneralEquipmentModule objGeneralEquipmentModule = null;

	/**
	 * The obj Enhanced General Equipment module.
	 */
	EnhancedGeneralEquipmentModule objEnhancedGeneralEquipmentModule = null;

	/**
	 * The obj general image module.
	 */
	GeneralImageModule objGeneralImageModule = null;

	/**
	 * The obj acquisition context module.
	 */
	AcquisitionContextModule objAcquisitionContextModule = null;
	
	/**
	 * The obj multi frame functional groups module.
	 */
	MultiFrameFunctionalGroupsModule objMultiFrameFunctionalGroupsModule;

	/**
	 * The obj multi frame dimension module.
	 */
	MultiFrameDimensionModule objMultiFrameDimensionModule;
	
	/**
	 * The obj specimen  module.
	 */
	SpecimenModule objSpecimenModule = null;

	/**
	 * The obj Whole Slide Microscopy Image module.
	 */
	WholeSlideMicroscopyImageModule objWholeSlideMicroscopyImageModule ;
	
	/**
	 * The obj sop common module.
	 */
	SOPCommonModule objSOPCommonModule;

	/**
	 * The obj Optical Path module.
	 */
	OpticalPathModule objOpticalPathModule = null;

	/**
	 * The obj Multi-Resolution Navigation module.
	 */
	MultiResolutionNavigationModule objMultiResolutionNavigationModule;

	/**
	 * The obj Slide Label module.
	 */
	SlideLabelModule objSlideLabelModule;
	
	/**
	 * The obj Common Instance Reference Module.
	 */
	CommonInstanceReferenceModule objCommonInstanceReferenceModule = null;

	/**
	 * The obj Frame Extraction Module .
	 */
	FrameExtractionModule objFrameExtractionModule = null;
	
	/**
	 * Instantiates a new VL Whole Slide Microscopy Image IOD.
	 */
	public VLWholeSlideMicroscopyImageIOD()
	{
		super();
	}

	/**
	 * This constructor initializes the TransferSyntax  in its superclass IOD.
	 * 
	 * @param objITransferSyntax_ - specifies the DICOM Standard defined TransfeSyntax.
	 */
	public VLWholeSlideMicroscopyImageIOD(ITransferSyntax objITransferSyntax_)
	{
		super(objITransferSyntax_);
	}

	/**
	 * This constructor initializes the  DictionaryReader
	 * in its superclass IOD.
	 * 
	 * @param objIDictionaryReader_ - specifies the DICOM Dictionary reader to be used .
	 */
	public VLWholeSlideMicroscopyImageIOD(IDictionaryReader objIDictionaryReader_)
	{
		super(objIDictionaryReader_);
	}

	/**
	 * This constructor accepts the DataSet from the user   in its superclass IOD.
	 * 
	 * @param objIDataSet_ - specifies the data set to be set in the IOD.
	 */
	public VLWholeSlideMicroscopyImageIOD(IDataSet objIDataSet_)
	{
		super(objIDataSet_);
	}

	/**
	 * This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
	 * 
	 * @param objITransferSyntax_ specifies the DICOM Standard defined TransfeSyntax.
	 * @param objIDictionaryReader_ specifies the DICOM Dictionary reader to be used .
	 */
	public VLWholeSlideMicroscopyImageIOD(ITransferSyntax objITransferSyntax_,IDictionaryReader objIDictionaryReader_)
	{
		super(objITransferSyntax_,objIDictionaryReader_);
	}

	/**
	 * Creates VLWholeSlideMicroscopyImageIOD IOD from a DICOM file containing VLWholeSlideMicroscopyImageIOD DICOM data.
	 * @param strFileName DICOM File with absolute path.
	 * @throws IOException Exception caused due to wrong I/O operations. 
	 * @throws ParseException signals if some parse exceptions are occurred.
	 * @throws InvalidIODException signals if some IOD exceptions are occurred.
	 */
	public VLWholeSlideMicroscopyImageIOD(String strFileName)throws IOException,InvalidIODException
	{
		super(strFileName);
		try
		{
			if(objIDataSet != null)
			{
				String strSOPClassUID = objIDataSet.getSOPClassUID();
				if(strSOPClassUID != null)
				{
					if(!strSOPClassUID.equals(EnumSOPClassUIDs.VLWHOLESLIDEMICROSCOPYIMAGEIOD.getValue()))
					{
						throw new InvalidIODException(ResourceBundleWrapper.getValue("exceptions", "InvalidIOD.FileNotMatched", new Locale(DicomConfig.createInstance().getLocale())) + VL_WHOLE_SLIDE_MICROSCOPY_IMAGE_IOD);
					}
				}
				strSOPClassUID = null;
			}
		}
		catch(InvalidIODException iie)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(iie.getMessage());
			}
			throw iie;
		}
	}
	/**
	 * Retrieves pre-initialized instance of objClinicalTrialSeriesModule. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return objClinicalTrialSeriesModule - instance of {@link objClinicalTrialSeriesModule}.
	 */
	public ClinicalTrialSeriesModule getClinicalTrialSeriesModule() 
	{
		if(objClinicalTrialSeriesModule == null)
		{
			objClinicalTrialSeriesModule = new ClinicalTrialSeriesModule(objIDataSet);
			return objClinicalTrialSeriesModule;
		}
		return objClinicalTrialSeriesModule;
	}
	/**
	 * Retrieves pre-initialized instance of Frame Of Reference Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return FrameOfReferenceModule - instance of {@link FrameOfReferenceModule}.
	 */
	public FrameOfReferenceModule getFrameOfReferenceModule() 
	{
		if(objFrameOfReferenceModule == null)
		{
			objFrameOfReferenceModule = new FrameOfReferenceModule(objIDataSet);
			return objFrameOfReferenceModule;
		}
		return objFrameOfReferenceModule;
	}
	/**
	 * Retrieves pre-initialized instance of GeneralEquipmentModule. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return GeneralEquipmentModule - instance of {@link GeneralEquipmentModule}.
	 */
	public GeneralEquipmentModule getGeneralEquipmentModule() 
	{
		if(objGeneralEquipmentModule == null)
		{
			objGeneralEquipmentModule = new GeneralEquipmentModule(objIDataSet);
			return objGeneralEquipmentModule;
		}
		return objGeneralEquipmentModule;
	}
	
	/**
	 * Retrieves pre-initialized instance of EnhancedGeneralEquipmentModule. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return EnhancedGeneralEquipmentModule - instance of {@link EnhancedGeneralEquipmentModule}.
	 */
	public EnhancedGeneralEquipmentModule getEnhancedGeneralEquipmentModule() 
	{
		if(objEnhancedGeneralEquipmentModule == null)
		{
			objEnhancedGeneralEquipmentModule = new EnhancedGeneralEquipmentModule(objIDataSet);
			return objEnhancedGeneralEquipmentModule;
		}
		return objEnhancedGeneralEquipmentModule;
	}

	/**
	 * Retrieves pre-initialized instance of Whole Slide Microscopy Series Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return WholeSlideMicroscopySeriesModule - instance of {@link WholeSlideMicroscopySeriesModule}.
	 */
	public WholeSlideMicroscopySeriesModule getWholeSlideMicroscopySeriesModule()
	{
		if(objWholeSlideMicroscopySeriesModule == null)
		{
			objWholeSlideMicroscopySeriesModule = new WholeSlideMicroscopySeriesModule(objIDataSet);
			return objWholeSlideMicroscopySeriesModule;
		}
		return objWholeSlideMicroscopySeriesModule;
	}
	/**
	 * Retrieves pre-initialized instance of General Image Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return GeneralImageModule - instance of {@link GeneralImageModule}.
	 */
	public GeneralImageModule getGeneralImageModule()
	{
		if(objGeneralImageModule == null)
		{
			objGeneralImageModule = new GeneralImageModule(objIDataSet);
			return objGeneralImageModule;
		}
		return objGeneralImageModule;
	}
	/**
	 * Retrieves pre-initialized instance of SOP Common Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return SOPCommonModule - instance of {@link SOPCommonModule}.
	 */
	public SOPCommonModule getSOPCommonModule()
	{
		if(objSOPCommonModule == null)
		{
			objSOPCommonModule = new SOPCommonModule(objIDataSet);
			return objSOPCommonModule;
		}
		return objSOPCommonModule;
	}
	/**
	 * Retrieves pre-initialized instance of Frame Extraction Module . Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return - instance of {@link FrameExtractionModule}.
	 */
	public FrameExtractionModule getFrameExtractionModule() 
	{
		if(objFrameExtractionModule == null)
		{
			objFrameExtractionModule = new FrameExtractionModule(objIDataSet);
			return objFrameExtractionModule;
		}
		return objFrameExtractionModule;
	}
	/*
	**
	 * Retrieves pre-initialized instance of MultiFrameDimensionModule. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return objMultiFrameDimensionModule - instance of {@link MultiFrameDimensionModule}.
	 */
	public MultiFrameDimensionModule getMultiFrameDimensionModule()
	{
		if(objMultiFrameDimensionModule == null)
		{
			objMultiFrameDimensionModule = new MultiFrameDimensionModule(objIDataSet);
			return objMultiFrameDimensionModule;
		}
		return objMultiFrameDimensionModule;
	}

	/**
	 * Retrieves pre-initialized instance of MultiFrameFunctionalGroupsModule. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return objMultiFrameFunctionalGroupsModule - instance of {@link MultiFrameFunctionalGroupsModule}.
	 */
	public MultiFrameFunctionalGroupsModule getMultiFrameFunctionalGroupsModule()
	{
		if(objMultiFrameFunctionalGroupsModule == null)
		{
			objMultiFrameFunctionalGroupsModule = new MultiFrameFunctionalGroupsModule(objIDataSet);
			return objMultiFrameFunctionalGroupsModule;
		}
		return objMultiFrameFunctionalGroupsModule;
	}

	/**
	 * Retrieves pre-initialized instance of AcquisitionContextModule. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return objAcquisitionContextModule - instance of {@link AcquisitionContextModule}.
	 */
	public AcquisitionContextModule getAcquisitionContextModule() 
	{
		if(objAcquisitionContextModule == null)
		{
			objAcquisitionContextModule = new AcquisitionContextModule(objIDataSet);
			return objAcquisitionContextModule;
		}
		return objAcquisitionContextModule;
	}
	/**
	 * Retrieves pre-initialized instance of Specimen Identification Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return SpecimenModule - instance of {@link SpecimenModule}.
	 */
	public SpecimenModule getSpecimenModule() 
	{
		if(objSpecimenModule == null)
		{
			objSpecimenModule = new SpecimenModule(objIDataSet);
			return objSpecimenModule;
		}
		return objSpecimenModule;
	}
	/**
	 * Retrieves pre-initialized instance of Whole Slide Microscopy Image Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return WholeSlideMicroscopyImageModule - instance of {@link WholeSlideMicroscopyImageModule}.
	 */
	public WholeSlideMicroscopyImageModule getWholeSlideMicroscopyImageModule()
	{
		if(objWholeSlideMicroscopyImageModule == null)
		{
			objWholeSlideMicroscopyImageModule = new WholeSlideMicroscopyImageModule(objIDataSet);
			return objWholeSlideMicroscopyImageModule;
		}
		return objWholeSlideMicroscopyImageModule;
	}
	
	/**
	 * Retrieves pre-initialized instance of Optical Path Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return OpticalPathModule - instance of {@link OpticalPathModule}.
	 */
	public OpticalPathModule getOpticalPathModule()
	{
		if(objOpticalPathModule == null)
		{
			objOpticalPathModule = new OpticalPathModule(objIDataSet);
			return objOpticalPathModule;
		}
		return objOpticalPathModule;
	}
	
	/**
	 * Retrieves pre-initialized instance of Respiratory Synchronization Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return MultiResolutionNavigationModule - instance of {@link MultiResolutionNavigationModule}.
	 */
	public MultiResolutionNavigationModule getMultiResolutionNavigationModule()
	{
		if(objMultiResolutionNavigationModule  == null)
		{
			objMultiResolutionNavigationModule  = new MultiResolutionNavigationModule(objIDataSet);
			return objMultiResolutionNavigationModule ;
		}
		return objMultiResolutionNavigationModule ;
	}
	
	/**
	 * Retrieves pre-initialized instance of Slide Label Module . Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return SlideLabelModule - instance of {@link SlideLabelModule}.
	 */
	public SlideLabelModule getSlideLabelModule()
	{
		if(objSlideLabelModule == null)
		{
			objSlideLabelModule = new SlideLabelModule(objIDataSet);
			return objSlideLabelModule;
		}
		return objSlideLabelModule;
	}
	/**
	 * Retrieves pre-initialized instance of Common Instance Reference Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return - instance of {@link CommonInstanceReferenceModule}.
	 */
	public CommonInstanceReferenceModule getCommonInstanceReferenceModule() 
	{
		if(objCommonInstanceReferenceModule == null)
		{
			objCommonInstanceReferenceModule = new CommonInstanceReferenceModule(objIDataSet);
			return objCommonInstanceReferenceModule;
		}
		return objCommonInstanceReferenceModule;
	}
	
	/**
	 * This method validates Non-Image IOD MR Spectroscopy IOD according to the Module Table given in The DICOM Standard.
	 * The validate method fails if one of the mandatory modules are absent or any of the
	 * modules are invalid. The validate method also checks for conditional modules.
	 * 
	 * @return boolean - status of validation as success or failure
	 * 
	 * @throws InvalidIODException  throws when the IOD is invalid.
	 */
	public boolean validate() throws InvalidIODException
	{
		try
		{
			super.validate();

			/*Validate the mandatory elements*/
			getPatientModule().validateModule();
			getGeneralStudyModule().validateModule();
			getGeneralSeriesModule().validateModule();
			getGeneralEquipmentModule().validateModule();
			getMultiFrameDimensionModule().validateModule();
			getMultiFrameFunctionalGroupsModule().validateModule();
			getAcquisitionContextModule().validateModule();
			getSOPCommonModule().validateModule();
			getWholeSlideMicroscopySeriesModule().validateModule();
			getFrameOfReferenceModule().validateModule();
			getGeneralEquipmentModule().validateModule();
			getEnhancedGeneralEquipmentModule().validateModule();
			getGeneralImageModule().validateModule();
			getSpecimenModule().validateModule();			
			getWholeSlideMicroscopyImageModule().validateModule();
			getOpticalPathModule().validateModule();
			getCommonInstanceReferenceModule().validateModule(); 
			
			if(isModulePresent(PatientStudyModule.objSingleCollection, objIDataSet))
				getPatientStudyModule().validateModule();

			
			ICollectionIterator<IItem> objOpticalPathSequenceIterator =getOpticalPathModule().getOpticalPathSequence().iterator();
			OpticalPathSequenceItem objOpticalPathSequenceItem = null;
			while(objOpticalPathSequenceIterator.hasNext())
			{
				objOpticalPathSequenceItem = (OpticalPathSequenceItem)objOpticalPathSequenceIterator.next();

				ICollectionIterator<IItem> objIlluminationColorCodeSequenceIterator = objOpticalPathSequenceItem.getIlluminationColorCodeSequence().iterator();
				CodeSequenceMacroDependentItem objCodeSequenceMacroDependentItem = null;
				while(objIlluminationColorCodeSequenceIterator.hasNext())
				{
					objCodeSequenceMacroDependentItem = (CodeSequenceMacroDependentItem)objIlluminationColorCodeSequenceIterator.next();
					String strContextIdentifier = objCodeSequenceMacroDependentItem.getCodeSequenceMacro().getContextIdentifier();
					if(!strContextIdentifier.equals("CID 8122"))
						throw new InvalidIODException("The Defined Context ID for the Optical Path Sequence (0048,0105) in each Optical Path Sequence  Item shall be CID 8122.");
				}
				
				ICollectionIterator<IItem> objIlluminatorTypeCodeSequenceIterator = objOpticalPathSequenceItem.getIlluminatorTypeCodeSequence().iterator();
				while(objIlluminatorTypeCodeSequenceIterator.hasNext())
				{
					objCodeSequenceMacroDependentItem = (CodeSequenceMacroDependentItem)objIlluminationColorCodeSequenceIterator.next();
					String strContextIdentifier = objCodeSequenceMacroDependentItem.getCodeSequenceMacro().getContextIdentifier();
					if(!strContextIdentifier.equals("CID 8122"))
						throw new InvalidIODException("The Defined Context ID for the Optical Path Sequence (0048,0105) in each Optical Path Sequence  Item shall be CID 8122.");
				}
				
				
				ICollectionIterator<IItem> objIlluminationTypeCodeSequenceIterator = objOpticalPathSequenceItem.getIlluminationTypeCodeSequence().iterator();
				while(objIlluminationTypeCodeSequenceIterator.hasNext())
				{
					objCodeSequenceMacroDependentItem = (CodeSequenceMacroDependentItem)objIlluminationColorCodeSequenceIterator.next();
					String strContextIdentifier = objCodeSequenceMacroDependentItem.getCodeSequenceMacro().getContextIdentifier();
					if(!strContextIdentifier.equals("CID 8121"))
						throw new InvalidIODException("The Defined Context ID for the Optical Path Sequence (0048,0105) in each Optical Path Sequence Item shall be CID 8121.");
				}
				
				ICollectionIterator<IItem> objLensesCodeSequenceIterator = objOpticalPathSequenceItem.getLensesCodeSequence().iterator();
				while(objLensesCodeSequenceIterator.hasNext())
				{
					objCodeSequenceMacroDependentItem = (CodeSequenceMacroDependentItem)objIlluminationColorCodeSequenceIterator.next();
					String strContextIdentifier = objCodeSequenceMacroDependentItem.getCodeSequenceMacro().getContextIdentifier();
					if(!strContextIdentifier.equals("CID 8123"))
						throw new InvalidIODException("The Defined Context ID for the Optical Path Sequence (0048,0105) in each Optical Path Sequence Item shall be CID 8123.");
				}
				
				ICollectionIterator<IItem> objLightPathFilterTypeStackCodeSequenceIterator = objOpticalPathSequenceItem.getLightPathFilterTypeStackCodeSequence().iterator();
				while(objLightPathFilterTypeStackCodeSequenceIterator.hasNext())
				{
					objCodeSequenceMacroDependentItem = (CodeSequenceMacroDependentItem)objIlluminationColorCodeSequenceIterator.next();
					String strContextIdentifier = objCodeSequenceMacroDependentItem.getCodeSequenceMacro().getContextIdentifier();
					if(!strContextIdentifier.equals("CID 8124"))
						throw new InvalidIODException("The Defined Context ID for the Optical Path Sequence (0048,0105) in each Optical Path Sequence Item shall be CID 8124.");
				}

				ICollectionIterator<IItem> objChannelDescriptionCodeSequenceIterator = objOpticalPathSequenceItem.getChannelDescriptionCodeSequence().iterator();
				while(objChannelDescriptionCodeSequenceIterator.hasNext())
				{
					objCodeSequenceMacroDependentItem = (CodeSequenceMacroDependentItem)objIlluminationColorCodeSequenceIterator.next();
					String strContextIdentifier = objCodeSequenceMacroDependentItem.getCodeSequenceMacro().getContextIdentifier();
					if(!strContextIdentifier.equals("CID 8122"))
						throw new InvalidIODException("The Defined Context ID for the Optical Path Sequence (0048,0105) in each Optical Path Sequence Item shall be CID 8122.");
				}
			}
			if(isModulePresent(MultiResolutionNavigationModule.objSingleCollection,objIDataSet))
				getMultiResolutionNavigationModule().validateModule();

			
			if(isModulePresent(SlideLabelModule.objSingleCollection,objIDataSet))
				getSlideLabelModule().validateModule();

			if(isModulePresent(FrameExtractionModule.objSingleCollection,objIDataSet))
				getFrameExtractionModule().validateModule();
		}
		catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(cfe.getMessage());
			throw new InvalidIODException(VL_WHOLE_SLIDE_MICROSCOPY_IMAGE_IOD,cfe);
		}
		catch(InvalidModuleException ime)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(ime.getMessage());
			
				throw new InvalidIODException(VL_WHOLE_SLIDE_MICROSCOPY_IMAGE_IOD);
		}
		return true;
	}
	/**
	 *  Dumps the Name of IOD,Module and corresponding Attributs of Module.
	 *  @param objIDicomStream - the Stream on which the Data is to be written.
	 *  @throws IOException - Exception is thrown indicating runtime failure of writing operation.
	 */
	public void dumpDICOMInfo(IDicomStream objIDicomStream) throws IOException
	{
		objIDicomStream.writeString(VL_WHOLE_SLIDE_MICROSCOPY_IMAGE_IOD + "\n");
		super.dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getPatientModule().getClass().getSimpleName() + "\n");
		getPatientModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getClinicalTrialSubjectModule().getClass().getSimpleName() + "\n");
		getClinicalTrialSubjectModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getFrameOfReferenceModule().getClass().getSimpleName() + "\n");
		getFrameOfReferenceModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getGeneralStudyModule().getClass().getSimpleName() + "\n");
		getGeneralStudyModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getPatientStudyModule().getClass().getSimpleName() + "\n");
		getPatientStudyModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getGeneralSeriesModule().getClass().getSimpleName() + "\n");
		getGeneralSeriesModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getWholeSlideMicroscopySeriesModule().getClass().getSimpleName() + "\n");
		getWholeSlideMicroscopySeriesModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getClinicalTrialSeriesModule().getClass().getSimpleName() + "\n");
		getClinicalTrialSeriesModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getEnhancedGeneralEquipmentModule().getClass().getSimpleName() + "\n");
		getEnhancedGeneralEquipmentModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getGeneralEquipmentModule().getClass().getSimpleName() + "\n");
		getGeneralEquipmentModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getGeneralImageModule().getClass().getSimpleName() + "\n");
		getGeneralImageModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getMultiFrameFunctionalGroupsModule().getClass().getSimpleName() + "\n");
		getMultiFrameFunctionalGroupsModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getMultiFrameDimensionModule().getClass().getSimpleName() + "\n");
		getMultiFrameDimensionModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getAcquisitionContextModule().getClass().getSimpleName() + "\n");
		getAcquisitionContextModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getSpecimenModule().getClass().getSimpleName() + "\n");
		getSpecimenModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getWholeSlideMicroscopyImageModule().getClass().getSimpleName() + "\n");
		getWholeSlideMicroscopyImageModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getOpticalPathModule().getClass().getSimpleName() + "\n");
		getOpticalPathModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getOpticalPathModule().getClass().getSimpleName() + "\n");
		getOpticalPathModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getMultiResolutionNavigationModule().getClass().getSimpleName() + "\n");
		getMultiResolutionNavigationModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getSlideLabelModule().getClass().getSimpleName() + "\n");
		getSlideLabelModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getCommonInstanceReferenceModule().getClass().getSimpleName() + "\n");
		getCommonInstanceReferenceModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getFrameExtractionModule().getClass().getSimpleName() + "\n");
		getFrameExtractionModule().dumpDICOMInfo(objIDicomStream);
	}

	/**
	 * Checks whether the Module is present in the IOD or not.
	 * @param strModuleName String value of module name 
	 * @return boolean - true if the module is present in the IOD, else false is returned.
	 */
	public boolean isModulePresent(String strModuleName)
	{
		if(!super.isModulePresent(strModuleName))
		{
			if(strModuleName == null || strModuleName.equals(""))
				return false;
			if(strModuleName.equalsIgnoreCase(EnumModuleNames.PATIENT_MODULE.getValue()) && isModulePresent(PatientModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.GENERAL_STUDY_MODULE.getValue()) && isModulePresent(GeneralStudyModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.PATIENT_STUDY_MODULE.getValue()) && isModulePresent(PatientStudyModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.GENERAL_SERIES_MODULE.getValue()) && isModulePresent(GeneralSeriesModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.WHOLE_SLIDE_MICROSCOPY_SERIES_MODULE.getValue()) && isModulePresent(WholeSlideMicroscopySeriesModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.CLINICAL_TRIAL_SUBJECT_MODULE.getValue()) && isModulePresent(ClinicalTrialSubjectModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.CLINICAL_TRIAL_STUDY_MODULE.getValue()) && isModulePresent(ClinicalTrialStudyModule.objSingleCollection))
				return true;
			
			if(strModuleName.equalsIgnoreCase(EnumModuleNames.FRAME_OF_REFERENCE_MODULE.getValue()) && isModulePresent(FrameOfReferenceModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.GENERAL_EQUIPMENT_MODULE.getValue()) && isModulePresent(GeneralEquipmentModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.GENERAL_IMAGE_MODULE.getValue()) && isModulePresent(GeneralStudyModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.ENHANCED_GENERAL_EQUIPMENT_MODULE.getValue()) && isModulePresent(EnhancedGeneralEquipmentModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.MULTI_FRAME_FUNCTIONAL_GROUPS_MODULE.getValue()) && isModulePresent(MultiFrameFunctionalGroupsModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.MULTI_FRAME_DIMENSION_MODULE.getValue()) && isModulePresent(MultiFrameDimensionModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.ACQUISITION_CONTEXT_MODULE.getValue()) && isModulePresent(AcquisitionContextModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.SPECIMEN_MODULE.getValue()) && isModulePresent(SpecimenModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.IMAGE_PIXEL_MODULE.getValue()) && isModulePresent(ImagePixelModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.SOP_COMMON_MODULE.getValue()) && isModulePresent(SOPCommonModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.WHOLE_SLIDE_MICROSCOPY_IMAGE_MODULE.getValue()) && isModulePresent(WholeSlideMicroscopyImageModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.OPTICAL_PATH_MODULE.getValue()) && isModulePresent(OpticalPathModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.MULTI_RESOLUTION_NAVIGATION_MODULE.getValue()) && isModulePresent(MultiResolutionNavigationModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.SLIDE_LABEL_MODULE.getValue()) && isModulePresent(SlideLabelModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.COMMON_INSTANCE_REFERENCE_MODULE.getValue()) && isModulePresent(CommonInstanceReferenceModule.objSingleCollection))
				return true;
			
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.FRAME_EXTRACTION_MODULE.getValue()) && isModulePresent(FrameExtractionModule.objSingleCollection))
				return true;
			else
			{
				if(DicomConfig.createInstance().isLoggingOn())
				{
					DicomLogger objDicomLogger = DicomLogger.getLogger();
					objDicomLogger.log(this.getClass().getName() + " : " +ResourceBundleWrapper.getValue("status","ModuleNotPresent",new Locale(DicomConfig.createInstance().getLocale())) + strModuleName);
				}
				return false;
			}
		}
		return true;
	}
}


