/*******************************************************************************
 *  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.RecordedChannelSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.RecordedChannelSequenceItem;
import cdac.medinfo.sdk.dcm30_04.baselibs.RecordedSourceSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.baselibs.TreatmentSessionApplicationSetupSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.TreatmentSessionApplicationSetupSequenceItem;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataElement;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDicomValue;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IItem;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumBrachyTreatmentTechnique;
import cdac.medinfo.sdk.dcm30_04.enums.EnumBrachyTreatmentType;

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

// TODO: Auto-generated Javadoc
/**
 \* This module describes the attributes in RT Brachy Session Record Module.
 */
public class RTBrachySessionRecordModule extends Module  
{


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


	/**
	 * Creates RT Brachy Session Record Module with default initialization.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public RTBrachySessionRecordModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x1070));
		objSingleCollection.add(new Tag(0x3008,0x0100));
		objSingleCollection.add(new Tag(0x3008,0x0110));
		objSingleCollection.add(new Tag(0x300A,0x0078));
		objSingleCollection.add(new Tag(0x300A,0x0200));
		objSingleCollection.add(new Tag(0x300A,0x0202));
		objSingleCollection.add(new Tag(0x300C,0x0022));
	}

	/**
	 * 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
		{
			/*
			 * Validation Rules for Mandatory Elements
			 */
			if(!isPresent(0x0008,0x1070))
				throw new MandatoryMissingException("0008,1070");
			if(!isPresent(0x300A,0x0078))
				throw new MandatoryMissingException("0008,0078");
			if(!isPresent(0x300A,0x0200))
				throw new MandatoryMissingException("300A,0200");
			if(!isPresent(0x300A,0x0202))
				throw new MandatoryMissingException("300A,0202");
			if(!isPresent(0x3008,0x0100))
				throw new MandatoryMissingException("3008,0100");
			if(!isPresent(0x3008,0x0110))
				throw new MandatoryMissingException("3008,0110");
			String strBrachyTreatmentType = getBrachyTreatmentType();

