/*******************************************************************************
 *  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 the methods to set,get and validate the attribute present in Derivation Image Sequence Item
 */
public class DerivationImageSequenceItem extends Item
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	DerivationImageSequenceItem()
	{
		super();
	}

	/**
	 * This constructor creates the item DerivationImageSequenceItem with default TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax  specifies the DICOM Standard defined TransfeSyntax
	 */
	DerivationImageSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates DerivationImageSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	DerivationImageSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	
	/**
	 * set the text description of how this frame data was derived.
	 * @param strDerivationDescription String value of DerivationDescription
	 */
	public void setDerivationDescription(String strDerivationDescription)
	{
		/*Accept the DerivationDescription 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(0x0008,0x2111, strDerivationDescription,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008,0x2111,DicomConstants.DCM_DT_ST, strDerivationDescription);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Volume administered during this phase in milliliters of diluted contrast agent.
	 * @return String - String value of DerivationDescription.
	 */
	public String getDerivationDescription()
	{
		Object objValue = getValue(0x0008,0x2111);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Retrieves pre-initialized object of Derivation Code 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 DerivationCodeSequence - instance of DerivationCodeSequence. 
	 */
	public DerivationCodeSequence getDerivationCodeSequence()
	{
		DerivationCodeSequence objDerivationCodeSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0008,0x9215);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objDerivationCodeSequence = (DerivationCodeSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objDerivationCodeSequence = (DerivationCodeSequence)objDicomV3Factory.createSequence(0x0008,0x9215, objITransferSyntax, objIDictionaryReader);
			
			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0008,0x9215, objDerivationCodeSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0008,0x9215, DicomConstants.DCM_DT_SQ, objDerivationCodeSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objDerivationCodeSequence;
	}
	
	/**
	 * Retrieves pre-initialized object of Source 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 SourceImageSequence - instance of SourceImageSequence. 
	 */
	public SourceImageSequence getSourceImageSequence()
	{
		SourceImageSequence objSourceImageSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0008,0x2112);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objSourceImageSequence = (SourceImageSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objSourceImageSequence = (SourceImageSequence)objDicomV3Factory.createSequence(0x0008,0x9215, objITransferSyntax, objIDictionaryReader);
			
			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0008,0x2112, objSourceImageSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0008,0x2112, DicomConstants.DCM_DT_SQ, objSourceImageSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objSourceImageSequence;
	}
	
	/**
	 * Validates all the attributes in {@link DerivationImageSequenceItem} 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(0x0008,0x9124))
				throw new MandatoryMissingException("0008,9124");
			if(!contains(0x0008,0x9215))
				throw new MandatoryMissingException("0008,9215");
			else
				getDerivationCodeSequence().validate();
			if(!contains(0x0008,0x2112))
				throw new MandatoryMissingException("0008,2112");
			else
				getSourceImageSequence().validate();
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
}
