/*******************************************************************************
 *  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.EnumTreatmentTerminationStatus;
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.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 provides methods to validate, set and get the attributes of {@link FractionStatusSummarySequence}.
 */
public class FractionStatusSummarySequenceItem extends Item  
{
	        


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

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

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

	/*
	 * (non-Javadoc) This mathod validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in FractionStatusSummarySequenceItem 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,0x0223))
				throw new MandatoryMissingException("3008,0223");
			if(!contains(0x3008,0x0250))
				throw new MandatoryMissingException("3008,0250");
			if(!contains(0x3008,0x0251))
				throw new MandatoryMissingException("3008,0251");
			if(!contains(0x3008,0x002A))
				throw new MandatoryMissingException("3008,002A");
			
		}
		catch(ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),ce); 
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}

	/**
	 * Sets number that identifies fraction.
	 * @param strReferencedFractionNumber String value of Referenced Fraction Number.
	 */
	public void setReferencedFractionNumber(String strReferencedFractionNumber)
	{
		/*Accept the Referenced Fraction 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(0x3008,0x0223, strReferencedFractionNumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0223,DicomConstants.DCM_DT_IS, strReferencedFractionNumber);

		addDataElement(objIDataElement);
	}
	
	/**
	 * Return number that identifies fraction.
	 * @return String - value of Referenced Fraction Group Number.
	 */
	public String getReferencedFractionNumber()
	{
		Object objValue = getValue(0x3008,0x0223);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets date when fraction was delivered.
	 * @param strTreatmentDate String value of Treatment Date.
	 */
	public void setTreatmentDate(String strTreatmentDate)
	{
		/*Accept the Treatment Date in String format 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,0x0250, strTreatmentDate,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0250,DicomConstants.DCM_DT_DA, strTreatmentDate);

		addDataElement(objIDataElement);
	}
	
	/**
	 * Return date when fraction was delivered.
	 * @return String - value of Referenced Treatment Date.
	 */
	public String getTreatmentDate()
	{
		Object objValue = getValue(0x3008,0x0250);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	
	/**
	 * Sets time when fraction was delivered.
	 * @param strTreatmentTime String value of Treatment Time.
	 */
	public void setTreatmentTime(String strTreatmentTime)
	{
		/*Accept the Treatment Time in String format 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,0x0251, strTreatmentTime,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0251,DicomConstants.DCM_DT_TM, strTreatmentTime);

		addDataElement(objIDataElement);
	}
	
	/**
	 * Return time when fraction was delivered.
	 * @return String - value of Referenced Treatment Time.
	 */
	public String getTreatmentTime()
	{
		Object objValue = getValue(0x3008,0x0251);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets conditions under which treatment was terminated.
	 * Enumerated Values:
	 *  1) NORMAL = treatment terminated normally,
	 *  2) OPERATOR = operator terminated treatment,
	 *  3) MACHINE = machine terminated treatment for other than NORMAL condition,
	 *  4) UNKNOWN = status at termination unknown.
	 * @param enumTreatmentTerminationStatus Enum value of condition status under which treatment was terminated.
	 */
	public void setTreatmentTerminationStatus(EnumTreatmentTerminationStatus enumTreatmentTerminationStatus)
	{
		/*Accept the Treatment Termination Status 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(0x3008,0x002A, enumTreatmentTerminationStatus.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x002A,DicomConstants.DCM_DT_CS, enumTreatmentTerminationStatus.getValue());

		addDataElement(objIDataElement);
	}
	
	/**
	 * Return condition status under which treatment was terminated.
	 * @return String - value Termination Status
	 */
	public String getTreatmentTerminationStatus()
	{
		Object objValue = getValue(0x3008,0x002A);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
}
