/*******************************************************************************
 *  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.IDicomValue;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidMacroException;
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;


/**
 * Information about the agent administered.Zero or more Items shall be included in this Sequence.
 *Note:An empty sequence indicates that an agent was used for dilation, but the name was not entered.Required if the value of Pupil Dilated (0022,000D) is YES.
 */
public class MydriaticAgentSequenceItem extends Item
{
	

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

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	MydriaticAgentSequenceItem()
	{
		super();
	}

	/*
	 * This constructor calls the respective superclass constructor
	 * This constructor should throw exception if null TS is tried to be set
	 */
	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	MydriaticAgentSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates MydriaticAgentSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	MydriaticAgentSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	/**
	 * Retrieves the actual agent administered to dilate the pupil.
	 * @return MydriaticAgentCodeSequence - instance of MydriaticAgentCodeSequence. 
	 */
	public MydriaticAgentCodeSequence getMydriaticAgentCodeSequence()
	{
		MydriaticAgentCodeSequence objMydriaticAgentCodeSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0022, 0x001C); 
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objMydriaticAgentCodeSequence = (MydriaticAgentCodeSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objMydriaticAgentCodeSequence = (MydriaticAgentCodeSequence)objDicomV3Factory.createSequence(0x3002, 0x0050, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0022, 0x001C, objMydriaticAgentCodeSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0022, 0x001C, DicomConstants.DCM_DT_SQ, objMydriaticAgentCodeSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objMydriaticAgentCodeSequence;
	}
	/**
	 * Retrieves the units of measured for the Mydriatic Agent Concentration.Only a single Item shall be included in this Sequence.Required if Mydriatic Agent Concentration (0022,004E) ispresent.
	 * @return MydriaticAgentConcentrationUnitsSequence - instance of MydriaticAgentConcentrationUnitsSequence. 
	 */
	public MydriaticAgentConcentrationUnitsSequence getMydriaticAgentConcentrationUnitsSequence()
	{
		MydriaticAgentConcentrationUnitsSequence objMydriaticAgentConcentrationUnitsSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0022, 0x0042); 
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objMydriaticAgentConcentrationUnitsSequence = (MydriaticAgentConcentrationUnitsSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objMydriaticAgentConcentrationUnitsSequence = (MydriaticAgentConcentrationUnitsSequence)objDicomV3Factory.createSequence(0x3002, 0x0050, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0022, 0x0042, objMydriaticAgentConcentrationUnitsSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0022, 0x0042, DicomConstants.DCM_DT_SQ, objMydriaticAgentConcentrationUnitsSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objMydriaticAgentConcentrationUnitsSequence;
	}
	/**
	 * Sets concentration of the agent.
	 * @param strMydriaticAgentConcentration String value of concentration of the agent.
	 */
	public void setMydriaticAgentConcentration(String strMydriaticAgentConcentration)
	{
		/*Accept the MydriaticAgentConcentration 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
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0022,0x004E, strMydriaticAgentConcentration,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0022,0x004E,DicomConstants.DCM_DT_DS, strMydriaticAgentConcentration);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves concentration of the agent.
	 * @return String - value of concentration of the agent.
	 */
	public String getMydriaticAgentConcentration()
	{
		Object objValue = getValue(0x0022,0x004E);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Validates all the attributes in MydriaticAgentSequenceItem 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
		{
			/*
			 * Validation Rules for Mandatory Elements
			 */
			if(!contains(0x0022,0x001C))
				throw new MandatoryMissingException("0022,001C");
			if(contains(0x0022,0x004E))
				if(!contains(0x0022,0x0042))
					throw new ConditionFailedException("value for conditional Element 0x0022,0x0042 required if value of (0022,004E) is present.");
			else
					getMydriaticAgentConcentrationUnitsSequence().validateForModule();
				
		}
		catch(ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),ce); 
		}
		catch( InvalidMacroException ime)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ime.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ime);
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		return true;
	}

}
