/*******************************************************************************
 *  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.ContentIdentificationMacro;
import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.RegistrationSequence;
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.exceptions.InvalidModuleException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.exceptions.ValidationException;
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 that describe Spatial Registration  Module.
*/
public class SpatialRegistrationModule extends Module  
{


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

	/**
	 * The obj Content Identification Macro.
	 */
	ContentIdentificationMacro objContentIdentificationMacro = null;

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

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x0023));
		objSingleCollection.add(new Tag(0x0008,0x0033));
		objSingleCollection.add(new Tag(0x0070,0x0308));
	}

	/**
	 * Get the Instance of Content Identification Macro.Attributes related to Content Identification Macro will be set in Macro
	 * using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco
	 * Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was
	 * set in the last call to its setter method.
	 * 
	 * @return - object of code sequence macro which the user programmer can populate
	 */
	public ContentIdentificationMacro getContentIdentificationMacro()
	{
		if(objContentIdentificationMacro == null)
			objContentIdentificationMacro = new ContentIdentificationMacro(objIDataSet);
		return objContentIdentificationMacro; 
	}
	
	/**
	 * Sets attribute identifies date the content creation started.
	 * 
	 * @param strContentDate - String identifies date.
	 */	
	public void setContentDate(String strContentDate)
	{
		/*Accept The date on image pixel data creation started in String format of type DA.
		 * 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(0x0008,0x0023, DicomConstants.DCM_DT_DA, strContentDate);
	}

	/**
	 * Return date the content creation started.
	 * 
	 * @return String - String identifies date the content creation started.
	 */
	public String getContentDate()
	{
		IDataElement objIDataElement =objIDataSet.getDataForTag(0x0008,0x0023);
		if(objIDataElement == null)
			return null;
		IDicomValue objIDicomValue = objIDataElement.getDicomValue();
		if(objIDicomValue == null)
			return null;
		if(objIDicomValue.getValue()==null)
			return null;
		return objIDicomValue.getValue().toString();
	}


	/**
	 * Sets attribute identifies time the content creation started.
	 * 
	 * @param strContentTime - String identifies time
	 */	
	public void setContentTime(String strContentTime)
	{
		/*Accept The Time at which image pixel data creation started in String format of type DA.
		 * 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(0x0008, 0x0033, DicomConstants.DCM_DT_TM, strContentTime);
	}

	/**
	 * Return time the content creation started.
	 * 
	 * @return String - String identifies time.
	 */
	public String getContentTime()
	{
		IDataElement objIDataElement = objIDataSet.getDataForTag(0x0008,0x0033);
		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 pre-initialized object of RegistrationSequence.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 RegistrationSequence - instance of Referenced Reference Image Sequence.
	 */
	public RegistrationSequence getRegistrationSequence()
	{
		RegistrationSequence objRegistrationSequence = (RegistrationSequence)getDicomValue(0x0070,0x0308);
		if(objRegistrationSequence == 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();
			objRegistrationSequence = (RegistrationSequence)objDicomV3Factory.createSequence(0x0070,0x0308, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0070,0x0308, DicomConstants.DCM_DT_SQ, objRegistrationSequence.getValue());
		}
		return objRegistrationSequence;
	}

	/**
	 * 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 - status indicating success or failure
	 * 
	 * @throws InvalidModuleException the invalid module exception
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{	
			getContentIdentificationMacro().validate();
			
			//Check for the Type 1,2 Mandatory Attributes.
			if(!isPresent(0x0008,0x0023))
			{
				throw new MandatoryMissingException("0008,0023");
			}
			if(!isPresent(0x0008,0x0033))
			{
				throw new MandatoryMissingException("0008,0033");
			}
			if(!isPresent(0x0070,0x0308))
			{
				throw new MandatoryMissingException("0070,0308");
			}

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

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

		}
		catch(ValidationException ve)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(ve.getMessage());

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

		}
		return true;
	}

	/**
	 * This method returns the vector containing the list of DataElements belonging to the Spatial
	 * Registration Module specified by DICOM Standard.
	 * 
	 * @return collection - custom collection containing the list of DataElements belonging to the Spatial Registration Series Module
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
