/*******************************************************************************
 *  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 Deformable Registration Sequence .
 */


public class DeformableRegistrationSequenceItem extends Item
{

	private static final long serialVersionUID = 1L;

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

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

	/*
	 * (non-Javadoc) This method validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in DeformableRegistrationSequenceItem 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(0x0064,0x0003))
				throw new MandatoryMissingException("0064,0003");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	
	/**
	 * Sets a Source Frame of Reference UID.
	 * @param strSourceFrameofReferenceUID String value of Source Frame of Reference UID.
	 */
	public void setSourceFrameofReferenceUID(String strSourceFrameofReferenceUID)
	{
		/*Accept the Source Frame of Reference UID in String format of type UI.
		 * 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(0x0064, 0x0003, strSourceFrameofReferenceUID,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0064, 0x0003,DicomConstants.DCM_DT_UI, strSourceFrameofReferenceUID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves a Source Frame of Reference UID.
	 * @return String - value of Source Frame of Reference UID.
	 */
	public String getSourceFrameofReferenceUID()
	{
		Object objValue = getValue(0x0064, 0x0003);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Retrieves pre-initialized object of Referenced 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 ReferencedImageSequence - instance of ReferencedImageSequence. 
	 */
	public ReferencedImageSequence getReferencedImageSequence()
	{
		ReferencedImageSequence objReferencedImageSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0008, 0x1140);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objReferencedImageSequence = (ReferencedImageSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objReferencedImageSequence = (ReferencedImageSequence)objDicomV3Factory.createSequence(0x0008, 0x1140, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0008, 0x1140, objReferencedImageSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0008, 0x1140, DicomConstants.DCM_DT_SQ, objReferencedImageSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objReferencedImageSequence;
	}
	
	/**
	 * Sets Frame of Reference Transformation Comment.
	 * @param strFrameofReferenceTransformationComment String value of Frame of Reference Transformation Comment.
	 */
	public void setFrameofReferenceTransformationComment(String strFrameofReferenceTransformationComment)
	{
		/* Accept the Frame of Reference Transformation Comment 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(0x3006,0x00C8, strFrameofReferenceTransformationComment,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3006,0x00C8,DicomConstants.DCM_DT_LO, strFrameofReferenceTransformationComment);

		addDataElement(objIDataElement);
	}

	/**
	 * Return Frame of Reference Transformation Comment.
	 * @return String - value of Frame of Reference Transformation Comment.
	 */
	public String getFrameofReferenceTransformationComment()
	{
		Object objValue = getValue(0x3006,0x00C8);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Retrieves pre-initialized object of Registration Type 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 RegistrationTypeCodeSequence - instance of RegistrationTypeCodeSequence. 
	 */
	public RegistrationTypeCodeSequence getRegistrationTypeCodeSequence()
	{
		RegistrationTypeCodeSequence objRegistrationTypeCodeSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0070, 0x030D); 
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objRegistrationTypeCodeSequence = (RegistrationTypeCodeSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objRegistrationTypeCodeSequence = (RegistrationTypeCodeSequence)objDicomV3Factory.createSequence(0x0070, 0x030D, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0070, 0x030D, objRegistrationTypeCodeSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0070, 0x030D, DicomConstants.DCM_DT_SQ, objRegistrationTypeCodeSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objRegistrationTypeCodeSequence;
	}
	
	/**
	 * Retrieves pre-initialized object of PreDeformation Matrix Registration 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 PreDeformationMatrixRegistrationSequence - instance of PreDeformationMatrixRegistrationSequence. 
	 */
	public PreDeformationMatrixRegistrationSequence getPreDeformationMatrixRegistrationSequence()
	{
		PreDeformationMatrixRegistrationSequence objPreDeformationMatrixRegistrationSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0064, 0x000F); 
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objPreDeformationMatrixRegistrationSequence = (PreDeformationMatrixRegistrationSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objPreDeformationMatrixRegistrationSequence = (PreDeformationMatrixRegistrationSequence)objDicomV3Factory.createSequence(0x0064, 0x000F, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0064, 0x000F, objPreDeformationMatrixRegistrationSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0064, 0x000F, DicomConstants.DCM_DT_SQ, objPreDeformationMatrixRegistrationSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objPreDeformationMatrixRegistrationSequence;
	}
	
	/**
	 * Retrieves pre-initialized object of Post Deformation Matrix Registration 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 PostDeformationMatrixRegistrationSequence - instance of PostDeformationMatrixRegistrationSequence. 
	 */
	public PostDeformationMatrixRegistrationSequence getPostDeformationMatrixRegistrationSequence()
	{
		PostDeformationMatrixRegistrationSequence objPostDeformationMatrixRegistrationSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0064, 0x0010); 
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objPostDeformationMatrixRegistrationSequence = (PostDeformationMatrixRegistrationSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objPostDeformationMatrixRegistrationSequence = (PostDeformationMatrixRegistrationSequence)objDicomV3Factory.createSequence(0x0064, 0x0010, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0064, 0x0010, objPostDeformationMatrixRegistrationSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0064, 0x0010, DicomConstants.DCM_DT_SQ, objPostDeformationMatrixRegistrationSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objPostDeformationMatrixRegistrationSequence;
	}
	
	/**
	 * Retrieves pre-initialized object of Deformable Registration Grid 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 DeformableRegistrationGridSequence - instance of DeformableRegistrationGridSequence. 
	 */
	public DeformableRegistrationGridSequence getDeformableRegistrationGridSequence()
	{
		DeformableRegistrationGridSequence objDeformableRegistrationGridSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0064, 0x0005); 
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objDeformableRegistrationGridSequence = (DeformableRegistrationGridSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objDeformableRegistrationGridSequence = (DeformableRegistrationGridSequence)objDicomV3Factory.createSequence(0x0064, 0x0005, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0064, 0x0005, objDeformableRegistrationGridSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0064, 0x0005, DicomConstants.DCM_DT_SQ, objDeformableRegistrationGridSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objDeformableRegistrationGridSequence;
	}
	
	/**
	 * Retrieves pre-initialized object of Used Fiducials 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 UsedFiducialsSequence - instance of UsedFiducialsSequence. 
	 */
	public UsedFiducialsSequence getUsedFiducialsSequence()
	{
		UsedFiducialsSequence objUsedFiducialsSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0070, 0x0314); 
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objUsedFiducialsSequence = (UsedFiducialsSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objUsedFiducialsSequence = (UsedFiducialsSequence)objDicomV3Factory.createSequence(0x0070, 0x0314, objITransferSyntax, objIDictionaryReader);

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

}
