/*******************************************************************************
 *  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.AnteriorChamberDepthDefinitionCodeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.OphthalmicAxialMeasurementsLeftEyeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.OphthalmicAxialMeasurementsRightEyeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.OphthalmicUltrasoundMethodCodeSequence;
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.EnumOphthalmicAxialMeasurementsDeviceType;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
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;
/**
 \* This module describes attributes in Ophthalmic Axial Measurements Module.
 */
public class OphthalmicAxialMeasurementsModule extends Module
{
	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;


	/**
	 * Creates Ophthalmic Axial Measurements Module with default initialization.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public OphthalmicAxialMeasurementsModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0022,0x1009));
		objSingleCollection.add(new Tag(0x0022,0x1007));
		objSingleCollection.add(new Tag(0x0022,0x1008));
		objSingleCollection.add(new Tag(0x0022,0x1044));
		objSingleCollection.add(new Tag(0x0022,0x1125));
	}

	/**
	 * 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 true, if validate module
	 * 
	 * @throws InvalidModuleException - If validation of Module fails
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{			/*
		 * Validation Rules for Mandatory Elements
		 */
			if(!isPresent(0x0022,0x1009))
				throw new MandatoryMissingException("0022,1009");
			
			String strOphthalmicAxialMeasurementsDeviceType = getOphthalmicAxialMeasurementsDeviceType();
			if(strOphthalmicAxialMeasurementsDeviceType.equalsIgnoreCase(EnumOphthalmicAxialMeasurementsDeviceType.ULTRASOUND.getValue()))
				if(!isPresent(0x022,0x1044))
				throw new ConditionFailedException("0022,1044 required if Ophthalmic Axial Measurements DeviceType (0022,1009) is ULTRASOUND.");

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

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

		}
		return true;
	}
	
	/**
	 * Sets the OphthalmicAxialMeasurementsDeviceType.
	 * 
	 * @param enumOphthalmicAxialMeasurementsDeviceType
	 */	
	public void setOphthalmicAxialMeasurementsDeviceType(EnumOphthalmicAxialMeasurementsDeviceType enumOphthalmicAxialMeasurementsDeviceType)
	{
		/*Accept the OphthalmicAxialMeasurementsDeviceType value 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(0x0022, 0x1009, DicomConstants.DCM_DT_CS, enumOphthalmicAxialMeasurementsDeviceType.getValue());
	}
	
	/**
	 * Retrieves OphthalmicAxialMeasurementsDeviceType
	 * 
	 * @return String - String value of OphthalmicAxialMeasurementsDeviceType.
	 */
	public String getOphthalmicAxialMeasurementsDeviceType()
	{
		Object objectValue = getValue(0x0022, 0x1009);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	
	/**
	 * This method provides the pre-initialized object of OphthalmicUltrasoundMethodCodeSequence.
	 * @return - object ofOphthalmicUltrasoundMethodCodeSequence. 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
	 */
	public OphthalmicUltrasoundMethodCodeSequence getOphthalmicUltrasoundMethodCodeSequence()
	{
		OphthalmicUltrasoundMethodCodeSequence objOphthalmicUltrasoundMethodCodeSequence = (OphthalmicUltrasoundMethodCodeSequence)getDicomValue(0x0022, 0x1044);
		if(objOphthalmicUltrasoundMethodCodeSequence == 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();
			objOphthalmicUltrasoundMethodCodeSequence = (OphthalmicUltrasoundMethodCodeSequence)objDicomV3Factory.createSequence(0x0022, 0x1044, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0022, 0x1044, DicomConstants.DCM_DT_SQ, objOphthalmicUltrasoundMethodCodeSequence.getValue());
		}
		return objOphthalmicUltrasoundMethodCodeSequence;
	}
	/**
	 * This method provides the pre-initialized object of AnteriorChamberDepthDefinitionCodeSequence.
	 * @return - object AnteriorChamberDepthDefinitionCodeSequence. 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
	 */
	public AnteriorChamberDepthDefinitionCodeSequence getAnteriorChamberDepthDefinitionCodeSequence()
	{
		AnteriorChamberDepthDefinitionCodeSequence objAnteriorChamberDepthDefinitionCodeSequence = (AnteriorChamberDepthDefinitionCodeSequence)getDicomValue(0x0022, 0x1125);
		if(objAnteriorChamberDepthDefinitionCodeSequence == 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();
			objAnteriorChamberDepthDefinitionCodeSequence = (AnteriorChamberDepthDefinitionCodeSequence)objDicomV3Factory.createSequence(0x0022, 0x1125, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0022, 0x1125, DicomConstants.DCM_DT_SQ, objAnteriorChamberDepthDefinitionCodeSequence.getValue());
		}
		return objAnteriorChamberDepthDefinitionCodeSequence;
	}
	
	/**
	 * This method provides the pre-initialized object of OphthalmicAxialMeasurementsRightEyeSequence.
	 * @return - object OphthalmicAxialMeasurementsRightEyeSequence. 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
	 */
	public OphthalmicAxialMeasurementsRightEyeSequence getOphthalmicAxialMeasurementsRightEyeSequence()
	{
		OphthalmicAxialMeasurementsRightEyeSequence objOphthalmicAxialMeasurementsRightEyeSequence = (OphthalmicAxialMeasurementsRightEyeSequence)getDicomValue(0x0022, 0x1007);
		if(objOphthalmicAxialMeasurementsRightEyeSequence == 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();
			objOphthalmicAxialMeasurementsRightEyeSequence = (OphthalmicAxialMeasurementsRightEyeSequence)objDicomV3Factory.createSequence(0x0022, 0x1007, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0022, 0x1007, DicomConstants.DCM_DT_SQ, objOphthalmicAxialMeasurementsRightEyeSequence.getValue());
		}
		return objOphthalmicAxialMeasurementsRightEyeSequence;
	}
	
	/**
	 * This method provides the pre-initialized object of OphthalmicAxialMeasurementsLeftEyeSequence.
	 * @return - object OphthalmicAxialMeasurementsLeftEyeSequence. 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
	 */
	public OphthalmicAxialMeasurementsLeftEyeSequence getOphthalmicAxialMeasurementsLeftEyeSequence()
	{
		OphthalmicAxialMeasurementsLeftEyeSequence objOphthalmicAxialMeasurementsLeftEyeSequence = (OphthalmicAxialMeasurementsLeftEyeSequence)getDicomValue(0x0022, 0x1008);
		if(objOphthalmicAxialMeasurementsLeftEyeSequence == 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();
			objOphthalmicAxialMeasurementsLeftEyeSequence = (OphthalmicAxialMeasurementsLeftEyeSequence)objDicomV3Factory.createSequence(0x0022, 0x1008, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0022, 0x1008, DicomConstants.DCM_DT_SQ, objOphthalmicAxialMeasurementsLeftEyeSequence.getValue());
		}
		return objOphthalmicAxialMeasurementsLeftEyeSequence;
	}
	/**
	 * This method returns the collection of keys representing the DataElements that belong to this module.
	 * 
	 * @return Collection of Tags - returns the collection containing the tags
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
