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

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.GeneralPurposeScheduledProcedureStepInformationModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralPurposeScheduledProcedureStepRelationshipModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NormalizedIOD;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SOPCommonModule;
import cdac.medinfo.sdk.dcm30_04.enums.EnumModuleNames;
import cdac.medinfo.sdk.dcm30_04.enums.EnumSOPClassUIDs;
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;

/**
 * A "General Purpose Scheduled Procedure Step Information Object Definition" is an abstraction of the
 * information that describes the scheduled activities, conditions and status of a scheduled procedure
 * step. It contains information about the General Purpose Scheduled Procedure Step ( GP-SPS) and
 * its relations to other Information Entities of the DICOM real-world model
 */
public class GeneralPurposeScheduledProcedureStepIOD extends NormalizedIOD 
{
	

	/**
	 * The GeneralPurposeScheduledProcedureStepIOD
	 */
	public static final	String GENERAL_PURPOSE_SCHEDULED_PROCEDURE_STEP_IOD = "GeneralPurposeScheduledProcedureStepIOD" ;


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

	/**
	 * The obj general purpose scheduled procedure step information module.
	 */
	GeneralPurposeScheduledProcedureStepInformationModule objGeneralPurposeScheduledProcedureStepInformationModule = null;

	/**
	 * The obj general purpose scheduled procedure step relationship module.
	 */
	GeneralPurposeScheduledProcedureStepRelationshipModule objGeneralPurposeScheduledProcedureStepRelationshipModule = null;

	/**
	 * Instantiates a new general purpose scheduled procedure step iod.
	 */
	public GeneralPurposeScheduledProcedureStepIOD()
	{
		super();
	}

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

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

	/**
	 * Creates GeneralPurposeScheduledProcedureStepIOD IOD from a DICOM file containing GeneralPurposeScheduledProcedureStepIOD 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 GeneralPurposeScheduledProcedureStepIOD(String strFileName)throws IOException,InvalidIODException
	{
		super(strFileName);
		try
		{
			if(objIDataSet != null)
			{
				String strSOPClassUID = objIDataSet.getSOPClassUID();
				if(strSOPClassUID != null)
				{
					if(!strSOPClassUID.equals(EnumSOPClassUIDs.GPSPS.getValue()))
					{
						throw new InvalidIODException(ResourceBundleWrapper.getValue("exceptions", "InvalidIOD.FileNotMatched", new Locale(DicomConfig.createInstance().getLocale())) + GENERAL_PURPOSE_SCHEDULED_PROCEDURE_STEP_IOD);
					}
				}
				strSOPClassUID = null;
			}
		}
		catch(InvalidIODException iie)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(iie.getMessage());
			}
			throw iie;
		}
	}

	/**
	 * Returns the General Purpose Scheduled Procedure Step Information Module with preinitializing it.
	 * 
	 * @return - instance of {@link GeneralPurposeScheduledProcedureStepInformationModule}.
	 */
	public GeneralPurposeScheduledProcedureStepInformationModule getGeneralPurposeScheduledProcedureStepInformationModule()
	{
		if(objGeneralPurposeScheduledProcedureStepInformationModule == null)
		{
			objGeneralPurposeScheduledProcedureStepInformationModule = new GeneralPurposeScheduledProcedureStepInformationModule(objIDataSet);
			return objGeneralPurposeScheduledProcedureStepInformationModule;
		}
		return objGeneralPurposeScheduledProcedureStepInformationModule;
	}

	/**
	 * Returns the General Purpose Scheduled Procedure Step Relationship Module with preinitializing it.
	 * 
	 * @return - instance of {@link GeneralPurposeScheduledProcedureStepRelationshipModule}.
	 */
	public GeneralPurposeScheduledProcedureStepRelationshipModule getGeneralPurposeScheduledProcedureStepRelationshipModule()
	{
		if(objGeneralPurposeScheduledProcedureStepRelationshipModule == null)
		{
			objGeneralPurposeScheduledProcedureStepRelationshipModule = new GeneralPurposeScheduledProcedureStepRelationshipModule(objIDataSet);
			return objGeneralPurposeScheduledProcedureStepRelationshipModule;
		}
		return objGeneralPurposeScheduledProcedureStepRelationshipModule;
	}

	/**
	 * Returns the SOP Common Module with preinitializing it.
	 * 
	 * @return - instance of {@link SOPCommonModule}.
	 */
	public SOPCommonModule getSOPCommonModule()
	{
		if(objSOPCommonModule == null)
		{
			objSOPCommonModule = new SOPCommonModule(objIDataSet);
			return objSOPCommonModule;
		}
		return objSOPCommonModule;
	}

	/* 
	 * For normalized IODs, the type(Mandatory/Optional) of a Module depends upon the
	 * Requirement Type which defines if this module is required by a SCP class or an
	 * SCP class. Hence,the validation of Modules in a Normalized IOD totally depends 
	 * upon the decision that the is it an SCU/SCP that needs the module.Also, Type of the Modules
	 * describes the type of the Attributes inside the Module. Ex: Mandatory Modules contain Attributes that are
	 * included in all SOP Instances employing this IOD.
	 * Decision on implementation of this kind of validation is yet to be done. Hence,
	 * i am putting a empty validate method.
	 * @return - returns validation status as success or failure 
	 * @throws InvalidModuleException - If validation of Module fails 	 
	 */

	/* (non-Javadoc)
	 * @see cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IOD#validate()
	 */
	public boolean validate() throws InvalidIODException
	{
		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(GENERAL_PURPOSE_SCHEDULED_PROCEDURE_STEP_IOD+ "\n");
		super.dumpDICOMInfo(objIDicomStream);

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

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

		objIDicomStream.writeString("\t" + getGeneralPurposeScheduledProcedureStepRelationshipModule().getClass().getSimpleName() + "\n");
		getGeneralPurposeScheduledProcedureStepRelationshipModule().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.GENERAL_PURPOSE_SCHEDULED_PROCEDURE_STEP_INFORMATION_MODULE.getValue()) && isModulePresent(GeneralPurposeScheduledProcedureStepInformationModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.GENERAL_PURPOSE_SCHEDULED_PROCEDURE_STEP_RELATIONSHIP_MODULE.getValue()) && isModulePresent(GeneralPurposeScheduledProcedureStepRelationshipModule.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;
	}
}
