/*******************************************************************************
 *  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.study;

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


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.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NormalizedIOD;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SOPCommonModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StudyAcquisitionModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StudyClassificationModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StudyIdentificationModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StudyReadModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StudyRelationshipModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StudySchedulingModule;
import cdac.medinfo.sdk.dcm30_04.enums.EnumModuleNames;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidIODException;
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.ResourceBundleWrapper;

/**
 * The Study Information Object Definition is an abstraction of the information that describes a
 * diagnostic imaging study. It includes such information as the reason for performing the study, the
 * radiological procedure performed, and the time and date of the radiological procedure. The Study
 * IOD is tailored by Service Class Definitions that use services that facilitate the exchange of
 * Study-related information between DICOM Application Entities.
 * 
 * 
 */
public class StudyIOD extends NormalizedIOD 
{
	

	/**
	 * The Constant STUDY_IOD.
	 */
	public static final String STUDY_IOD = "Study IOD";

	/**
	 * The obj sop common module.
	 */
	SOPCommonModule objSOPCommonModule = null;

	/**
	 * The obj study relationship module.
	 */
	StudyRelationshipModule objStudyRelationshipModule = null;

	/**
	 * The obj study identification module.
	 */
	StudyIdentificationModule objStudyIdentificationModule = null;

	/**
	 * The obj study classification module.
	 */
	StudyClassificationModule objStudyClassificationModule = null;

	/**
	 * The obj study scheduling module.
	 */
	StudySchedulingModule objStudySchedulingModule = null;

	/**
	 * The obj study acquisition module.
	 */
	StudyAcquisitionModule objStudyAcquisitionModule = null;

	/**
	 * The obj study read module.
	 */
	StudyReadModule objStudyReadModule = null;

	/**
	 * Instantiates a new study iod.
	 */
	public StudyIOD()
	{
		super();
	}

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

	/**
	 * This constructor initializes the  DictionaryReader
	 * in its superclass IOD.
	 * 
	 * @param objIDictionaryReader_ - specifies the DICOM Dictionary reader to be used .
	 */
	public StudyIOD(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 StudyIOD(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 StudyIOD(ITransferSyntax objITransferSyntax_,IDictionaryReader objIDictionaryReader_)
	{
		super(objITransferSyntax_,objIDictionaryReader_);
	}

	/**
	 * Creates StudyIOD IOD from a DICOM file containing StudyIOD 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 StudyIOD(String strFileName)throws IOException,InvalidIODException
	{
		super(strFileName);
	}

	/**
	 * This method returns the SOPCommonModule with preinitializing it.
	 * 
	 * @return instance of {@link SOPCommonModule}.
	 */
	public SOPCommonModule getSOPCommonModule()
	{
		if(objSOPCommonModule == null)
		{
			objSOPCommonModule = new SOPCommonModule(objIDataSet);
			return objSOPCommonModule;
		}
		return objSOPCommonModule;
	}

	/**
	 * This method returns the StudyRelationshipModule with preinitializing it.
	 * 
	 * @return instance of {@link StudyRelationshipModule}.
	 */
	public StudyRelationshipModule getStudyRelationshipModule()
	{
		if(objStudyRelationshipModule == null)
		{
			objStudyRelationshipModule = new StudyRelationshipModule(objIDataSet);
			return objStudyRelationshipModule;
		}
		return objStudyRelationshipModule;
	}

	/**
	 * This method returns the StudyIdentificationModule with preinitializing it.
	 * 
	 * @return instance of {@link StudyIdentificationModule}.
	 */
	public StudyIdentificationModule getStudyIdentificationModule()
	{
		if(objStudyIdentificationModule== null)
		{
			objStudyIdentificationModule = new StudyIdentificationModule(objIDataSet);
			return objStudyIdentificationModule;
		}
		return objStudyIdentificationModule;
	}


	/**
	 * This method returns the StudyIdentificationModule with preinitializing it.
	 * 
	 * @return instance of {@link StudyClassificationModule}.
	 */
	public StudyClassificationModule getStudyClassificationModule()
	{
		if(objStudyClassificationModule== null)
		{
			objStudyClassificationModule = new StudyClassificationModule(objIDataSet);
			return objStudyClassificationModule;
		}
		return objStudyClassificationModule;
	}

	/**
	 * This method returns the StudySchedulingModule with preinitializing it.
	 * 
	 * @return instance of {@link StudySchedulingModule}.
	 */
	public StudySchedulingModule getStudySchedulingModule()
	{
		if(objStudySchedulingModule== null)
		{
			objStudySchedulingModule = new StudySchedulingModule(objIDataSet);
			return objStudySchedulingModule;
		}
		return objStudySchedulingModule;
	}

	/**
	 * This method returns the StudyAcquisitionModule with preinitializing it.
	 * 
	 * @return instance of {@link StudyAcquisitionModule}.
	 */
	public StudyAcquisitionModule getStudyAcquisitionModule()
	{
		if(objStudyAcquisitionModule== null)
		{
			objStudyAcquisitionModule = new StudyAcquisitionModule(objIDataSet);
			return objStudyAcquisitionModule;
		}
		return objStudyAcquisitionModule;
	}

	/**
	 * This method returns the StudyReadModule with preinitializing it.
	 * 
	 * @return instance of {@link StudyReadModule}.
	 */
	public StudyReadModule getStudyReadModule()
	{
		if(objStudyReadModule== null)
		{
			objStudyReadModule = new StudyReadModule(objIDataSet);
			return objStudyReadModule;
		}
		return objStudyReadModule;
	}

	/**
	 *  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(STUDY_IOD + "\n");
		super.dumpDICOMInfo(objIDicomStream);

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

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

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

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

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

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

		objIDicomStream.writeString("\t" + getStudyReadModule().getClass().getSimpleName() + "\n");
		getStudyReadModule().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.SOP_COMMON_MODULE.getValue()) && isModulePresent(SOPCommonModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.STUDY_RELATIONSHIP_MODULE.getValue()) && isModulePresent(StudyRelationshipModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.STUDY_IDENTIFICATION_MODULE.getValue()) && isModulePresent(StudyIdentificationModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.STUDY_CLASSIFICATION_MODULE.getValue()) && isModulePresent(StudyClassificationModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.STUDY_SCHEDULING_MODULE.getValue()) && isModulePresent(StudySchedulingModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.STUDY_ACQUISITION_MODULE.getValue()) && isModulePresent(StudyAcquisitionModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.STUDY_READ_MODULE.getValue()) && isModulePresent(StudyReadModule.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;
	}
}
