/*******************************************************************************
 *  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.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
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 item class contains the methods to set, get and validate the attribute present in XA XRF Frame Characteristics Sequence Item  {@link XAXRFFrameCharacteristicsSequence }.
 *
 */

public class XAXRFFrameCharacteristicsSequenceItem extends Item
{

	

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

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	XAXRFFrameCharacteristicsSequenceItem()
	{
		super();
	}

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

	/**
	 * This constructor creates XAXRFFrameCharacteristicsSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	XAXRFFrameCharacteristicsSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	/**
	 * Sets a text description of how this frame was derived.
	 * @param strDerivationDescription user-defined comments
	 */
	public void setDerivationDescription(String strDerivationDescription)
	{
		/*Accept the Derivation Description Name in String format of type ST.
		 * 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 a text description of how this frame was derived.
	 * @return String value of Derivation Description.
	 */
	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 Derivation Code Sequence. 
	 */
	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(0x3002, 0x0050, 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;
	}
	/**
	 * Sets Acquisition Device ProcessingDescription.
	 * @param strAcquisitionDeviceProcessingDescription String value of Acquisition Device ProcessingDescription.
	 */
	public void setAcquisitionDeviceProcessingDescription(String strAcquisitionDeviceProcessingDescription)
	{
		/* Accept the Acquisition Device ProcessingDescription in String format of type LO.
		 * 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(0x0018,0x1400, strAcquisitionDeviceProcessingDescription,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1400,DicomConstants.DCM_DT_LO, strAcquisitionDeviceProcessingDescription);

		addDataElement(objIDataElement);
	}

	/**
	 * Return Acquisition Device ProcessingDescription.
	 * @return String - value of Acquisition Device ProcessingDescription.
	 */
	public String getAcquisitionDeviceProcessingDescription()
	{
		Object objValue = getValue(0x0018,0x1400);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets Acquisition Device ProcessingCode.
	 * @param strAcquisitionDeviceProcessingCode String value of Acquisition Device ProcessingCode.
	 */
	public void setAcquisitionDeviceProcessingCode(String strAcquisitionDeviceProcessingCode)
	{
		/* Accept the Acquisition Device ProcessingCode in String format of type LO.
		 * 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(0x0018,0x1401, strAcquisitionDeviceProcessingCode,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1401,DicomConstants.DCM_DT_LO, strAcquisitionDeviceProcessingCode);

		addDataElement(objIDataElement);
	}

	/**
	 * Return Acquisition Device ProcessingCode.
	 * @return String - value of Acquisition Device ProcessingCode.
	 */
	public String getAcquisitionDeviceProcessingCode()
	{
		Object objValue = getValue(0x0018,0x1401);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Validates all the attributes in XAXRFFrameCharacteristicsSequenceItem  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
		{
			//to validate Mandatory and conditional items
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
}
