/*******************************************************************************
 *  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.baselibs;

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.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IItem;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidMacroException;
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;

/**
 * This class represents Table C.8.25.11-2. Subjective Refraction Measurements Macro Attributes
 */
public class SubjectiveRefractionMeasurementsMacro extends Macro 
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	CylinderSequenceMacro objCylinderSequenceMacro = null;
	PrismSequenceMacro objPrismSequenceMacro = null;

	/**
	 * This constructor constructs a Macro with specified Data Set.
	 * @param objDataSet Collection of Data Elements 
	 */
	public SubjectiveRefractionMeasurementsMacro(IDataSet objDataSet)
	{
		super(objDataSet);
	}

	/**
	 * This constructor constructs a Macro with specified Data Set and Dictionary Reader
	 * @param objDataSet specifies the DataSet
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	public SubjectiveRefractionMeasurementsMacro(IDataSet objDataSet,IDictionaryReader objDictionaryReader)
	{
		super(objDataSet,objDictionaryReader);
	}

	/**
	 * This constructor constructs a Macro with the specified Item
	 * @param objItem specifies instance of Item class
	 */
	public SubjectiveRefractionMeasurementsMacro(IItem objItem)
	{
		super(objItem);
	}

	/**
	 * This constructor constructs a Macro with the specified Item and DictionaryReader
	 * @param objItem specifies instance of Item class
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	public SubjectiveRefractionMeasurementsMacro(IItem objItem,IDictionaryReader objDictionaryReader)
	{
		super(objItem, objDictionaryReader);
	}

	/**
	 * Validates all the attributes in SubjectiveRefractionMeasurementsMacro
	 * @return boolean - Success -true, Failure -false.
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public boolean validate() throws InvalidMacroException
	{
		if(iMacroLevel == DicomConstants.DCM_MODULE_LEVEL_MACRO)
			return validate(objIDataSet);
		return false;
	}

	/**
	 * Validates all the attributes in SubjectiveRefractionMeasurementsMacro that are present in the DataSet
	 * @param objIDataSet collection of DataElements
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public boolean validate(IDataSet objIDataSet) throws InvalidMacroException
	{
		try{
			if(!objIDataSet.isPresent(0x0046,0x0146))
				throw new MandatoryMissingException("0046,0146)");
	    	}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(mme.getMessage());
			}
			throw new InvalidMacroException(this.getClass().getSimpleName(),mme);
		}
		catch( ValidationException ve)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ve.getMessage());
			}
			throw new InvalidMacroException(this.getClass().getSimpleName(),ve);
		}
		return true;
	}
	/**
	 * Validates all the attributes in SubjectiveRefractionMeasurementsMacro that are present in the DataSet
	 * @param objIItem collection of DataElements in a sequence
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public static boolean validate(IItem objIItem) throws InvalidMacroException
	{
		try
		{
			if(!objIItem.contains(0x0046,0x0146))
				throw new MandatoryMissingException("0046,0146)");
			
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidMacroException(KeratometricMeasurementsMacro.class.getSimpleName(),ce); 
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidMacroException(KeratometricMeasurementsMacro.class.getSimpleName(),me);
		}
		return true;
	}
	
	/**
	 * This method returns the Cylinder Sequence Macro with proper initialization.
	 * @return - instance of {@link CylinderSequenceMacro} 
	 */
	public CylinderSequenceMacro getCylinderSequenceMacro()
	{
		if(objCylinderSequenceMacro == null)
		{
			if(iMacroLevel == DicomConstants.DCM_MODULE_LEVEL_MACRO)
				objCylinderSequenceMacro = new CylinderSequenceMacro(objIDataSet);
			else 
				objCylinderSequenceMacro = new CylinderSequenceMacro(objIItem);

			return objCylinderSequenceMacro;
		}
		return objCylinderSequenceMacro;
	}
	/**
	 * This method returns the Prism Sequence Macro with proper initialization.
	 * @return - instance of {@link PrismSequenceMacro} 
	 */
	public PrismSequenceMacro getPrismSequenceMacro()
	{
		if(objPrismSequenceMacro == null)
		{
			if(iMacroLevel == DicomConstants.DCM_MODULE_LEVEL_MACRO)
				objPrismSequenceMacro = new PrismSequenceMacro(objIDataSet);
			else 
				objPrismSequenceMacro = new PrismSequenceMacro(objIItem);

			return objPrismSequenceMacro;
		}
		return objPrismSequenceMacro;
	}
	/**
	 * Retrieves pre-initialized object of Add Near Sequence.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 AddNearSequence - instance of Add Near Sequence. 
	 */
	public AddNearSequence getAddNearSequence()
	{
		AddNearSequence objAddNearSequence = null;
		IDataElement objIDataElement =  getDataElement(0x0046, 0x0100); 
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objAddNearSequence = (AddNearSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objAddNearSequence = (AddNearSequence)objDicomV3Factory.createSequence(0x0046, 0x0100, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0046, 0x0100, objAddNearSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0046, 0x0100, DicomConstants.DCM_DT_SQ, objAddNearSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objAddNearSequence;
	}
	
	/**
	 * Retrieves pre-initialized object of Add Intermediate Sequence.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 AddIntermediateSequence - instance of Add Intermediate Sequence. 
	 */
	public AddIntermediateSequence getAddIntermediateSequence()
	{
		AddIntermediateSequence objAddIntermediateSequence = null;
		IDataElement objIDataElement =  getDataElement(0x0046, 0x0101); 
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objAddIntermediateSequence = (AddIntermediateSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objAddIntermediateSequence = (AddIntermediateSequence)objDicomV3Factory.createSequence(0x0046, 0x0101, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0046, 0x0101, objAddIntermediateSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0046, 0x0101, DicomConstants.DCM_DT_SQ, objAddIntermediateSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objAddIntermediateSequence;
	}
	/**
	 * Retrieves pre-initialized object of Add Other Sequence.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 AddOtherSequence - instance of Add Other Sequence. 
	 */
	public AddOtherSequence getAddOtherSequence()
	{
		AddOtherSequence objAddOtherSequence = null;
		IDataElement objIDataElement =  getDataElement(0x0046, 0x0102); 
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objAddOtherSequence = (AddOtherSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objAddOtherSequence = (AddOtherSequence)objDicomV3Factory.createSequence(0x0046, 0x0102, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0046, 0x0102, objAddOtherSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0046, 0x0102, DicomConstants.DCM_DT_SQ, objAddOtherSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objAddOtherSequence;
	}
	/**
	 * Sets the Refractive power of the eye that is the same in all meridians,measured at distance (optical infinity), in diopters.
	 * @param dblSpherePower Double value of Sphere Power
	 */
	public void setSpherePower(double dblSpherePower)
	{
		/*Accept the Sphere Power in double format of type FD.
		 * 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
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0046,0x0146, dblSpherePower,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0046,0x0146,DicomConstants.DCM_DT_FD, dblSpherePower);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Refractive power of the eye that is the same in all meridians,measured at distance (optical infinity), in diopters.
	 * @return double - double value of Sphere Power
	 */
	public double getSpherePower()
	{
		Object objValue = getValue(0x0046,0x0146);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
}
