/*******************************************************************************
 *  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.enums.EnumSpatialLocationsPreserved;
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.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 methods to validate, set and get the attributes of Source Image Sequence .
 */

public class SourceImageSequenceItem extends ImageSOPInstanceReferenceMacroDependentItem{
	

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


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

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

	/**
	 * Retrieves pre-initialized object of Purpose Of Reference 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 PurposeOfReferenceCodeSequence - instance of PurposeOfReferenceCodeSequence. 
	 */
	public PurposeOfReferenceCodeSequence getPurposeOfReferenceCodeSequence()
	{
		PurposeOfReferenceCodeSequence objPurposeOfReferenceCodeSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0040, 0xA170);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objPurposeOfReferenceCodeSequence = (PurposeOfReferenceCodeSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objPurposeOfReferenceCodeSequence = (PurposeOfReferenceCodeSequence)objDicomV3Factory.createSequence(0x0040, 0xA170, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0040, 0xA170, objPurposeOfReferenceCodeSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0040, 0xA170, DicomConstants.DCM_DT_SQ, objPurposeOfReferenceCodeSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objPurposeOfReferenceCodeSequence;
	}
	/**
	 * Sets the SpatialLocationsPreserved
	 * @param enumSpatialLocationsPreserved Enum value SpatialLocationsPreserved
	 */
	public void setSpatialLocationsPreserved(EnumSpatialLocationsPreserved enumSpatialLocationsPreserved)
	{
		/*Accept Specifies the SpatialLocationsPreserved 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(0x0028, 0x135A,enumSpatialLocationsPreserved.getValue(),objIDictionaryReader);
		}
		else
		{
			objIDataElement = new ExplicitDE(0x0028, 0x135A, DicomConstants.DCM_DT_CS,enumSpatialLocationsPreserved.getValue());
		}	
		if(objIDataElement != null)
			addDataElement(objIDataElement);
	}

	/**
	 * Retrieves SpatialLocationsPreserved
	 * @return String - returns the SpatialLocationsPreserved
	 */
	public String getSpatialLocationsPreserved()
	{
		Object objValue = getValue(0x0028, 0x135A);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets Patient Orientation
	 * @param strPatientOrientation String Value of Patient Orientation
	 */
	public void setPatientOrientation(String[] strPatientOrientation)
	{
		/*Accept the Patient Orientation 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, 0x0020, strPatientOrientation,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0020, 0x0020,DicomConstants.DCM_DT_CS, strPatientOrientation);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Patient Orientation
	 * @return String Array -  Value component of Patient Orientation
	 */
	public String[] getPatientOrientation()
	{
		if(getDataForTag(0x0020, 0x0020)!=null)
		{
			if(getDataForTag(0x0020, 0x0020).getValue()!=null)
			{
				Object objValue = getDataForTag(0x0020, 0x0020).getValue();
				if(objValue!=null)
				{
					if(objValue instanceof String)
					{
						String strTemp = (String)objValue;
						String[] strArr = new String[1];
						strArr[0] = strTemp;
						return strArr;
					}
					else
						return (String[])objValue;
				}
			}
		}
		return null;
	}

	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			if(!contains(0x0040,0xA170))
				throw new MandatoryMissingException("0040,A170") ;
			if(getDataForTag(0x0028, 0x135A).getValue().toString().equals(EnumSpatialLocationsPreserved.REORIENTED_ONLY))
				throw new ConditionFailedException("Element (0020,0020) is Required if the value of Spatial Locations Preserved (0028,135A) is REORIENTED_ONLY.") ;
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		catch(ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	
}
