/*******************************************************************************
 *  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.OphthalmicAcquisitionParametersMacro;
import cdac.medinfo.sdk.dcm30_04.baselibs.PatientEyeMovementCommandCodeSequence;
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.enums.EnumPatientEyeMovementCommanded;

import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidMacroException;
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 that describe an Ophthalmic Photography Acquisition Parameters Module
 \* This module describes patient clinical conditions related to the image acquisition.
 */
public class OphthalmicPhotographyAcquisitionParametersModule extends Module   
{


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

	/**
	 * The obj code sequence macro.
	 */
	OphthalmicAcquisitionParametersMacro objOphthalmicAcquisitionParametersMacro = null;


	/**
	 * Instantiates a new ophthalmic photography acquisition parameters module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public OphthalmicPhotographyAcquisitionParametersModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0022,0x0005));
		objSingleCollection.add(new Tag(0x0022,0x0006));

	}

	/**
	 * 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
	 */	
	@Override
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{			/*
		 * Validation Rules for Mandatory Elements
		 */
			getOphthalmicAcquisitionParametersMacro().validate();
			
			if(!isPresent(0x0022, 0x0005))
				throw new MandatoryMissingException("0022,0005");

			String strYes = EnumPatientEyeMovementCommanded.YES.getValue();
			String strPatientEyeMovementCommandCodeSequence = getPatientEyeMovementCommanded();
			if(strYes.equals(strPatientEyeMovementCommandCodeSequence) && !isPresent(0x0022, 0x0006))
				throw new ConditionFailedException("0022,0006 required if value of conditional Element 0028,0005 is"+ strYes);

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

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

		}
		catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(cfe.getMessage());

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

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

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

		}
		return true;
	}
	
	/**
	 * Get the Instance of Ophthalmic Acquisition Parameters Macro.Attributes related to OphthalmicAcquisitionParameters 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 Ophthalmic Acquisition Parameters Macro which the user programmer can populate
	 */
	public OphthalmicAcquisitionParametersMacro getOphthalmicAcquisitionParametersMacro()
	{
		if(objOphthalmicAcquisitionParametersMacro == null)
			objOphthalmicAcquisitionParametersMacro = new OphthalmicAcquisitionParametersMacro(objIDataSet);
		return objOphthalmicAcquisitionParametersMacro; 
	}


	/**
	 * Sets the value of Patient Eye Movement Commanded.
	 * 
	 * @param enumPatientEyeMovementCommanded - Enum of value of Patient Eye Movement Commanded
	 */	
	public void setPatientEyeMovementCommanded(EnumPatientEyeMovementCommanded enumPatientEyeMovementCommanded)
	{
		/*Accept the value ofPatient Eye Movement Commanded in Enumeration 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(0x0022, 0x0005, DicomConstants.DCM_DT_CS, enumPatientEyeMovementCommanded.getValue());
	}

	/**
	 * Retrieves the value of Patient Eye Movement Commanded.
	 * 
	 * @return the patient eye movement commanded
	 */
	public String getPatientEyeMovementCommanded()
	{
		Object objValue = getValue(0x0022,0x0005);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * This method Returns provides the pre-initialized object of Patient Eye Movement Command Code Sequence
	 * return - object of Patient Eye Movement Command Code Sequence. If the module contans 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 SourceImageSequence - the Patient Eye Movement Command Code Sequence
	 */
	public PatientEyeMovementCommandCodeSequence getPatientEyeMovementCommandCodeSequence()
	{
		PatientEyeMovementCommandCodeSequence objPatientEyeMovementCommandCodeSequence = (PatientEyeMovementCommandCodeSequence)getDicomValue(0x0022, 0x0006);
		if(objPatientEyeMovementCommandCodeSequence == 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();
			objPatientEyeMovementCommandCodeSequence = (PatientEyeMovementCommandCodeSequence)objDicomV3Factory.createSequence(0x0022, 0x0006, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0022, 0x0006, DicomConstants.DCM_DT_SQ, objPatientEyeMovementCommandCodeSequence.getValue());
		}
		return objPatientEyeMovementCommandCodeSequence;
	}

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

