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



import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedRTPlanSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedTreatmentRecordSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;

import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
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;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.SingleCollection;

// TODO: Auto-generated Javadoc
/**
 \* This module provides attributes for RT General Treatment Record Module.
 */

public class RTGeneralTreatmentRecordModule extends Module  
{


	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;


	/**
	 * Instantiates a new rT general treatment record module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public RTGeneralTreatmentRecordModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0020,0x0013));
		objSingleCollection.add(new Tag(0x3008,0x0250));
		objSingleCollection.add(new Tag(0x3008,0x0251));
		objSingleCollection.add(new Tag(0x300C,0x0002));
		objSingleCollection.add(new Tag(0x3008,0x0030));
	}

	/**
	 * This method validates each Attribute in the Module according to the Type
	 * of the Attribute.Attributes are of 5 types.
	 * Type 1,Type 2 are Mandatory:
	 * Mandatory Attributes have to present in the Module.
	 * Type 1C,2C are Conditional:
	 * Conditional Attributes' presence depend on a condition.
	 * If the condition is satisfied the Attribute has to be present.
	 * Type 3 are Optional
	 * Optional Attributes can be added as and when required.
	 * 
	 * @return boolean - returns validation status as success or failure
	 * 
	 * @throws InvalidModuleException - If validation of Module fails
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{			
			if(!isPresent(0x0020,0x0013))
				throw new MandatoryMissingException("0020,0013");
			if(!isPresent(0x3008,0x0250))
				throw new MandatoryMissingException("3008,0250");
			if(!isPresent(0x3008,0x0251))
				throw new MandatoryMissingException("3008,0251");
			if(!isPresent(0x300C,0x0002))
				throw new MandatoryMissingException("300C,0002");
		}catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

			
				throw new InvalidModuleException(this.getClass().getSimpleName(),mme);

		}
		return true;
	}

	/**
	 * Sets a number that identifies this image.
	 * 
	 * @param strInstanceNumber - String value of Instance Number.
	 */
	public void setInstanceNumber(String strInstanceNumber)
	{
		/* Accept Instance Numberin 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
		 */
		addDataElement(0x0020, 0x0013, DicomConstants.DCM_DT_IS, strInstanceNumber);
	}

	/**
	 * Retrieves instance number identifying this particular instance of the object.
	 * 
	 * @return - String value of instance number.
	 */
	public String getInstanceNumber()
	{
		Object objectValue = getValue(0x0020, 0x0013);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Sets date when current fraction was delivered, or Date last fraction was delivered in case
	 * of RT Treatment Summary Record IOD.
	 * 
	 * @param strTreatmentDate - String value of Treatment Date.
	 */
	public void setTreatmentDate(String strTreatmentDate)
	{
		/*Accept 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 Hash Map
		 */
		addDataElement(0x3008, 0x0250, DicomConstants.DCM_DT_DA, strTreatmentDate);
	}

	/**
	 * Retrieves date when current fraction was delivered, or Date last fraction was delivered in case
	 * of RT Treatment Summary Record IOD.
	 * 
	 * @return String - String value of Treatment Date.
	 */
	public String getTreatmentDate()
	{
		Object objectValue = getValue(0x3008, 0x0250);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Sets time when current fraction was delivered (begun), or Time last fraction was delivered
	 * (begun) in case of RT Treatment Summary Record IOD.
	 * 
	 * @param strTreatmentTime the str treatment time
	 */
	public void setTreatmentTime(String strTreatmentTime)
	{
		/*Accept 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 Hash Map
		 */
		addDataElement(0x3008, 0x0251, DicomConstants.DCM_DT_TM, strTreatmentTime);
	}

	/**
	 * Retrieves time when current fraction was delivered (begun), or Time last fraction was delivered
	 * (begun) in case of RT Treatment Summary Record IOD.
	 * 
	 * @return String - String value of Treatment Time.
	 */
	public String getTreatmentTime()
	{
		Object objectValue = getValue(0x3008, 0x0251);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves a sequence which provides reference to a RT Plan SOP Class/Instance pair.
	 * 
	 * @return - instance of Referenced RT Plan Sequence.
	 */
	public ReferencedRTPlanSequence getReferencedRTPlanSequence()
	{
		ReferencedRTPlanSequence objReferencedRTPlanSequence = (ReferencedRTPlanSequence)getDicomValue(0x300C,0002);
		if(objReferencedRTPlanSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objReferencedRTPlanSequence = (ReferencedRTPlanSequence)objDicomV3Factory.createSequence(0x300C,0002, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x300C,0002, DicomConstants.DCM_DT_SQ, objReferencedRTPlanSequence.getValue());
		}
		return objReferencedRTPlanSequence;
	}

	/**
	 * Retrieves a sequence which provides reference to a RT Plan SOP Class/Instance pair.
	 * 
	 * @return - instance of Referenced RT Plan Sequence.
	 */
	public ReferencedTreatmentRecordSequence getReferencedTreatmentRecordSequence()
	{
		ReferencedTreatmentRecordSequence objReferencedTreatmentRecordSequence = (ReferencedTreatmentRecordSequence)getDicomValue(0x3008,0x0030);
		if(objReferencedTreatmentRecordSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objReferencedTreatmentRecordSequence = (ReferencedTreatmentRecordSequence)objDicomV3Factory.createSequence(0x3008,0x0030, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x3008,0x0030, DicomConstants.DCM_DT_SQ, objReferencedTreatmentRecordSequence.getValue());
		}
		return objReferencedTreatmentRecordSequence;
	}

	/**
	 * This method returns the vector of keys representing the DataElements
	 * that belong to this module.
	 * 
	 * @return vector of Tags - returns the vector containing the collection of tags.
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
