/*******************************************************************************
 *  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.Tag;
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.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumStereoPairsPresent;

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 module specifies the Attributes of a Multi-frame pixel data Image.
 * 
 * 
 */
public class MultiFrameModule extends Module  
{


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


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

	static
	{
		objSingleCollection = new SingleCollection<ITag>();	
		objSingleCollection.add(new Tag(0x0028,0x0008));
		objSingleCollection.add(new Tag(0x0028,0x0009));
		objSingleCollection.add(new Tag(0x0022,0x0028));
	}

	/**
	 * 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(0x0028,0x0008)))
			throw new MandatoryMissingException("Missing Mandatory Element 0028,0008");
		if(!(isPresent(0x0028,0x0009)))
			throw new MandatoryMissingException("Missing Mandatory Element 0028,0009");
		}catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		return true;
	}

	/**
	 * Sets the total number of frames contained within a Multi-frame Image is conveyed in the Number of Frames.
	 * 
	 * @param strNumberOfFrames - Specifies the number of frames in the image
	 */
	public void setNumberOfFrames(String strNumberOfFrames)
	{
		/*Accept the InstanceNumber 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 Hash Map
		 */
		addDataElement(0x0028,0x0008, DicomConstants.DCM_DT_IS, strNumberOfFrames);
	}

	/**
	 * Sets value that is Used to specify multiple values for Frame Increment Pointer.
	 * 
	 * @param objSingleCollection - Collection of Tags (GroupNumber and ElementNumbers)
	 */
	/*
	 * This method is given since the user can specify multiple GroupNumber and ElementNumbers
	 */
	public void setFrameIncrementPointer(ISingleCollection<ITag> objSingleCollection)
	{
		/*Accept Frame Increment Pointer in String format of type short array.
		 * 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(0x0028, 0x0009, DicomConstants.DCM_DT_AT, objSingleCollection);
	}
	
	/**
	 * Sets Stereo Pairs Present.
	 * The multi-frame pixel data consists of left and right stereoscopic pairs.
	 * Enumerated Values:
	 * 1) YES.
	 * 2) NO.
	 * 
	 * @param enumStereoPairsPresent the enum Stereo Pairs Present
	 */
	public void setStereoPairsPresent(EnumStereoPairsPresent  enumStereoPairsPresent)
	{
		/* Accept Stereo Pairs Present 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(0x0022, 0x0028, DicomConstants.DCM_DT_CS, enumStereoPairsPresent.getValue());
	}

	/**
	 * Retrieves total number of frames contained within a Multi-frame Image.
	 * 
	 * @return String - String value of number of frames.
	 */
	public String getNumberOfFrames()
	{
		if (objIDataSet == null)
			return null;
		IDataElement objIDataElement = objIDataSet.getDataForTag(0x0028, 0x0008);
		if(objIDataElement == null)
			return null;
		IDicomValue objIDicomValue = objIDataElement.getDicomValue();
		if(objIDicomValue == null)
			return null;
		if(objIDicomValue.getValue() == null)
			return null;
		return objIDicomValue.getValue().toString();
	}

	/**
	 * Retrieves the collections of Frame Increment Pointers.
	 * 
	 * @return ISingleCollection<ITag> - collection of Tag objects
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<ITag> getFrameIncrementPointer()
	{
		Object objValue = getValue(0x0028,0x0009);
		if(objValue != null)
			return (ISingleCollection<ITag>)objValue;
		return null;
	}
	
	/**
	 * Retrieves Stereo Pairs Present.
	 * The multi-frame pixel data consists of left and right stereoscopic pairs.
	 * @return String - String value of Stereo Pairs Present.
	 */ 
	public String getStereoPairsPresent()
	{
		Object objValue = getValue(0x0022,0x0028);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/* 
	 * 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 this method is called.
	 * Modified made access protected
	 */
	/**
	 * This method returns the collection of keys representing the DataElements
	 * that belong to this module.
	 * 
	 * @return collection of Tags - returns the collection containing the collection of tags
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}


}
