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

import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataElement;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.enums.EnumDataPathAssignment;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConfig;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.DicomLogger;

/**
* This item class contains the methods to set, get and validate the attribute present in Data Frame Assignment Sequence .
 */

public class DataFrameAssignmentSequenceItem extends VOILUTMacroDependentItem
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item and with default TransferSyntax 
	 */
	DataFrameAssignmentSequenceItem()
	{
		super();
	}

	/**
	 * This constructor creates the item with default TransferSyntax.
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax 
	 */
	DataFrameAssignmentSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates DataFrameAssignmentSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	DataFrameAssignmentSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/**
	 * Sets the Identification of the data type of frames using this data path assignment.
	 * @param strDataType- Specifies type of the value encoded in this Item
	 */
	public void setDataType(String strDataType)
	{
		/*Accept the Data Type in String format of type CS.
		 * 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
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0018, 0x9808, strDataType,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018, 0x9808,DicomConstants.DCM_DT_CS, strDataType);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Data Type
	 * @return String - Type of the value encoded in this Item
	 */
	public String getDataype()
	{
		Object objValue = getValue(0x0018, 0x9808);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets the data path to use for this data type in the Enhanced Blending andDisplay Pipeline.
	 *Enumerated Values:
	 *PRIMARY_PVALUES
	 *PRIMARY_SINGLE
	 *SECONDARY_SINGLE
	 *SECONDARY_HIGH
	 *SECONDARY_LOW
	 * @param enumDataPathAssignment enum value of DataPathAssignment Type.
	 */
	public void setDataPathAssignment(EnumDataPathAssignment enumDataPathAssignment)
	{
		/* Accept the Data Path Assignment in String format of type CS.
		 * 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
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0028,0x1402, enumDataPathAssignment.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0028,0x1402,DicomConstants.DCM_DT_CS, enumDataPathAssignment.getValue());

		addDataElement(objIDataElement);
	}
	/**
	 * Return type of Data Path Assignment. 
	 * @return String - value of Data Path Assignment.
	 */
	public String getDataPathAssignment()
	{
		Object objValue = getValue(0x0028,0x1402);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets the number of most significant bits of each value of Pixel Data(7FE0,0010) from this frame contributing to the Palette Color LookupTable input.
	 * @param shBitsMappedToColorLookupTable short value of Bits Mapped to ColorLookup Table
	 */
	public void setBitsMappedToColorLookupTable(short shBitsMappedToColorLookupTable)
	{
		/* Accept the Bits Mapped to ColorLookup Table of type US.
		 * 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
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)	
			objIDataElement = new ImplicitDE(0x0028,0x1403,shBitsMappedToColorLookupTable,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0028,0x1403,DicomConstants.DCM_DT_US, shBitsMappedToColorLookupTable);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Bits Mapped to ColorLookup Table
	 * @return short - short value of Bits Mapped to ColorLookup Table
	 */
	public short getBitsMappedToColorLookupTable()
	{
		Object objValue = getValue(0x0028,0x1403);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	 * Validates all the attributes in DataFrameAssignmentSequenceItem that are present in the DataSet.
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule() throws InvalidItemException
	{
		try{
			if(!contains(0x0018,0x9808))
				throw new MandatoryMissingException("(0018,9808)");
			if(!contains(0x0028,0x1402))
				throw new MandatoryMissingException("(0028,1402)");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
}
