/*******************************************************************************
 *  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.BeamSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.BeamSequenceItem;
import cdac.medinfo.sdk.dcm30_04.baselibs.BlockSequenceItem;
import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IItem;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;

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 contains information defining equipment parameters for delivery of external radiation beams.
 * 
 * 
 */
public class RTBeamsModule extends Module  
{


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


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

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x300A,0x00B0));
	}


	/**
	 * 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(0x300A,0x00B0))
				throw new MandatoryMissingException("300A,00B0");

			//Validation for BlockSequence 
			ICollectionIterator<IItem> objBeamSequenceIterator = getBeamSequence().iterator();
			BeamSequenceItem objBeamSequenceItem = null;
			while(objBeamSequenceIterator.hasNext())
			{
				objBeamSequenceItem = (BeamSequenceItem)objBeamSequenceIterator.next();
				ICollectionIterator<IItem> objBlockSequenceIterator = objBeamSequenceItem.getBlockSequence().iterator();
				BlockSequenceItem objBlockSequenceItem = null;
				while(objBlockSequenceIterator.hasNext())
				{

					objBlockSequenceItem = (BlockSequenceItem)objBlockSequenceIterator.next();
					String strMaterialID = objBlockSequenceItem.getMaterialID();
					if((strMaterialID.length() != 0) && (objBlockSequenceItem.contains(0x300A,0x0100)))
						throw new ConditionFailedException("Element 300A,0100 is required if Material ID is non-zero length in BlockSequence");
					if((strMaterialID.length() == 0) && (objBlockSequenceItem.contains(0x300A,0x0102)))
						throw new ConditionFailedException("Element 300A,0102 is required if Material ID is zero length in BlockSequence");
				}
			}

		}
		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 Beam 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 BeamSequence - instance of Beam Sequence.
	 */
	public BeamSequence getBeamSequence()
	{
		BeamSequence objBeamSequence = (BeamSequence)getDicomValue(0x300A,0x00B0);
		if(objBeamSequence == 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();
			objBeamSequence = (BeamSequence)objDicomV3Factory.createSequence(0x300A,0x00B0, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x300A,0x00B0, DicomConstants.DCM_DT_SQ, objBeamSequence.getValue());
		}
		return objBeamSequence;
	}

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