/*******************************************************************************
 *  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.EnergyWindowInformationSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.InterventionDrugInformationSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.RadiopharmaceuticalInformationSequence;
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 class specifies Attributes that describe the isotope administered for the acquisition.
 */
public class NMIsotopeModule extends Module  
{


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


	/**
	 * Instantiates a new nM isotope module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public NMIsotopeModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0018,0x0026));
		objSingleCollection.add(new Tag(0x0054,0x0012));
		objSingleCollection.add(new Tag(0x0054,0x0016));
	}

	/**
	 * 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
		{		
			if(!isPresent(0x0054,0x0012))
				throw new MandatoryMissingException("Missing Mandatory Element 0054,0012");
			else if(!isPresent(0x0054,0x0016))
				throw new MandatoryMissingException("Missing Mandatory Element 0054,0016");
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		return true;
	}

	/**
	 * Sequence of Repeating Items that describe the energy window groups used.
	 * The number of items shall be equal to Number of Energy Windows (0054,0011).
	 * The first item corresponds to frames with value of 1 in the Energy Window Vector
	 * (0054,0010), the second item with value 2, etc.
	 * 
	 * @return the energy window information sequence
	 */
	public EnergyWindowInformationSequence getEnergyWindowInformationSequence()
	{
		EnergyWindowInformationSequence objEnergyWindowInformationSequence = (EnergyWindowInformationSequence)getDicomValue(0x0054, 0x0012);
		if(objEnergyWindowInformationSequence == 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();
			objEnergyWindowInformationSequence = (EnergyWindowInformationSequence)objDicomV3Factory.createSequence(0x0054, 0x0012, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0054, 0x0012, DicomConstants.DCM_DT_SQ, objEnergyWindowInformationSequence.getValue());
		}
		return objEnergyWindowInformationSequence;
	}

	/**
	 * Sequence of Repeating Items that describe isotope information.
	 * One or more Items may be included in this sequence.
	 * 
	 * @return the radiopharmaceutical information sequence
	 */
	public RadiopharmaceuticalInformationSequence getRadiopharmaceuticalInformationSequence()
	{
		RadiopharmaceuticalInformationSequence objRadiopharmaceuticalInformationSequence = (RadiopharmaceuticalInformationSequence)getDicomValue(0x0054, 0x0016);
		if(objRadiopharmaceuticalInformationSequence == 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();
			objRadiopharmaceuticalInformationSequence = (RadiopharmaceuticalInformationSequence)objDicomV3Factory.createSequence(0x0054, 0x0016, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0054, 0x0016, DicomConstants.DCM_DT_SQ, objRadiopharmaceuticalInformationSequence.getValue());
		}
		return objRadiopharmaceuticalInformationSequence;
	}

	/**
	 * Return instance of Intervention Drug Information Sequence.
	 * 
	 * @return the intervention drug information sequence
	 */
	public InterventionDrugInformationSequence getInterventionDrugInformationSequence()
	{
		InterventionDrugInformationSequence objInterventionDrugInformationSequence = (InterventionDrugInformationSequence)getDicomValue(0x0018, 0x0026);
		if(objInterventionDrugInformationSequence == 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();
			objInterventionDrugInformationSequence = (InterventionDrugInformationSequence)objDicomV3Factory.createSequence(0x0018, 0x0026, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0018, 0x0026, DicomConstants.DCM_DT_SQ, objInterventionDrugInformationSequence.getValue());
		}
		return objInterventionDrugInformationSequence;
	}

	/* 
	 * I have modified the collection type from vector to custom class
	 * This method is used by the Module Iterator to iterate through the DataSet and return only
	 * those elements that belong to the respective Module class whose getVectorOfKeys is called.
	 * Modified made access protected
	 */
	/**
	 * 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;
	}
}
