/*******************************************************************************
 *  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.IItem;
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;

import cdac.medinfo.sdk.dcm30_04.utils.ICollectionIterator;


/**
 * A sequence of one or more items, each of which is a fiducial set.
 */
public class FiducialSetSequenceItem extends Item  
{
	

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

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	FiducialSetSequenceItem()
	{
		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
	 */
	FiducialSetSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	/**
	 * Validates all the attributes in Fiducial Set Sequence Item  that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			//validation of mandatory elements
			if(!contains(0x0070,0x031E))
				throw new MandatoryMissingException("0070,031E");

			//validation of conditional elements
			if((!contains(0x0008,0x1140)) && (!contains(0x0020,0x0052)))
				throw new ConditionFailedException("Element 0020,0052 is required if Identifier 0008,1140 is absent");
			if((!contains(0x0020,0x0052)) && (!contains(0x0008,0x1140)))
				throw new ConditionFailedException("Element 0008,1140 is required if Identifier 0020,0052 is absent");

			ICollectionIterator<IItem> objFiducialSequenceIterator = getFiducialSequence().iterator();
			FiducialSequenceItem objFiducialSequenceItem = null;
			if(contains(0x0020,0x0052))
			{
				while(objFiducialSequenceIterator.hasNext())
				{
					objFiducialSequenceItem = (FiducialSequenceItem)objFiducialSequenceIterator.next();
					if(!objFiducialSequenceItem.contains(0x3006,0x0050))
						throw new ConditionFailedException("Element 3006,0050 is required in FiducialSequenceItem if element 0020,0052 is present in Fiducial Set Sequence Item");
				}
			}
		}
		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 a Frame of Reference that may or may not be an image set
	 * @param strFrameofReferenceUID String value of Frame of Reference
	 */
	public void setFrameofReferenceUID(String strFrameofReferenceUID)
	{
		/*Accept the 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(0x0020,0x0052, strFrameofReferenceUID,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0020,0x0052,DicomConstants.DCM_DT_UI, strFrameofReferenceUID);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves a Frame of Reference that may or may not be an image set
	 * @return String - value of Frame of Reference
	 */
	public String getFrameofReferenceUID()
	{
		Object objValue = getValue(0x0020,0x0052);
		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 Referenced Image Sequence. 
	 */
	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;
	}

	/**
	 * Retrieves pre-initialized object of FiducialSequence.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 FiducialSequence - instance of Fiducial Sequence. 
	 */
	public FiducialSequence getFiducialSequence()
	{
		FiducialSequence objFiducialSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0070,0x031E);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objFiducialSequence = (FiducialSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objFiducialSequence = (FiducialSequence)objDicomV3Factory.createSequence(0x0070,0x031E, objITransferSyntax, objIDictionaryReader);

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