			/*
			 * These conditions are to validate sequence. As the attribute of sequence is dependent on module 
			 * these conditions are validating here.
			 * Please refer p.d.f Chapter 3 page no 526.
			 */
			if(strBrachyTreatmentType != null)
			{
				TreatmentSessionApplicationSetupSequence objTreatmentSessionApplicationSetupSequence = getTreatmentSessionApplicationSetupSequence();
				TreatmentSessionApplicationSetupSequenceItem objTreatmentSessionApplicationSetupSequenceItem = null;
				ICollectionIterator<IItem> objTreatmentSessionApplicationSetupSequenceIterator = objTreatmentSessionApplicationSetupSequence.iterator();
				while(objTreatmentSessionApplicationSetupSequenceIterator.hasNext())
				{
					objTreatmentSessionApplicationSetupSequenceItem = (TreatmentSessionApplicationSetupSequenceItem)objTreatmentSessionApplicationSetupSequenceIterator.next();
					RecordedChannelSequence objRecordedChannelSequence= objTreatmentSessionApplicationSetupSequenceItem.getRecordedChannelSequence();
					ICollectionIterator<IItem> objRecordedChannelSequenceIterator = objRecordedChannelSequence.iterator();
					RecordedChannelSequenceItem objRecordedChannelSequenceItem = null;
					while(objRecordedChannelSequenceIterator.hasNext())
					{
						objRecordedChannelSequenceItem = (RecordedChannelSequenceItem)objRecordedChannelSequenceIterator.next();
						if(strBrachyTreatmentType.equalsIgnoreCase(EnumBrachyTreatmentType.PULSED_DOSE_RATE.getValue()) && !objRecordedChannelSequenceItem.contains(0x3008,0x0136))
							throw new ConditionFailedException("3008,0136 Required if Brachy Treatment Type (300A,0202) is PDR");
						if(strBrachyTreatmentType.equalsIgnoreCase(EnumBrachyTreatmentType.PULSED_DOSE_RATE.getValue()) && !objRecordedChannelSequenceItem.contains(0x3008,0x0138))
							throw new ConditionFailedException("3008,0138 Required if Brachy Treatment Type (300A,0202) is PDR");
						if(strBrachyTreatmentType.equalsIgnoreCase(EnumBrachyTreatmentType.PULSED_DOSE_RATE.getValue()) && !objRecordedChannelSequenceItem.contains(0x3008,0x013A))
							throw new ConditionFailedException("3008,013A Required if Brachy Treatment Type (300A,0202) is PDR");
						if(strBrachyTreatmentType.equalsIgnoreCase(EnumBrachyTreatmentType.PULSED_DOSE_RATE.getValue()) && !objRecordedChannelSequenceItem.contains(0x3008,0x013C))
							throw new ConditionFailedException("3008,013C Required if Brachy Treatment Type (300A,0202) is PDR");

						if(!strBrachyTreatmentType.equalsIgnoreCase(EnumBrachyTreatmentType.MANUALLY_POSITIONED.getValue()) && !objRecordedChannelSequenceItem.contains(0x3008,0x0162))
							throw new ConditionFailedException("3008,0162 Required if Recorded Channel Sequence (3008,0130) is sent and Brachy Treatment Type (300A,0202) is not MANUAL.");
						if(!strBrachyTreatmentType.equalsIgnoreCase(EnumBrachyTreatmentType.MANUALLY_POSITIONED.getValue()) && !objRecordedChannelSequenceItem.contains(0x3008,0x0164))
							throw new ConditionFailedException("3008,0164 Required if Recorded Channel Sequence (3008,0130) is sent and Brachy Treatment Type (300A,0202) is not MANUAL.");
						if(!strBrachyTreatmentType.equalsIgnoreCase(EnumBrachyTreatmentType.MANUALLY_POSITIONED.getValue()) && !objRecordedChannelSequenceItem.contains(0x3008,0x0166))
							throw new ConditionFailedException("3008,0166 Required if Recorded Channel Sequence (3008,0130) is sent and Brachy Treatment Type (300A,0202) is not MANUAL.");
						if(!strBrachyTreatmentType.equalsIgnoreCase(EnumBrachyTreatmentType.MANUALLY_POSITIONED.getValue()) && !objRecordedChannelSequenceItem.contains(0x3008,0x0168))
							throw new ConditionFailedException("3008,0168 Required if Recorded Channel Sequence (3008,0130) is sent and Brachy Treatment Type (300A,0202) is not MANUAL.");
					}
				}
			}
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(cfe.getMessage());

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

		}
		return true;
	}

	/**
	 * This method is used to set the Operator Names administering treatment session.
	 * 
	 * @param arrStrOperatorNames  Name of operator administering treatment session.
	 */	
	public void setOperatorNames(String[] arrStrOperatorNames)
	{
		/*Accept the Operator Names value in String Array format of type PN.
		 * Read the Transfer Syntax and check to create ImplicitDE or ExplicitDE .
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Hash Map
		 */
		addDataElement(0x0008, 0x1070, DicomConstants.DCM_DT_PN, arrStrOperatorNames);
	}

	/**
	 * Retrieves Operator Names.
	 * 
	 * @return String[] - String array of OperatorNames.
	 */
	public String[] getOperatorNames()
	{
		if (objIDataSet == null)
			return null;
		IDataElement objIDataElement =  objIDataSet.getDataForTag(0x0008, 0x1070);
		if(objIDataElement == null)
			return null;
		IDicomValue objIDicomValue = objIDataElement.getDicomValue();
		if(objIDicomValue == null)
			return null;
		if(objIDicomValue.getValue()==null)
			return null;
		return (String[])objIDicomValue.getValue();
	}

	/**
	 * Sets identifier of Fraction Group within RT Plan referenced in Referenced RT Plan
	 * Sequence (300C,0002).
	 * 
	 * @param strReferencedFractionGroupNumber String value of Referenced Fraction Group Number.
	 */
	public void setReferencedFractionGroupNumber(String strReferencedFractionGroupNumber)
	{
		/* Accept Referenced Fraction Group 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
		 */
		addDataElement(0x300C, 0x0022, DicomConstants.DCM_DT_IS, strReferencedFractionGroupNumber);
	}

	/**
	 * Retrieves identifier of Fraction Group within RT Plan referenced in Referenced RT Plan
	 * Sequence (300C,0002).
	 * 
	 * @return the referenced fraction group number
	 */
	public String getReferencedFractionGroupNumber()
	{
		if (objIDataSet == null)
			return null;
		IDataElement objIDataElement =  objIDataSet.getDataForTag(0x300C, 0x0022);
		if(objIDataElement == null)
			return null;
		IDicomValue objIDicomValue = objIDataElement.getDicomValue();
		if(objIDicomValue == null)
			return null;
		if(objIDicomValue.getValue()==null)
			return null;
		return (String)objIDicomValue.getValue();
	}

	/**
	 * Sets total number of treatments (Fractions) planned for current Fraction Group.
	 * 
	 * @param strNumberOfFractionsPlanned String value of Number of Fractions Planned.
	 */
	public void setNumberOfFractionsPlanned(String strNumberOfFractionsPlanned)
	{
		/* Accept Number of Fractions Planned 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
		 */
		addDataElement(0x300A, 0x0078, DicomConstants.DCM_DT_IS, strNumberOfFractionsPlanned);
	}

	/**
	 * Retrieves total number of treatments (Fractions) planned for current Fraction Group.
	 * 
	 * @return the number of fractions planned
	 */
	public String getNumberOfFractionsPlanned()
	{
		if (objIDataSet == null)
			return null;
		IDataElement objIDataElement =  objIDataSet.getDataForTag(0x300A, 0x0078);
		if(objIDataElement == null)
			return null;
		IDicomValue objIDicomValue = objIDataElement.getDicomValue();
		if(objIDicomValue == null)
			return null;
		if(objIDicomValue.getValue()==null)
			return null;
		return (String)objIDicomValue.getValue();
	}

	/**
	 * Sets type of brachytherapy treatment technique.
	 * Enumerated Values: INTRALUMENARY, INTRACAVITARY, INTERSTITIAL, CONTACT,INTRAVASCULAR, PERMANENT.
	 * 
	 * @param enumBrachyTreatmentTechnique Enum value of Brachy Treatment Technique.
	 */
	public void setBrachyTreatmentTechnique(EnumBrachyTreatmentTechnique enumBrachyTreatmentTechnique)
	{
		/* Accept Structure Set Label 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
		 */
		addDataElement(0x300A,0x0200, DicomConstants.DCM_DT_CS, enumBrachyTreatmentTechnique.getValue());
	}

	/**
	 * Retrieves brachytherapy treatment technique.
	 * 
	 * @return the brachy treatment technique
	 */
	public String getBrachyTreatmentTechnique()
	{
		if (objIDataSet == null)
			return null;
		IDataElement objIDataElement =  objIDataSet.getDataForTag(0x300A, 0x0200);
		if(objIDataElement == null)
			return null;
		IDicomValue objIDicomValue = objIDataElement.getDicomValue();
		if(objIDicomValue == null)
			return null;
		if(objIDicomValue.getValue()==null)
			return null;
		return (String)objIDicomValue.getValue();
	}

	/**
	 * Sets type of brachytherapy treatment.
	 * Defined Terms:
	 * MANUAL = manually positioned,
	 * HDR = High dose rate,
	 * MDR = Medium dose rate,
	 * LDR = Low dose rate,
	 * PDR = Pulsed dose rate.
	 * 
	 * @param enumBrachyTreatmentType Enum value of Brachy Treatment Type.
	 */
	public void setBrachyTreatmentType(EnumBrachyTreatmentType enumBrachyTreatmentType)
	{
		/* Accept Structure Set Label 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
		 */
		addDataElement(0x300A,0x0202, DicomConstants.DCM_DT_CS, enumBrachyTreatmentType.getValue());
	}

	/**
	 * Retrieves brachytherapy treatment type.
	 * 
	 * @return the brachy treatment type
	 */
	public String getBrachyTreatmentType()
	{
		if (objIDataSet == null)
			return null;
		IDataElement objIDataElement =  objIDataSet.getDataForTag(0x300A, 0x0202);
		if(objIDataElement == null)
			return null;
		IDicomValue objIDicomValue = objIDataElement.getDicomValue();
		if(objIDicomValue == null)
			return null;
		if(objIDicomValue.getValue()==null)
			return null;
		return (String)objIDicomValue.getValue();
	}

	/**
	 * Retrieves pre-initialized object of Recorded Source 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 RecordedSourceSequence - instance of Recorded Source Sequence.
	 */
	public RecordedSourceSequence getRecordedSourceSequence()
	{
		RecordedSourceSequence objRecordedSourceSequence = (RecordedSourceSequence)getDicomValue(0x3008, 0x0100);
		if(objRecordedSourceSequence == 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();
			objRecordedSourceSequence = (RecordedSourceSequence)objDicomV3Factory.createSequence(0x3008, 0x0100, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x3008, 0x0100, DicomConstants.DCM_DT_SQ, objRecordedSourceSequence.getValue());
		}
		return objRecordedSourceSequence;
	}

	/**
	 * Retrieves pre-initialized object of Treatment Session Application Setup 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 TreatmentSessionApplicationSetupSequence - instance of Treatment Session Application Setup Sequence.
	 */
	public TreatmentSessionApplicationSetupSequence getTreatmentSessionApplicationSetupSequence()
	{
		TreatmentSessionApplicationSetupSequence objTreatmentSessionApplicationSetupSequence = (TreatmentSessionApplicationSetupSequence)getDicomValue(0x3008, 0x0110);
		if(objTreatmentSessionApplicationSetupSequence == 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();
			objTreatmentSessionApplicationSetupSequence = (TreatmentSessionApplicationSetupSequence)objDicomV3Factory.createSequence(0x3008, 0x0110, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x3008, 0x0110, DicomConstants.DCM_DT_SQ, objTreatmentSessionApplicationSetupSequence.getValue());
		}
		return objTreatmentSessionApplicationSetupSequence;
	}

	/**
	 * 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;
	}
}
