/*******************************************************************************
 *  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.PhaseInformationSequence;
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.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
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 specifies Attributes that describe dynamic phases of a dynamic acquisition image
 * performed on the patient. This module is present only when Image Type (0008,0008), Value 3, is
 * equal to DYNAMIC. A phase is defined as a collection of frames in which the acquisition time per
 * frame and the time delay between frames remains constant. A new phase shall be defined
 * whenever there is a change in the time between frames, the acquisition time per frame, or the
 * position of the patient relative to the detector.
 * 
 * 
 */
public class NMPhaseModule extends Module  
{

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

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

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

	/**
	 * 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
			{		
				NMMultiFrameModule objNMMultiFrameModule = new NMMultiFrameModule(objIDataSet);
			if(isPresent(0x0028,0x0009))
			{
				ISingleCollection<ITag> objISingleCollection = objNMMultiFrameModule.getFrameIncrementPointer();
				if (objISingleCollection != null)
				{
					if(isTagPresent(objISingleCollection, 0x0054,0x0030) && !(isPresent(0x0054,0x0032)))
						throw new ConditionFailedException("Required if the Frame Increment Pointer (0028,0009) contains the Tag for Phase Vector (0054,0030).");
				}
			}
			}catch(ConditionFailedException cfe)
			{
				if(DicomConfig.createInstance().isLoggingOn())
					DicomLogger.getLogger().log(cfe.getMessage());

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

					}
		return true;
	}

	/*
	 * This method checks if the DataElement for the specified GroupNumber and ElementNumber is present
	 * in the FrameIncrementPointer (0028,0009) value.
	 */
	/**
	 * Checks if is tag present.
	 * 
	 * @param objISingleCollection the obj i single collection
	 * @param iGroupNumber the i group number
	 * @param iElementNumber the i element number
	 * 
	 * @return true, if is tag present
	 */
	@SuppressWarnings("unchecked")
	private static boolean isTagPresent(ISingleCollection objISingleCollection, int iGroupNumber, int iElementNumber)
	{
		ICollectionIterator<ITag> objICollectionIterator = objISingleCollection.iterator();
		while(objICollectionIterator.hasNext())
		{
			ITag objITag = new Tag(iGroupNumber,iElementNumber);
			if(objISingleCollection.contains(objITag))
				return true;
			objICollectionIterator.next();
		}
		return false;
	}

	/**
	 * Retrieves Sequence of Repeating Items that describes each dynamic phase. Required if the Frame Increment Pointer
	 * (0028,0009) contains the Tag for Phase Vector (0054,0030). The number of items shall be equal to Number of Phases
	 * (0054,0031). The first item corresponds to frames with value of 1 in the Phase Vector (0054,0030), the second item with
	 * value 2, etc.
	 * 
	 * @return - instance of PhaseInformationSequence.
	 */
	public PhaseInformationSequence getPhaseInformationSequence()
	{
		PhaseInformationSequence objPhaseInformationSequence = (PhaseInformationSequence)getDicomValue(0x0054, 0x0032);
		if(objPhaseInformationSequence == 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();
			objPhaseInformationSequence = (PhaseInformationSequence)objDicomV3Factory.createSequence(0x0054, 0x0032, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0054, 0x0032, DicomConstants.DCM_DT_SQ, objPhaseInformationSequence.getValue());
		}
		return objPhaseInformationSequence;
	}

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