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

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.ClinicalTrialStudyModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ClinicalTrialSubjectModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ColorPaletteDefinitionModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ICCProfileModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NormalizedIOD;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PaletteColorLookupTableModule;
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.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;
/**
 * A Color Palette entity specifies a color palette suitable for application to a grayscale image.
 * @author saloni
 *
 */
public class ColorPaletteIOD extends NormalizedIOD
{

	
	/**
	 * The Constant COLOR_PALETTE_IOD.
	 */
	public static final String COLOR_PALETTE_IOD = "Color Palette IOD";

	/**
	 * The obj ICC Profile module.
	 */
	ICCProfileModule objICCProfileModule = null;

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

	/**
	 * The obj palette color lookup table module.
	 */
	PaletteColorLookupTableModule objPaletteColorLookupTableModule = null;

	/**
	 * The obj Color Palette Definition Module .
	 */
	ColorPaletteDefinitionModule objColorPaletteDefinitionModule = null;

	/**
	 * Instantiates a new image iod.
	 */
	public ColorPaletteIOD()
	{
		super();
	}

	/**
	 * This constructor initializes the TransferSyntax in its superclass IOD.
	 * 
	 * @param objITransferSyntax_ Transfer Syntax of IOD.
	 */
	public ColorPaletteIOD(ITransferSyntax objITransferSyntax_)
	{
		super(objITransferSyntax_);
	}

	/**
	 * This constructor initializes DictionaryReader in its superclass IOD.
	 * 
	 * @param objIDictionaryReader_ Dictionary Reader used by the IOD.
	 */
	public ColorPaletteIOD(IDictionaryReader objIDictionaryReader_)
	{
		super(objIDictionaryReader_);
	}

	/**
	 * This constructor accepts the DictionaryReader and TransferSyntax from the user  in its superclass IOD.
	 * 
	 * @param objITransferSyntax_ Transfer Syntax of IOD.
	 * @param objIDictionaryReader_ Dictionary Reader used by the IOD.
	 */
	public ColorPaletteIOD(ITransferSyntax objITransferSyntax_,IDictionaryReader objIDictionaryReader_)
	{
		super(objITransferSyntax_,objIDictionaryReader_);
	}

	/**
	 * This constructor accepts the Data set from the user  in its superclass IOD.
	 * 
	 * @param objIDataSet_ the obj i data set_
	 */
	public ColorPaletteIOD(IDataSet objIDataSet_)
	{
		super(objIDataSet_);
	}

	/**
	 * Creates IOD from a DICOM file containing corresponding DICOM data.
	 * @param strFileName DICOM File with absolute path.
	 * @throws IOException signals Exception caused due to wrong I/O operations. 
	 * @throws ParseException signals if some parse exceptions occurred.
	 */
	public ColorPaletteIOD(String strFileName)throws IOException, InvalidIODException
	{
		super(strFileName);
		try
		{
			if(objIDataSet != null)
			{
				String strSOPClassUID = objIDataSet.getSOPClassUID();
				if(strSOPClassUID != null)
				{
					if(!strSOPClassUID.equals(EnumSOPClassUIDs.COLORPALETTEIOD.getValue()))
					{
						throw new InvalidIODException(ResourceBundleWrapper.getValue("exceptions", "InvalidIOD.FileNotMatched", new Locale(DicomConfig.createInstance().getLocale())) + COLOR_PALETTE_IOD);
					}
				}
				strSOPClassUID = null;
			}
		}
		catch(InvalidIODException iie)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(iie.getMessage());
			}
			throw iie;
		}
	}
	
	/**
	 * Retrieves pre-initialized instance of Palette Color Lookup Table 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 PaletteColorLookupTableModule - instance of {@link PaletteColorLookupTableModule}.
	 */
	public PaletteColorLookupTableModule getPaletteColorLookupTableModule() 
	{
		if(objPaletteColorLookupTableModule == null)
		{
			objPaletteColorLookupTableModule = new PaletteColorLookupTableModule(objIDataSet);
			return objPaletteColorLookupTableModule;
		}
		return objPaletteColorLookupTableModule;
	}

	/**
	 * 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 ICC Profile 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 ICCProfileModule - instance of {@link ICCProfileModule}.
	 */
	public ICCProfileModule getICCProfileModule() 
	{
		if(objICCProfileModule == null)
		{
			objICCProfileModule = new ICCProfileModule(objIDataSet);
			return objICCProfileModule;
		}
		return objICCProfileModule;
	}
	
	/**
	 * Retrieves pre-initialized instance of Color Palette Definition 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 ColorPaletteDefinitionModule - instance of {@link ColorPaletteDefinitionModule}.
	 */
	public ColorPaletteDefinitionModule getColorPaletteDefinitionModule() 
	{
		if(objColorPaletteDefinitionModule == null)
		{
			objColorPaletteDefinitionModule = new ColorPaletteDefinitionModule(objIDataSet);
			return objColorPaletteDefinitionModule;
		}
		return objColorPaletteDefinitionModule;
	}
	
	/**
	 * This method validates Image 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 - status of validation as success or failure
	 * 
	 * @throws InvalidIODException the invalid iod exception
	 */
	public boolean validate() throws InvalidIODException
	{
		try
		{
			super.validate();

			/*
			 * The implementation is given in the following way because it may be needed this way 
			 * during exception handling when exact source of failure is to be decided.
			 * This condition checks for ImageIOD's common mandatory modules validation
			 */
			getSOPCommonModule().validateModule();
			getPaletteColorLookupTableModule().validateModule();
			getICCProfileModule().validateModule();
			getColorPaletteDefinitionModule().validateModule();
			

		}
		catch(InvalidModuleException ime)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(ime.getMessage());
			
				throw new InvalidIODException(ime.getMessage(),ime);
		}
		return true;
	}

	/**
	 *  Dumps the Name of Module and corresponding Attributs of IOD.
	 *  @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
	{
		super.dumpDICOMInfo(objIDicomStream);
		objIDicomStream.writeString(COLOR_PALETTE_IOD+ "\n");

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

		objIDicomStream.writeString("\t" + getPaletteColorLookupTableModule().getClass().getSimpleName() + "\n");
		getPaletteColorLookupTableModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getICCProfileModule().getClass().getSimpleName() + "\n");
		getICCProfileModule().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.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;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.SOP_COMMON_MODULE.getValue()) && isModulePresent(SOPCommonModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.COLOR_PALETTE_DEFINITION_MODULE.getValue()) && isModulePresent(ColorPaletteDefinitionModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.PALETTE_COLOR_LOOKUP_TABLE_MODULE.getValue()) && isModulePresent(PaletteColorLookupTableModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.ICC_PROFILE_MODULE.getValue()) && isModulePresent(ICCProfileModule.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;
	}
	
}

	

