/*******************************************************************************
 *  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.EnumAliasedDataType;
import cdac.medinfo.sdk.dcm30_04.enums.EnumDataType;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
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 Image Data Type Sequence .
 */

public class ImageDataTypeSequenceItem extends Item
{
	
	
	/**
	* 
	*/
	private static final long serialVersionUID = 1L;
	
	
	/**
	* This constructor creates the item and internal code sequence macro with default TransferSyntax 
	*/
	ImageDataTypeSequenceItem()
	{
	super();
	}
	/**
	* This constructor creates the item and internal code sequence macro with default TransferSyntax 
	* and default DictionaryReader
	* @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	*/
	ImageDataTypeSequenceItem(ITransferSyntax objITransferSyntax)
	{
	super(objITransferSyntax);
	}
	
	/**
	* This constructor creates ImageDataTypeSequenceItem with specified TransferSyntax and
	* specified DictionaryReader
	* @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	* @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	*/
	ImageDataTypeSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
	super(objTransferSyntax,objDictionaryReader);
	}
	/**
	 * Sets Identification of the data type of a frame.
	 * @param enumDataType enum value of Data Type.
	 */
	public void setDataType(EnumDataType enumDataType)
	{
		/* 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, enumDataType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9808,DicomConstants.DCM_DT_CS, enumDataType.getValue());

		addDataElement(objIDataElement);
	}

	/**
	 * Return Data Type
	 * @return String - value of Data Type.
	 */
	public String getDataType()
	{
		Object objValue = getValue(0x0018,0x9808);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Indicates whether this data type is "aliased".
	 * @param enumDataType enum value of Data Type.
	 */
	public void setAliasedDataType(EnumAliasedDataType enumAliasedDataType)
	{
		/* Accept the Aliased 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,0x980B, enumAliasedDataType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x980B,DicomConstants.DCM_DT_CS, enumAliasedDataType.getValue());

		addDataElement(objIDataElement);
	}

	/**
	 * Return Aliased Data Type
	 * @return String - value of Aliased Data Type.
	 */
	public String getAliasedDataType()
	{
		Object objValue = getValue(0x0018,0x980B);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets Data value at which velocity is zero.
	 * @param shZeroVelocityPixelValue short value of Number of significant bits
	 */
	public void setZeroVelocityPixelValue(short shZeroVelocityPixelValue)
	{
		/* Accept the ZeroVelocityPixelValue of type US or SS.
		 * 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,0x9810,shZeroVelocityPixelValue,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9810,DicomConstants.DCM_DT_US, shZeroVelocityPixelValue);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Zero Velocity Pixel Value
	 * @return short - short value of Number of significant bits
	 */
	public short getZeroVelocityPixelValue()
	{
		Object objValue = getValue(0x0018,0x9810);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	/**
	* Validates all the attributes in ImageDataTypeSequenceItem  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(0x0018,0x980B))
			throw new MandatoryMissingException("0018,980B");
		if(!getDataForTag(0x0018, 0x9808).getValue().equals(EnumDataType.FLOW_VELOCITY)||!getDataForTag(0x0018, 0x9808).getValue().equals(EnumDataType.DIRECTION_POWER)||!getDataForTag(0x0018, 0x9808).getValue().equals(EnumDataType.TISSUE_VELOCITY))
		if(!contains(0x0018,0x9810))
			throw new ConditionFailedException("value for conditional Element 0x0018,0x9810 required if value of (0018,9808) is TISSUE_VELOCITY,FLOW_VELOCITY or DIRECTION_POWER.");
	}
	catch( ConditionFailedException ce)
	{
		if(DicomConfig.createInstance().isLoggingOn())
		{
			DicomLogger.getLogger().log(ce.getMessage());
		}
		throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
	}
	catch( MandatoryMissingException me)
	{
		if(DicomConfig.createInstance().isLoggingOn())
		{
			DicomLogger.getLogger().log(me.getMessage());
		}
		throw new InvalidItemException(this.getClass().getSimpleName(),me);
	}
	return true;
	}
}
