/*******************************************************************************
 *  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.enums.EnumROIPhysicalProperty;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
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 in {@link ROIPhysicalPropertiesSequence}.
 */

public class ROIPhysicalPropertiesSequenceItem extends Item  
{
	


	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	ROIPhysicalPropertiesSequenceItem()
	{
		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 and internal code sequence macro with default TransferSyntax 
	 * and default DictionaryReader.
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 */
	ROIPhysicalPropertiesSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	/**
	 * Validates all the attributes in {@link ROIPhysicalPropertiesSequenceItem} 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(0x3006,0x00B2))
				throw new MandatoryMissingException("3006,00B2");
			if(!contains(0x3006,0x00B4))
				throw new MandatoryMissingException("3006,00B4");
			if(contains(0x3006,0x00B2) && getDataForTag(0x3006,0x00B2).getValue().toString().equals(EnumROIPhysicalProperty.ELEMENTAL_COMPOSITION_OF_THE_MATERIAL))
				if(!contains(0x3006,0x00B6))
					throw new ConditionFailedException("3006,00B6");

		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		catch(ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}

	/**
	 * Sets value that uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).
	 * @param enumROIPhysicalProperty Enum value of ROI Physical Property.
	 */
	public void setROIPhysicalProperty(EnumROIPhysicalProperty enumROIPhysicalProperty)
	{
		/*Accept the ROI Physical Property 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 Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x3006,0x00B2, enumROIPhysicalProperty.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3006,0x00B2,DicomConstants.DCM_DT_CS, enumROIPhysicalProperty.getValue());

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves  value that uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).
	 * @return String - value of ROI Physical Property.
	 */
	public String getROIPhysicalProperty()
	{
		Object objValue = getValue(0x3006,0x00B2);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Retrieves pre-initialized object of ROI Elemental Composition 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 ROIElementalCompositionSequence - instance of ROI Elemental Composition Sequence. 
	 */
	public ROIElementalCompositionSequence getROIElementalCompositionSequence()
	{
		ROIElementalCompositionSequence objROIElementalCompositionSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x3006,0x00B6);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objROIElementalCompositionSequence = (ROIElementalCompositionSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objROIElementalCompositionSequence = (ROIElementalCompositionSequence)objDicomV3Factory.createSequence(0x3006,0x00B6, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x3006,0x00B6, objROIElementalCompositionSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x3006,0x00B6, DicomConstants.DCM_DT_SQ, objROIElementalCompositionSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objROIElementalCompositionSequence;
	}
	
	/**
	 * Sets user-assigned value for physical property.
	 * @param strROIPhysicalPropertyValue String value of ROI Physical Property Value.
	 */
	public void setROIPhysicalPropertyValue(String strROIPhysicalPropertyValue)
	{
		/*Accept the ROI Physical Property Value 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(0x3006,0x00B4, strROIPhysicalPropertyValue,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3006,0x00B4,DicomConstants.DCM_DT_DS, strROIPhysicalPropertyValue);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves user-assigned value for physical property.
	 * @return String - value of ROI Physical Property Value.
	 */
	public String getROIPhysicalPropertyValue()
	{
		Object objValue = getValue(0x3006,0x00B4);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
}
