/*******************************************************************************
 *  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.DimensionIndexSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.DimensionOrganizationSequence;
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 module specifies the attributes of the Multi-frame Dimension Module.
 * 
 * 
 */

public class MultiFrameDimensionModule extends Module  
{


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


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

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0020,0x9221));
		objSingleCollection.add(new Tag(0x0020,0x9222));
	}

	/**
	 * 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 - returns validation status as success or failure
	 * 
	 * @throws InvalidModuleException - If validation of Module fails
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{			
			if(!isPresent(0x0020, 0x9221))
				throw new MandatoryMissingException("Mandatory element 0020,9221 missing");
			if(!isPresent(0x0020, 0x9311))
				throw new MandatoryMissingException("Mandatory element 0020,9311 missing");
			if(!isPresent(0x0020, 0x9222))
				throw new MandatoryMissingException("Mandatory element 0020,9222 missing");

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

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

		}
		return true;
	}

	/**
	 * Retrieves an instance of {@link DimensionOrganizationSequence}that lists the Dimension Organization UIDs referenced by the
	 * containing SOP Instance.
	 * 
	 * @return - instance of Dimension Organization Sequence.
	 */
	public DimensionOrganizationSequence getDimensionOrganizationSequence()
	{
		DimensionOrganizationSequence objDimensionOrganizationSequence = (DimensionOrganizationSequence)getDicomValue(0x0020, 0x9221);
		if(objDimensionOrganizationSequence == 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();
			objDimensionOrganizationSequence = (DimensionOrganizationSequence)objDicomV3Factory.createSequence(0x0020, 0x9221, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0020, 0x9221, DicomConstants.DCM_DT_SQ, objDimensionOrganizationSequence.getValue());
		}
		return objDimensionOrganizationSequence;
	}
	
	/**
	 * Sets Dimension Organization Type
	 * @param strDimensionOrganizationType String value of Dimension Organization Type.
	 */
	public void setDimensionOrganizationType(String strDimensionOrganizationType)
	{
		/* Accept DimensionOrganizationType 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 Hash Map
		 */
		addDataElement(0x0020,0x9311, DicomConstants.DCM_DT_CS, strDimensionOrganizationType);
	}
	
	/**
	 * Returns Dimension Organization Type.
	 * 
	 * @return String - String value of Dimension Organization Type.
	 */
	public String getDimensionOrganizationType()
	{
		 Object objValue = getValue(0x0020,0x9311);
		 if(objValue!=null)
			 return objValue.toString();
		 return null;

	}

	/**
	 * Retrieves an instance of {@link DimensionIndexSequence} Uniquely identifies a set of dimensions referenced within the containing SOP Instance.
	 * 
	 * @return - instance of Dimension Index Sequence.
	 */
	public DimensionIndexSequence getDimensionIndexSequence()
	{
		DimensionIndexSequence objDimensionIndexSequence = (DimensionIndexSequence)getDicomValue(0x0020, 0x9222);
		if(objDimensionIndexSequence == 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();
			objDimensionIndexSequence = (DimensionIndexSequence)objDicomV3Factory.createSequence(0x0020, 0x9222, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0020, 0x9222, DicomConstants.DCM_DT_SQ, objDimensionIndexSequence.getValue());
		}
		return objDimensionIndexSequence;
	}

	/**
	 * This method returns the vector of keys representing the DataElements
	 * that belong to this module.
	 * 
	 * @return - the customized collection containing the dataelement tags
	 * that belong to this module
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
