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

/**
* This item class contains the methods to set, get and validate the attribute present in Brachy Pulse Control Point Delivered Sequence .
 */

public class BrachyPulseControlPointDeliveredSequenceItem extends Item
{

	private static final long serialVersionUID = 1L;

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

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

	/**
	 * This constructor creates Brachy Pulse Control Point Delivered Sequence Item with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	BrachyPulseControlPointDeliveredSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	/**
	 * Sets Referenced Control Point Index.
	 * @param strReferencedControlPointIndex String value of index of Referenced Control Point.
	 */
	public void setReferencedControlPointIndex(String strReferencedControlPointIndex)
	{
		/* Accept the Referenced Control Point Index of type IS.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNuList of control points for this pulse.mber 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(0x300C,0x00F0,strReferencedControlPointIndex,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300C,0x00F0,DicomConstants.DCM_DT_IS, strReferencedControlPointIndex);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Number of Referenced Control Point Index.
	 * @return String - value of index of Referenced Control Point.
	 */
	public String getReferencedControlPointIndex()
	{
		Object objValue = getValue(0x300C,0x00F0);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Treatment Control Point Date.
	 * @param strTreatmentControlPointDate -String value of Date of Treatment Control Point.
	 */
	public void setTreatmentControlPointDate(String strTreatmentControlPointDate)
	{
		/* Accept the Treatment Control Point Date of type DA.
		 * 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(0x3008,0x0024,strTreatmentControlPointDate,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0024,DicomConstants.DCM_DT_DA, strTreatmentControlPointDate);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Treatment Control Point Date.
	 * @return String - value of date of Treatment Control Point.
	 */
	public String getTreatmentControlPointDate()
	{
		Object objValue = getValue(0x3008,0x0024);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Treatment Control Point Time.
	 * @param strTreatmentControlPointTime -String value of Time of Treatment Control Point.
	 */
	public void setTreatmentControlPointTime(String strTreatmentControlPointTime)
	{
		/* Accept the Treatment Control Point Time of type TM.
		 * 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(0x3008,0x0025,strTreatmentControlPointTime,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0025,DicomConstants.DCM_DT_TM, strTreatmentControlPointTime);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Treatment Control Point Time.
	 * @return String - value of time of Treatment Control Point.
	 */
	public String getTreatmentControlPointTime()
	{
		Object objValue = getValue(0x3008,0x0025);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Control Point RelatList of control points for this pulse.ive Position.
	 * @param strControlPointRelativePosition -String value of Control Point Relative Position.
	 */
	public void setControlPointRelativePosition(String strControlPointRelativePosition)
	{
		/* Accept the Control Point Relative Position 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(0x300A,0x02D2,strControlPointRelativePosition,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x02D2,DicomConstants.DCM_DT_DS, strControlPointRelativePosition);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Control Point Relative Position.
	 * @return String - value of Control Point Relative Position.
	 */
	public String getControlPointRelativePosition()
	{
		Object objValue = getValue(0x300A,0x02D2);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Retrieves pre-initialized object of Override 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 OverrideSequence - instance of Override Sequence. 
	 */
	public OverrideSequence getOverrideSequence()
	{
		OverrideSequence objOverrideSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x3008,0x0060);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objOverrideSequence = (OverrideSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objOverrideSequence = (OverrideSequence)objDicomV3Factory.createSequence(0x3008,0x0060, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x3008,0x0060, objOverrideSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x3008,0x0060, DicomConstants.DCM_DT_SQ, objOverrideSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objOverrideSequence;
	}
	
	/**
	 * Validates all the attributes in {@link BrachyPulseControlPointDeliveredSequenceItem()} 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(0x3008,0x0024))
				throw new MandatoryMissingException("3008,0024");
			if(!contains(0x3008,0x0025))
				throw new MandatoryMissingException("3008,0025");
			if(!contains(0x300A,0x02D2))
				throw new MandatoryMissingException("300A,02D2");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
}
