/*******************************************************************************
 *  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.displaysystem;
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.DisplaySystemModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NormalizedIOD;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.QAResultsModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SOPCommonModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.TargetLuminanceCharacteristicsModule;
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.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.ResourceBundleWrapper;

/**
 * An instance of the Display System IOD describes all of the Display Subsystems in a given Display System.
 * @author saloni
 *
 */
public class DisplaySystemIOD extends NormalizedIOD
{

	/**
	 * The Constant DISPLAY_SYSTEM_IOD.
	 */
	public static final String DISPLAY_SYSTEM_IOD = "Display System IOD";

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

	/**
	 * The obj Display System Module.
	 */
	DisplaySystemModule objDisplaySystemModule = null;
	
	/**
	 * The obj Target Luminance Characteristics Module.
	 */
	TargetLuminanceCharacteristicsModule objTargetLuminanceCharacteristicsModule = null;
	
	/**
	 * The obj QA Results Module.
	 */
	QAResultsModule objQAResultsModule = null;
	
	/**
	 * Instantiates a new Display System IOD.
	 */
	public DisplaySystemIOD()
	{
		super();
	}

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

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

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

	/**
	 * Returns the DisplaySystemModule with preinitializing it.
	 * 
	 * @return - instance of {@link DisplaySystemModule}.
	 */
	public DisplaySystemModule getDisplaySystemModule()
	{
		if(objDisplaySystemModule == null)
		{
			objDisplaySystemModule = new DisplaySystemModule(objIDataSet);
			return objDisplaySystemModule;
		}
		return objDisplaySystemModule;
	}
	
	/**
	 * Returns the TargetLuminanceCharacteristicsModule with preinitializing it.
	 * 
	 * @return - instance of {@link TargetLuminanceCharacteristicsModule}.
	 */
	public TargetLuminanceCharacteristicsModule getTargetLuminanceCharacteristicsModule()
	{
		if(objTargetLuminanceCharacteristicsModule == null)
		{
			objTargetLuminanceCharacteristicsModule = new TargetLuminanceCharacteristicsModule(objIDataSet);
			return objTargetLuminanceCharacteristicsModule;
		}
		return objTargetLuminanceCharacteristicsModule;
	}
	
	/**
	 * Returns the QAResultsModule with preinitializing it.
	 * 
	 * @return - instance of {@link QAResultsModule}.
	 */
	public QAResultsModule getQAResultsModule()
	{
		if(objQAResultsModule== null)
		{
			objQAResultsModule = new QAResultsModule(objIDataSet);
			return objQAResultsModule;
		}
		return objQAResultsModule;
	}

	/**
	 * 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;
	}

	/* 
	 * 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.
	 * @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
	{
		super.validate();
		try
		{
			/*
			 * This condition checks for mandatory modules validation
			 */
			getDisplaySystemModule().validateModule();
			getTargetLuminanceCharacteristicsModule().validateModule();
			getQAResultsModule().validateModule();
			getSOPCommonModule().validateModule();
		}
		catch(InvalidModuleException ime)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(ime.getMessage());
			
				throw new InvalidIODException(DISPLAY_SYSTEM_IOD, ime);
		}
		return true;
	}

	/**
	 *  Dumps the Name of IOD,Module and corresponding Attributes 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(DISPLAY_SYSTEM_IOD+ "\n");
		super.dumpDICOMInfo(objIDicomStream);

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

		objIDicomStream.writeString("\t" + getDisplaySystemModule().getClass().getSimpleName() + "\n");
		getDisplaySystemModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getTargetLuminanceCharacteristicsModule().getClass().getSimpleName() + "\n");
		getTargetLuminanceCharacteristicsModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getQAResultsModule().getClass().getSimpleName() + "\n");
		getQAResultsModule().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.DISPLAY_SYSTEM_MODULE.getValue()) && isModulePresent(DisplaySystemModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.TARGET_LUMINANCE_CHARACTERISTICS_MODULE.getValue()) && isModulePresent(TargetLuminanceCharacteristicsModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.QA_RESULTS_MODULE.getValue()) && isModulePresent(QAResultsModule.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;
	}
}
