/*******************************************************************************
 *  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.FractionGroupSummarySequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.baselibs.TreatmentSummaryCalculatedDoseReferenceSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.TreatmentSummaryMeasuredDoseReferenceSequence;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumCurrentTreatmentStatus;

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 describes attributes in RT Treatment Summary Record Module.
 */
public class RTTreatmentSummaryRecordModule extends Module  
{


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


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

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x3008,0x0050));
		objSingleCollection.add(new Tag(0x3008,0x0054));
		objSingleCollection.add(new Tag(0x3008,0x0056));
		objSingleCollection.add(new Tag(0x3008,0x00E0));
		objSingleCollection.add(new Tag(0x3008,0x0200));
		objSingleCollection.add(new Tag(0x3008,0x0202));
		objSingleCollection.add(new Tag(0x3008,0x0220));
	}

	/**
	 * 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 true, if validate module
	 * 
	 * @throws InvalidModuleException - If validation of Module fails
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{			/*Validation Rules for Mandatory Elements*/
			if(!isPresent(0x3008,0x0200))
				throw new MandatoryMissingException("3008,0200");
			if(!isPresent(0x3008,0x0054))
				throw new MandatoryMissingException("3008,0054");
			if(!isPresent(0x3008,0x0056))
				throw new MandatoryMissingException("3008,0056");

		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		return true;
	}

	/**
	 * Sets status of the Treatment at the time the Treatment Summary was created.
	 * Enumerated Values:
	 * 1) NOT_STARTED  - Patient has not yet begun treatment.
	 * 2) ON_TREATMENT - Patient is currently undergoing treatment.
	 * 3) ON_BREAK     - Patient is currently not undergoing treatment, but a resumption date is known.
	 * 4) SUSPENDED    - Patient is currently not undergoing treatment, but resumption of treatment is planned at an unknown date.
	 * 5) STOPPED      - Patient has stopped treatment without completing the planned course.
	 * 6) COMPLETED    - Patient completed the planned course of treatment.
	 * 
	 * @param enumCurrentTreatmentStatus - Enum value of Current Treatment Status.
	 */
	public void setCurrentTreatmentStatus(EnumCurrentTreatmentStatus enumCurrentTreatmentStatus)
	{
		/* Accept Current Treatment Status 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 Hash Map
		 */
		addDataElement(0x3008,0x0200, DicomConstants.DCM_DT_DS, enumCurrentTreatmentStatus.getValue());
	}

	/**
	 * Retrieves status of the Treatment at the time the Treatment Summary was created.
	 * 
	 * @return String value of Current Treatment Status.
	 */
	public String getCurrentTreatmentStatus()
	{Object objectValue = getValue(0x3008,0x0200);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Sets comment on current treatment status.
	 * 
	 * @param strTreatmentStatusComment the str treatment status comment
	 */
	public void setTreatmentStatusComment(String strTreatmentStatusComment)
	{
		/* Accept Treatment Status Comment in String format of type ST.
		 * 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,0x0202, DicomConstants.DCM_DT_ST, strTreatmentStatusComment);
	}

	/**
	 * Retrieves comment on current treatment status.
	 * 
	 * @return String - String value of Current Treatment Status.
	 */
	public String getTreatmentStatusComment()
	{Object objectValue = getValue(0x3008,0x0202);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Sets date of delivery of the first treatment.
	 * 
	 * @param strFirstTreatmentDate - String value of First Treatment Date.
	 */
	public void setFirstTreatmentDate(String strFirstTreatmentDate)
	{
		/* Accept First 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,0x0054, DicomConstants.DCM_DT_DA, strFirstTreatmentDate);
	}

	/**
	 * Retrieves date of delivery of the first treatment.
	 * 
	 * @return String - String value of First Treatment Date.
	 */
	public String getFirstTreatmentDate()
	{Object objectValue = getValue(0x3008,0x0054);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Sets date of delivery of the most recent administration.
	 * 
	 * @param strMostRecentTreatmentDate - String value of Most Recent Treatment Date.
	 */
	public void setMostRecentTreatmentDate(String strMostRecentTreatmentDate)
	{
		/* Accept Most Recent 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,0x0056, DicomConstants.DCM_DT_DA, strMostRecentTreatmentDate);
	}

	/**
	 * Retrieves date of delivery of the most recent administration.
	 * 
	 * @return String - String value of Most Recent Treatment Date.
	 */
	public String getMostRecentTreatmentDate()
	{Object objectValue = getValue(0x3008,0x0056);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Return sequence describing current state of planned vs. delivered fraction groups.
	 * 
	 * @return objFractionGroupSummarySequence - instance of {@link FractionGroupSummarySequence}.
	 */
	public FractionGroupSummarySequence getFractionGroupSummarySequence()
	{
		FractionGroupSummarySequence objFractionGroupSummarySequence = (FractionGroupSummarySequence)getDicomValue(0x3008, 0x0220);
		if(objFractionGroupSummarySequence == 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();
			objFractionGroupSummarySequence = (FractionGroupSummarySequence)objDicomV3Factory.createSequence(0x3008, 0x0220, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x3008, 0x0220, DicomConstants.DCM_DT_SQ, objFractionGroupSummarySequence.getValue());
		}
		return objFractionGroupSummarySequence;
	}

	/**
	 * Return sequence of references to Measured Dose References.
	 * 
	 * @return objTreatmentSummaryMeasuredDoseReferenceSequence - instance of {@link TreatmentSummaryMeasuredDoseReferenceSequence}.
	 */
	public TreatmentSummaryMeasuredDoseReferenceSequence getTreatmentSummaryMeasuredDoseReferenceSequence()
	{
		TreatmentSummaryMeasuredDoseReferenceSequence objTreatmentSummaryMeasuredDoseReferenceSequence = (TreatmentSummaryMeasuredDoseReferenceSequence)getDicomValue(0x3008, 0x00E0);
		if(objTreatmentSummaryMeasuredDoseReferenceSequence == 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();
			objTreatmentSummaryMeasuredDoseReferenceSequence = (TreatmentSummaryMeasuredDoseReferenceSequence)objDicomV3Factory.createSequence(0x3008, 0x00E0, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x3008, 0x00E0, DicomConstants.DCM_DT_SQ, objTreatmentSummaryMeasuredDoseReferenceSequence.getValue());
		}
		return objTreatmentSummaryMeasuredDoseReferenceSequence;
	}

	/**
	 * Return sequence of references to Measured Dose References.
	 * 
	 * @return objTreatmentSummaryCalculatedDoseReferenceSequence - instance of {@link TreatmentSummaryMeasuredDoseReferenceSequence}.
	 */
	public TreatmentSummaryCalculatedDoseReferenceSequence getTreatmentSummaryCalculatedDoseReferenceSequence()
	{
		TreatmentSummaryCalculatedDoseReferenceSequence objTreatmentSummaryCalculatedDoseReferenceSequence = (TreatmentSummaryCalculatedDoseReferenceSequence)getDicomValue(0x3008, 0x0050);
		if(objTreatmentSummaryCalculatedDoseReferenceSequence == 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();
			objTreatmentSummaryCalculatedDoseReferenceSequence = (TreatmentSummaryCalculatedDoseReferenceSequence)objDicomV3Factory.createSequence(0x3008, 0x0050, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x3008, 0x0050, DicomConstants.DCM_DT_SQ, objTreatmentSummaryCalculatedDoseReferenceSequence.getValue());
		}
		return objTreatmentSummaryCalculatedDoseReferenceSequence;
	}

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