/*******************************************************************************
 *  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.EnumDoseUnits;
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 RT Dose ROI Sequence.
 */
public class RTDoseROISequenceItem extends Item  
{
	

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

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	RTDoseROISequenceItem()
	{
		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
	 */
	RTDoseROISequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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


	/**
	 * Sets value that uniquely identifies the referenced ROI within the current RT Dose.
	 * @param strReferencedROINumber String value of Referenced ROI Number.
	 */
	public void setReferencedROINumber(String strReferencedROINumber)
	{
		/*Accept the Referenced ROI Number in String format of type IS.
		 * 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(0x3006,0x0084, strReferencedROINumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3006,0x0084,DicomConstants.DCM_DT_IS, strReferencedROINumber);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves value that uniquely identifies the referenced ROI within the current RT Dose.
	 * @return String - value of Referenced ROI Number.
	 */
	public String getReferencedROINumber()
	{
		Object objValue = getValue(0x3006,0x0084);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Dose axis units.
	 * Enumerated Values:
	 * GY = Gray,
	 * RELATIVE = dose relative to reference value specified in DVH Normalization Dose Value (3004,0042).
	 * @param enumDoseUnits Enum value of Dose Units
	 */
	public void setDoseUnits(EnumDoseUnits enumDoseUnits)
	{
		/*Accept the Dose Units 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(0x3004,0x0002, enumDoseUnits.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3004,0x0002,DicomConstants.DCM_DT_CS, enumDoseUnits.getValue());

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Dose axis units.
	 * @return String - value of Dose Units.
	 */
	public String getDoseUnits()
	{
		Object objValue = getValue(0x3004,0x0002);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Dose value for ROI, in units defined by Dose Units (3004,0002).
	 * @param strDoseValue String value of Dose Value.
	 */
	public void setDoseValue(String strDoseValue)
	{
		/*Accept the Dose Units in String format of type DS.
		 * 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
		 */
		int iVRTransferSyntax=0;
		IDataElement objIDataElement = null;

		if(objITransferSyntax != null)
			iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
		else
		{
			//Transfer Syntax not set
		}

		if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)	
			objIDataElement = new ImplicitDE(0x3004,0x0012, strDoseValue,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3004,0x0012,DicomConstants.DCM_DT_DS, strDoseValue);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Dose value for ROI, in units defined by Dose Units (3004,0002).
	 * @return String - value of Dose Value.
	 */
	public String getDoseValue()
	{
		Object objValue = getValue(0x3004,0x0012);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Validates all the attributes in RTDoseROISequenceItem  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(0x3006,0x0084))
				throw new MandatoryMissingException("3006,0084)");
			if(!contains(0x3004,0x0002))
				throw new MandatoryMissingException("3004,0002");
			if(!contains(0x3004,0x0012))
				throw new MandatoryMissingException("3004,0012");
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
}
