/*******************************************************************************
 *  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 Hanging Protocol Definition Sequence.
 */

public class HangingProtocolDefinitionSequenceItem extends Item  
{
	
	private static final long serialVersionUID = 1L;
	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	HangingProtocolDefinitionSequenceItem()
	{
		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
	 */
	HangingProtocolDefinitionSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	/**
	 * Validates all the attributes in HangingProtocolDefinitionSequenceItem  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,0x0060))
				throw new ConditionFailedException("0008,0060");
			if(!contains(0x0008,0x2218))
				throw new ConditionFailedException("0008,2218");
			if(!contains(0x0020,0x0060))
				throw new ConditionFailedException("0020,0060");
			if(!contains(0x0008,0x1032))
				throw new MandatoryMissingException("0008,1032");
			if(!contains(0x0040,0x100A))
				throw new MandatoryMissingException("0040,100A");
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me); 
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	/**
	 * Sets the Modality.
	 * Required if Anatomic Region Sequence (0008,2218) is not present.May be present otherwise.
	 * @param strModality Specifies type of the value encoded in this Item
	 */
	public void setModality(String strModality)
	{
		/*Accept the Modality 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(0x0008,0x0060, strModality,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008,0x0060,DicomConstants.DCM_DT_CS, strModality);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves type of Modality
	 * @return String - Type of the Modality.
	 */
	public String getModality()
	{
		Object objValue = getValue(0x0008,0x0060);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Retrieves pre-initialized object of AnatomicRegionSequence.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 AnatomicRegionSequence - instance of AnatomicRegionSequence. 
	 */
	public AnatomicRegionSequence getAnatomicRegionSequence()
	{
		AnatomicRegionSequence objAnatomicRegionSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0008,0x2218);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objAnatomicRegionSequence = (AnatomicRegionSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objAnatomicRegionSequence = (AnatomicRegionSequence)objDicomV3Factory.createSequence(0x0008,0x2218, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0008,0x2218, objAnatomicRegionSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0008,0x2218, DicomConstants.DCM_DT_SQ, objAnatomicRegionSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objAnatomicRegionSequence;
	}
	/**
	 * Sets the Value of Laterality
	 * @param strLaterality Specifies type of the value encoded in this Item
	 */
	public void setLaterality(String strLaterality)
	{
		/*Accept the Laterality 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(0x0020,0x0060, strLaterality,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0020,0x0060,DicomConstants.DCM_DT_CS, strLaterality);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves type of Laterality
	 * @return String - Type of the Laterality.
	 */
	public String getLaterality()
	{
		Object objValue = getValue(0x0020,0x0060);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Retrieves pre-initialized object of Procedure 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 ProcedureCodeSequence - instance of ProcedureCodeSequence. 
	 */
	public ProcedureCodeSequence getProcedureCodeSequence()
	{
		ProcedureCodeSequence objProcedureCodeSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0008,0x1032);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objProcedureCodeSequence = (ProcedureCodeSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objProcedureCodeSequence = (ProcedureCodeSequence)objDicomV3Factory.createSequence(0x0008,0x1032, objITransferSyntax, objIDictionaryReader);

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

	/**
	 * Retrieves pre-initialized object of Reason for Requested Procedure 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 ReasonForRequestedProcedureCodeSequence - instance of ReasonForRequestedProcedureCodeSequence. 
	 */
	public ReasonForRequestedProcedureCodeSequence getReasonForRequestedProcedureCodeSequence()
	{
		ReasonForRequestedProcedureCodeSequence objReasonForRequestedProcedureCodeSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0040,0x100A);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objReasonForRequestedProcedureCodeSequence = (ReasonForRequestedProcedureCodeSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objReasonForRequestedProcedureCodeSequence = (ReasonForRequestedProcedureCodeSequence)objDicomV3Factory.createSequence(0x0040,0x100A, objITransferSyntax, objIDictionaryReader);

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


}
