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

import cdac.medinfo.sdk.dcm30_04.baselibs.BlendingLUT1Sequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.BlendingLUT2Sequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.DataFrameAssignmentSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.EnhancedPaletteColorLookupTableSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;

import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.exceptions.ValidationException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConfig;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.DicomLogger;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.SingleCollection;

/**
 \* This module is used for Enhanced Palette Color Lookup Table Module.
 */
public class EnhancedPaletteColorLookupTableModule extends Module  
{


	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;

	/**
	 * Instantiates a Enhanced Palette Color Lookup Table Module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public EnhancedPaletteColorLookupTableModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
	}


	static
	{
		objSingleCollection = new SingleCollection<ITag>();

		objSingleCollection.add(new Tag(0x0028,0x1401));
		objSingleCollection.add(new Tag(0x0028,0x1404));
		objSingleCollection.add(new Tag(0x0028,0x140C));
		objSingleCollection.add(new Tag(0x0028,0x140B));
		objSingleCollection.add(new Tag(0x0028,0x2000));
	}

	/**
	 * This method validates each Attribute in the Module according to the Type
	 * of the Attribute.Attributes are of 5 types.
	 * Type 1,Type 2 are Mandatory:
	 * Mandatory Attributes have to present in the Module.
	 * Type 1C,2C are Conditional:
	 * Conditional Attributes' presence depend on a condition.
	 * If the condition is satisfied the Attribute has to be present.
	 * Type 3 are Optional
	 * Optional Attributes can be added as and when required.
	 * 
	 * @return Boolean - status indicating success or failure
	 * 
	 * @throws InvalidModuleException - throws exception indicating exaxct cause of failed validation
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{			//Check for the Type 1,2 Mandatory Attributes.
			if(!isPresent(0x0028,0x1401))
			{
				throw new MandatoryMissingException("Missing Mandatory DataElement 0028,1401");
			}
			if(!isPresent(0x0028,0x1404))
			{
				throw new ConditionFailedException("Failed Conditional DataElement 0028,1404");
			}
			if(!isPresent(0x0028,0x140C))
			{
				throw new MandatoryMissingException("Missing Mandatory DataElement 0028,140C");
			}
			if(!isPresent(0x0028,0x140B))
			{
				throw new ConditionFailedException("Failed Conditional DataElement 0028,140B");
			}
			if(!isPresent(0x0028,0x2000))
			{
				throw new ConditionFailedException("Failed Conditional DataElement 0028,2000");
			}
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

			
				throw new InvalidModuleException(this.getClass().getSimpleName(),mme);

		}
		catch(ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),ce); 
		}
		catch(ValidationException ve)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(ve.getMessage());

			
				throw new InvalidModuleException(this.getClass().getSimpleName(),ve);
		}
	
	return true;
}
	/**
	 * Retrieves pre-initialized object of Data Frame Assignment Sequence.If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence
	 * 
	 * @return DataFrameAssignmentSequence - instance of Data Frame Assignment Sequence.
	 */
	public DataFrameAssignmentSequence getDataFrameAssignmentSequence()
	{
		DataFrameAssignmentSequence objDataFrameAssignmentSequence = (DataFrameAssignmentSequence)getDicomValue(0x0028,0x1401);
		if(objDataFrameAssignmentSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objDataFrameAssignmentSequence = (DataFrameAssignmentSequence)objDicomV3Factory.createSequence(0x0028,0x1401, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0028,0x1401, DicomConstants.DCM_DT_SQ, objDataFrameAssignmentSequence.getValue());
		}
		return objDataFrameAssignmentSequence;
	}
	
	/**
	 * Retrieves pre-initialized object of Blending LUT 1 Sequence.If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence
	 * 
	 * @return BlendingLUT1Sequence - instance of Blending LUT 1 Sequence.
	 */
	public BlendingLUT1Sequence getBlendingLUT1Sequence()
	{
		BlendingLUT1Sequence objBlendingLUT1Sequence = (BlendingLUT1Sequence)getDicomValue(0x0028,0x1404);
		if(objBlendingLUT1Sequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objBlendingLUT1Sequence = (BlendingLUT1Sequence)objDicomV3Factory.createSequence(0x0028,0x1404, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0028,0x1404, DicomConstants.DCM_DT_SQ, objBlendingLUT1Sequence.getValue());
		}
		return objBlendingLUT1Sequence;
	}
	/**
	 * Retrieves pre-initialized object of Blending LUT 2 Sequence.If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence
	 * 
	 * @return BlendingLUT2Sequence - instance of Blending LUT 2 Sequence.
	 */
	public BlendingLUT2Sequence getBlendingLUT2Sequence()
	{
		BlendingLUT2Sequence objBlendingLUT2Sequence = (BlendingLUT2Sequence)getDicomValue(0x0028,0x140C);
		if(objBlendingLUT2Sequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objBlendingLUT2Sequence = (BlendingLUT2Sequence)objDicomV3Factory.createSequence(0x0028,0x140C, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0028,0x140C, DicomConstants.DCM_DT_SQ, objBlendingLUT2Sequence.getValue());
		}
		return objBlendingLUT2Sequence;
	}
	/**
	 * Retrieves pre-initialized object of Enhanced Palette Color LookupTable Sequence.If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence
	 * 
	 * @return EnhancedPaletteColorLookupTableSequence - instance of Enhanced Palette Color LookupTable Sequence.
	 */
	public EnhancedPaletteColorLookupTableSequence getEnhancedPaletteColorLookupTableSequence()
	{
		EnhancedPaletteColorLookupTableSequence objEnhancedPaletteColorLookupTableSequence = (EnhancedPaletteColorLookupTableSequence)getDicomValue(0x0028,0x140B);
		if(objEnhancedPaletteColorLookupTableSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objEnhancedPaletteColorLookupTableSequence = (EnhancedPaletteColorLookupTableSequence)objDicomV3Factory.createSequence(0x0028,0x140B, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0028,0x140B, DicomConstants.DCM_DT_SQ, objEnhancedPaletteColorLookupTableSequence.getValue());
		}
		return objEnhancedPaletteColorLookupTableSequence;
	}
	/**
	 * The method is used to set the An ICC Profile encoding the transformation of device-dependent color stored pixel values into PCS-Values ,
	 * The function accepts a String Value as User generated Study identifie the  and creates the
	 * DE based on the transfer syntax and populates the DE with right values.
	 * This De is then added to the Module DataSet
	 * 
	 * @param objICCProfile : ISingle Collection of bytes.
	 */

	//The element has OB or OW as data type as per Data Dictionary.
	//Implementing OB data type.
	public void setICCProfile(ISingleCollection<byte[]> objICCProfile)
	{
		/* Accept ICC Profile.in IDicomValue  type OB.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create.
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		addDataElement(0x0028,0x2000, DicomConstants.DCM_DT_OB, objICCProfile);
	}

	/**
	 * Return the String value of the attribute  OF ICC Profile.
	 * 
	 * @return Collection of byte[] - returns the collection of ICC Profile
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<byte[]> getICCProfile()
	{
		Object objValue = objIDataSet.getValue(0x0028,0x2000);
		if(objValue != null)
			return ((ISingleCollection<byte[]>)objValue);
		return null;
	}
}
