/*******************************************************************************
 *  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.DVHSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedStructureSetSequence;
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
/**
 * The RT DVH module provides for the inclusion of differential or cumulative dose volume
 * histogram data. The data contained within this module may supplement dose data in the RT
 * Dose and/or RT Dose ROI modules, or it may be present in the absence of other dose data.
 */
public class RTDVHModule extends Module  
{


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


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

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x300C,0x0060));
		objSingleCollection.add(new Tag(0x3004,0x0040));
		objSingleCollection.add(new Tag(0x3004,0x0042));
		objSingleCollection.add(new Tag(0x3004,0x0050));
	}

	/**
	 * 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(0x300C,0x0060))
				throw new MandatoryMissingException("300C,0060");
			else
				getReferencedStructureSetSequence().validateForModule();
			if(!isPresent(0x3004,0x0050))
				throw new MandatoryMissingException("3004,0050");
			else
				getDVHSequence().validateForModule();

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

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

		}
		return true;
	}

	/**
	 * Retrieves pre-initialized object of Referenced Structure Set 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 ReferencedStructureSetSequence - instance of Referenced Structure Set Sequence.
	 */
	public ReferencedStructureSetSequence getReferencedStructureSetSequence()
	{
		ReferencedStructureSetSequence objReferencedStructureSetSequence = (ReferencedStructureSetSequence)getDicomValue(0x300C,0x0060);
		if(objReferencedStructureSetSequence == 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();
			objReferencedStructureSetSequence = (ReferencedStructureSetSequence)objDicomV3Factory.createSequence(0x300C,0x0060, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x300C,0x0060, DicomConstants.DCM_DT_SQ, objReferencedStructureSetSequence.getValue());
		}
		return objReferencedStructureSetSequence;
	}

	/**
	 * This method is used to set Coordinates (x, y, z) of common DVH normalization point in the patient based coordinate system.
	 * The function accepts a String Value and creates the
	 * DE based on the transfer syntax and populates the DE with right values.
	 * This DE is then added to the Module HashMap
	 * 
	 * @param arrStrDVHNormalizationPoint : String array of DVH Normalization Point
	 */	
	public void setDVHNormalizationPoint(String[] arrStrDVHNormalizationPoint)
	{
		/*Accept DVH Normalization Point in String array format of type DS.
		 * 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(0x3004,0x0040, DicomConstants.DCM_DT_DS, arrStrDVHNormalizationPoint);
	}

	/**
	 * Retrieves DVH Normalization Point.
	 * 
	 * @return - String array of  DVH Normalization Point
	 */
	public String[] getDVHNormalizationPoint()
	{
		 Object objValue = getValue(0x3004,0x0040);
   if(objValue!=null)
      return (String[])objValue;
   return null;

	}

	/**
	 * The method is used to set DVH Normalization Dose Value.
	 * Dose Value at DVH Normalization Point (3004,0040) used as reference for individual DVHs when Dose Units
	 * (3004,0002) is RELATIVE.
	 * The function accepts a String Value strDVHNormalizationDose Value and creates the
	 * DE based on the transfer syntax and populates the DE with right values.
	 * This De is then added to the Module HashMap
	 * 
	 * @param strDVHNormalizationDoseValue :String value of DVH Normalization Dose Value
	 */
	public void setDVHNormalizationDoseValue(String strDVHNormalizationDoseValue)
	{
		/*Accept DVH Normalization Dose Value 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(0x3004,0x0042, DicomConstants.DCM_DT_DS, strDVHNormalizationDoseValue);
	}

	/**
	 * Retrieves the DVH Normalization Dose Value.
	 * 
	 * @return - String value of DVH Normalization Dose Value
	 */
	public String getDVHNormalizationDoseValue()
	{
		Object objectValue = getValue(0x3004,0x0042);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}


	/**
	 * Retrieves pre-initialized object of DVH 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 DVHSequence - instance of DVH Sequence.
	 */
	public DVHSequence getDVHSequence()
	{
		DVHSequence objDVHSequence = (DVHSequence)getDicomValue(0x3004,0x0050);
		if(objDVHSequence == 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();
			objDVHSequence = (DVHSequence)objDicomV3Factory.createSequence(0x3004,0x0050, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x3004,0x0050, DicomConstants.DCM_DT_SQ, objDVHSequence.getValue());
		}
		return objDVHSequence;
	}

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