/*******************************************************************************
 *  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.IDicomValue;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
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 item class contains methods to validate, set and get the attributes of Selected Total Ophthalmic Axial Length Sequence .
 */

public class SelectedTotalOphthalmicAxialLengthSequenceItem extends Item
{
	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	SelectedTotalOphthalmicAxialLengthSequenceItem()
	{
		super();
	}

	/*
	 * This constructor calls the respective superclass constructor
	 * This constructor should throw exception if null TS is tried to be set
	 */
	/**
	 * This constructor creates the item with specified TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	SelectedTotalOphthalmicAxialLengthSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates SelectedSegmentalOphthalmicAxialLengthSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used.
	 */
	SelectedTotalOphthalmicAxialLengthSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/*
	 * (non-Javadoc) This method validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in SelectedTotalOphthalmicAxialLengthSequenceItem that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try{
			if(!contains(0x0022,0x1330))
				throw new MandatoryMissingException("0022,1330");
			if(!contains(0x0022,0x1019))
				throw new MandatoryMissingException("0022,1019");
			if(!contains(0x0022,0x1262))
				throw new MandatoryMissingException("0022,1262");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	/**
	 * Retrieves pre-initialized object of Ophthalmic Axial Length Quality Metric 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 objOphthalmicAxialLengthQualityMetricSequence - instance of Ophthalmic Axial Length Quality Metric Sequence. 
	 */
	public OphthalmicAxialLengthQualityMetricSequence getOphthalmicAxialLengthQualityMetricSequence()
	{
		OphthalmicAxialLengthQualityMetricSequence objOphthalmicAxialLengthQualityMetricSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0022, 0x1262);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objOphthalmicAxialLengthQualityMetricSequence = (OphthalmicAxialLengthQualityMetricSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objOphthalmicAxialLengthQualityMetricSequence = (OphthalmicAxialLengthQualityMetricSequence)objDicomV3Factory.createSequence(0x0022, 0x1262, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0022, 0x1262, objOphthalmicAxialLengthQualityMetricSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0022, 0x1262, DicomConstants.DCM_DT_SQ, objOphthalmicAxialLengthQualityMetricSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objOphthalmicAxialLengthQualityMetricSequence;
	}
	/**
	 * Retrieves pre-initialized object of Referenced Ophthalmic Axial Length Measurement QC Image 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 {@link ReferencedOphthalmicAxiaLengthMeasurementQCImageSequence}  - instance of Referenced Ophthalmic Axial Length Measurement QC Image Sequence. 
	 */
	public ReferencedOphthalmicAxiaLengthMeasurementQCImageSequence getReferencedOphthalmicAxiaLengthMeasurementQCImageSequence()
	{
		ReferencedOphthalmicAxiaLengthMeasurementQCImageSequence objReferencedOphthalmicAxiaLengthMeasurementQCImageSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0022, 0x1330);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objReferencedOphthalmicAxiaLengthMeasurementQCImageSequence = (ReferencedOphthalmicAxiaLengthMeasurementQCImageSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objReferencedOphthalmicAxiaLengthMeasurementQCImageSequence = (ReferencedOphthalmicAxiaLengthMeasurementQCImageSequence)objDicomV3Factory.createSequence(0x0022, 0x1330, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0022, 0x1330, objReferencedOphthalmicAxiaLengthMeasurementQCImageSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0022, 0x1330, DicomConstants.DCM_DT_SQ, objReferencedOphthalmicAxiaLengthMeasurementQCImageSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objReferencedOphthalmicAxiaLengthMeasurementQCImageSequence;
	}
	/**
	 * Sets the OphthalmicAxialLength
	 * The axial length measurement, in mm.
	 * The type of measurement is specified in the OphthalmicAxial Length Measurements Type (0022,1010).
	 * @param fOphthalmicAxialLength Float value of the Ratio of Ophthalmic Axial Length
	 */
	public void setOphthalmicAxialLength( float fOphthalmicAxialLength)
	{
		/*
		 * Accept the OphthalmicAxialLength in String format of type FL.
		 * 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(0x0022,0x1019, fOphthalmicAxialLength,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0022,0x1019,DicomConstants.DCM_DT_FL, fOphthalmicAxialLength);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the value of OphthalmicAxialLength.
	 * @return float - Float value of the OphthalmicAxialLength in mm.
	 */
	public float getOphthalmicAxialLength()
	{
		Object objValue = getValue(0x0022,0x1019);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

}
