/*******************************************************************************
 *  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.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 Frame Extraction Sequence.
 */

public class FrameExtractionSequenceItem extends Item
{

	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	FrameExtractionSequenceItem()
	{
		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
	 */
	FrameExtractionSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates FrameExtractionSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used.
	 */
	FrameExtractionSequenceItem(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 FrameExtractionSequenceItem 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,0x1167))
				throw new MandatoryMissingException("0008,1167");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	
	/**
	 * Sets a Multi-frame Source SOP Instance UID.
	 * SOP Instance from which the frames of this instance are extracted.
	 * @param strMultiframeSourceSOPInstanceUID String value of Digital Signature UID.
	 */
	public void setMultiframeSourceSOPInstanceUID(String strMultiframeSourceSOPInstanceUID)
	{
		/*Accept the Multi-frame Source SOP Instance 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(0x0008, 0x1167, strMultiframeSourceSOPInstanceUID,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008, 0x1167,DicomConstants.DCM_DT_UI, strMultiframeSourceSOPInstanceUID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves a Multi-frame Source SOP Instance UID.
	 * SOP Instance from which the frames of this instance are extracted.
	 * @return String - value of Multi-frame Source SOP Instance UID.
	 */
	public String getMultiframeSourceSOPInstanceUID()
	{
		Object objValue = getValue(0x0008, 0x1167);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Simple Frame List.
	 * A list of Frames that were extracted in the form of a simple list.
	 * @param lArrSimpleFrameList Long value of Simple Frame List
	 */
	public void setSimpleFrameList(int[] lArrSimpleFrameList)
	{
		/* Accept the Simple Frame List in long format of type UL
		 * 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,0x1161, lArrSimpleFrameList,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008,0x1161,DicomConstants.DCM_DT_UL, lArrSimpleFrameList);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Simple Frame List.
	 * A list of Frames that were extracted in the form of a simple list.
	 * @return long[] - long value of Simple Frame List.
	 */
	public int[] getSimpleFrameList()
	{
		Object objValue = getValue(0x0008,0x1161);
		if(objValue != null)
			return (int[])objValue;
		return null;
	}
	
	/**
	 * Sets Calculated Frame List.
	 * A list of Frames that were extracted in the form of one or more triplets.
	 * @param lArrCalculatedFrameList Long value of Calculated Frame List
	 */
	public void setCalculatedFrameList(int[] lArrCalculatedFrameList)
	{
		/* Accept the Calculated Frame List in long format of type UL
		 * 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,0x1162, lArrCalculatedFrameList,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008,0x1162,DicomConstants.DCM_DT_UL, lArrCalculatedFrameList);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Calculated Frame List.
	 * A list of Frames that were extracted in the form of one or more triplets.
	 * @return long[] - long value of Calculated Frame List.
	 */
	public int[] getCalculatedFrameList()
	{
		Object objValue = getValue(0x0008,0x1162);
		if(objValue != null)
			return (int[])objValue;
		return null;
	}

	/**
	 * Sets the Time Range.
	 * The start and end times of the frames that were extracted.
	 * @param dblArrTimeRange Double value of Time Range
	 */
	public void setTimeRange(double[] dblArrTimeRange)
	{
		/*Accept the Time Range in double format of type FD.
		 * 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,0x1163, dblArrTimeRange,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008,0x1163,DicomConstants.DCM_DT_FD, dblArrTimeRange);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Time Range.
	 * The start and end times of the frames that were extracted.
	 * @return double - double value of Time Range
	 */
	public double[] getTimeRange()
	{
		Object objValue = getValue(0x0008,0x1163);
		if(objValue != null)
			return (double[])objValue;
		return null;
	}
	
}
