/*******************************************************************************
 *  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.utils.DicomConfig;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.DicomLogger;


/**
 * This class describes the attributes used to relate and convey a numeric value to a coded concept.
 */
public class NumericValueMacro extends Macro
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	CodeSequenceMacro objCodeSequenceMacro = null;

	/**
	 * This constructor constructs a Macro with specified DataSet.
	 * @param objDataSet Collection of DataElements 
	 */
	public NumericValueMacro(IDataSet objDataSet)
	{
		super(objDataSet);
	}

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

	/**
	 * This constructor constructs a Macro with the specified Item
	 * @param objItem specifies instance of Item class
	 */
	public NumericValueMacro(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 NumericValueMacro(IItem objItem,IDictionaryReader objDictionaryReader)
	{
		super(objItem, objDictionaryReader);
	}
	/**
	 * Retrieves pre-initialized object of Concept Name Code Sequence
	 * @return ConceptNameCodeSequence - instance of ConceptNameCodeSequence. 
	 */
	public ConceptNameCodeSequence getConceptNameCodeSequence()
	{
		ConceptNameCodeSequence objConceptNameCodeSequence = null;
		IDataElement objIDataElement =  getDataElement(0x0040, 0xA043); //getDataElement
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objConceptNameCodeSequence = (ConceptNameCodeSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objConceptNameCodeSequence = (ConceptNameCodeSequence)objDicomV3Factory.createSequence(0x3002, 0x0050, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0040, 0xA043, objConceptNameCodeSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0040, 0xA043, DicomConstants.DCM_DT_SQ, objConceptNameCodeSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objConceptNameCodeSequence;
	}

	/**
	 * Sets Numeric value for this name-value Item.
	 * @param strNumericValue String value of Numeric value for this name-value Item.
	 */
	public void setNumericValue(String[] strNumericValue)
	{
		/*Accept the NumericValue in String format of type DS.
		 * 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(0x0040,0xA30A, strNumericValue,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0040,0xA30A,DicomConstants.DCM_DT_DS, strNumericValue);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Numeric value for this name-value Item.
	 * @return String - value ofNumeric value for this name-value Item.
	 */
	public String[] getNumericValue()
	{
		Object objValue = getValue(0x0040,0xA30A);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}
	/**
	 * Retrieves pre-initialized object of Measurement Units Code Sequence
	 * @return MeasurementUnitsCodeSequence - instance of MeasurementUnitsCodeSequence. 
	 */
	public MeasurementUnitsCodeSequence getMeasurementUnitsCodeSequence()
	{
		MeasurementUnitsCodeSequence objMeasurementUnitsCodeSequence = null;
		IDataElement objIDataElement =  getDataElement(0x0040, 0x08EA); 
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objMeasurementUnitsCodeSequence = (MeasurementUnitsCodeSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objMeasurementUnitsCodeSequence = (MeasurementUnitsCodeSequence)objDicomV3Factory.createSequence(0x3002, 0x0050, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0040, 0x08EA, objMeasurementUnitsCodeSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0040, 0x08EA, DicomConstants.DCM_DT_SQ, objMeasurementUnitsCodeSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objMeasurementUnitsCodeSequence;
	}
	/**
	 * Validates all the attributes in NumericValueMacro
	 * @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);
		else if(iMacroLevel == DicomConstants.DCM_ITEM_LEVEL_MACRO)
			return validate(objIItem);
		return false;
	}

	/**
	 * Validates all the attributes in NumericValueMacro that are present in the DataSet
	 * @param objIItem collection of DataElements in a sequence
	 * @return int - Success -true, Failure - false
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public boolean validate(IItem objIItem) throws InvalidMacroException
	{
		try
		{
			if(!objIItem.contains(0x0040, 0xA043))
				throw new MandatoryMissingException("0040,A043");

			if(!objIItem.contains(0x0040, 0xA30A))
				throw new MandatoryMissingException("0040,A30A");

			if(!objIItem.contains(0x0040, 0x08EA))
				throw new MandatoryMissingException("0040,08EA");
			}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidMacroException(this.getClass().getSimpleName(),me);
		}
		catch( ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(cfe.getMessage());
			}
			throw new InvalidMacroException(this.getClass().getSimpleName(),cfe);
		}
		return true;
	}

	/**
	 * Validates all the attributes in NumericValueMacro that are present in the DataSet
	 * @param objIDataSet collection of DataElements
	 * @return int - 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(0x0040, 0xA043))
				throw new MandatoryMissingException("0040,A043");
			if(!objIDataSet.isPresent(0x0040, 0xA30A))
				throw new MandatoryMissingException("0040,A30A");
			if(!objIDataSet.isPresent(0x0040, 0x08EA))
				throw new MandatoryMissingException("0040,08EA");
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidMacroException("Person Identification Macro",me);
		}
		catch( ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(cfe.getMessage());
			}
			throw new InvalidMacroException("Person Identification Macro",cfe);
		}
		return true;
	}
}
