/*******************************************************************************
 *  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.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IItem;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidMacroException;
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 Macro contains attributes of Image SOP Instance Reference Macro.
 */
public class ImageSOPInstanceReferenceMacro extends Macro  
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	SOPInstanceReferenceMacro objSOPInstanceReferenceMacro = null;

	/**
	 * This constructor constructs a Macro with specified DataSet.
	 * @param objDataSet Collection of Data Elements 
	 */
	public ImageSOPInstanceReferenceMacro(IDataSet objDataSet)
	{
		super(objDataSet);
	}

	/**
	 * This constructor constructs a Macro with specified DataSet and DictionaryReader
	 * @param objDataSet specifies the DataSet
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	public ImageSOPInstanceReferenceMacro(IDataSet objDataSet,IDictionaryReader objDictionaryReader)
	{
		super(objDataSet,objDictionaryReader);
	}

	/**
	 * This constructor constructs a Macro with the specified Item
	 * @param objItem specifies instance of Item class
	 */
	public ImageSOPInstanceReferenceMacro(IItem objItem)
	{
		super(objItem);
	}

	/**
	 * This constructor constructs a Macro with the specified Item and Dictionary Reader
	 * @param objItem specifies instance of Item class
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	public ImageSOPInstanceReferenceMacro(IItem objItem,IDictionaryReader objDictionaryReader)
	{
		super(objItem, objDictionaryReader);
	}
	
	/**
	 * This method returns the SOP Instance Reference Macro with proper initialization.
	 * @return - instance of {@link SOPInstanceReferenceMacro} 
	 */
	public SOPInstanceReferenceMacro getSOPInstanceReferenceMacro()
	{
		if(objSOPInstanceReferenceMacro == null)
		{
			if(iMacroLevel == DicomConstants.DCM_MODULE_LEVEL_MACRO)
				objSOPInstanceReferenceMacro = new SOPInstanceReferenceMacro(objIDataSet);
			else 
				objSOPInstanceReferenceMacro = new SOPInstanceReferenceMacro(objIItem);

			return objSOPInstanceReferenceMacro;
		}
		return objSOPInstanceReferenceMacro;
	}

	/**
	 * Sets the frame numbers within the Referenced SOP Instance to which the reference applies
	 * @param arrstrReferencedFrameNumber String array of frame numbers
	 */
	public void setReferencedFrameNumber(String []arrstrReferencedFrameNumber)
	{
		/* Accept the Referenced Frame Number in String Array format of type IS.
		 * 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,0x1160, arrstrReferencedFrameNumber,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0008,0x1160,DicomConstants.DCM_DT_IS, arrstrReferencedFrameNumber);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves the frame numbers within the Referenced SOP Instance to which the reference applies
	 * @return String[] - String array of frame numbers
	 */
	public String[] getReferencedFrameNumber()
	{
		Object objValue = getValue(0x0008,0x1160);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}
	
	/**
	 * Sets Referenced Segment Number
	 * Identifies the Segment Number to which the reference applies.
	 * @param arrShReferencedSegmentNumber
	 */
	public void setReferencedSegmentNumber(short[] arrShReferencedSegmentNumber)
	{
		/*Accept the Referenced Segment Number in Array of short format of type US.
		 * 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(0x0062, 0x000B, arrShReferencedSegmentNumber,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0062, 0x000B,DicomConstants.DCM_DT_US, arrShReferencedSegmentNumber);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Referenced Segment Number.
	 * Identifies the Segment Number to which the reference applies.
	 * @return short Array -  Referenced Segment Number.
	 */
	public short[] getReferencedSegmentNumber()
	{
		Object objValue = getValue(0x0062, 0x000B);
		if(objValue != null)
			return (short[])objValue;
		return null;
	}


	/**
	 * Validates all the attributes in Image SOP Instance Reference Macro
	 * @return boolean - Success -true, Failure -false.
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public boolean validate() throws InvalidMacroException
	{
		if(iMacroLevel == DicomConstants.DCM_MODULE_LEVEL_MACRO)
			return validate(objIDataSet);
		else if(iMacroLevel == DicomConstants.DCM_ITEM_LEVEL_MACRO)
			return validate(objIItem);
		return false;
	}

	/**
	 * Validates all the attributes in Image SOP Instance Reference Macro that are present in the DataSet
	 * @param objIDataSet collection of DataElements
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public static boolean validate(IDataSet objIDataSet) throws InvalidMacroException
	{
		try
		{
			/*
			 * Validation Rules for Mandatory Elements
			 */
			/*
			if(!objIDataSet.isPresent(0x0008,0x1150))
				throw new MandatoryMissingException("0008,1150");
			if(!objIDataSet.isPresent(0x0008,0x1155))
				throw new MandatoryMissingException("0008,1155");
			*/

			/*
			 * Referenced Frame Number (0008,1160)
			 * Condition :- Required if the Referenced SOP Instance is a multi-frame image and the reference does not apply to all frames.
			 * please refer p.d.f chapter 3 page no 72
			 */

		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidMacroException(ImageSOPInstanceReferenceMacro.class.getSimpleName(),me);
		}
		return true;
	}

	/**
	 * Validates all the attributes in Image SOP Instance Reference Macro that are present in the DataSet
	 * @param objIItem collection of DataElements in a sequence
	 * @return boolean Success -true, Failure - false
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public static boolean validate(IItem objIItem) throws InvalidMacroException
	{
		try
		{
			/*
			 * Validation Rules for Mandatory Elements
			 */
			/*
			if(!objIItem.contains(0x0008,0x1150))
				throw new MandatoryMissingException("0008,1150");
			if(!objIItem.contains(0x0008,0x1155))
				throw new MandatoryMissingException("0008,1155");
			*/

			/*
			 * Content Sequence 0040,A730
			 * please refer p.d.f chapter 3 page no 784
			 * Required if the enclosing Content Item has relationships.
			 */
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidMacroException(ImageSOPInstanceReferenceMacro.class.getSimpleName(),me);
		}
		return true;
	}
}
