/*******************************************************************************
 *  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 Event Timer Sequence.
 */

public class EventTimerSequenceItem extends CodeSequenceMacroDependentItem
{


	private static final long serialVersionUID = 1L;

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

	/**
	 * This constructor creates EventTimerSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used.
	 */
	EventTimerSequenceItem(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 EventTimerSequenceItem 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,0x2134))
				throw new MandatoryMissingException("0008,2134");
			if(!contains(0x0008,0x2135))
				throw new MandatoryMissingException("0008,2135");
			if(contains(0x0008,0x2135))
				getEventCodeSequence().validateForModule();
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	
	/**
	 * Sets the Event Time Offset.
	 * Signed value of the time between Acquisition DateTime(0008,002A) and the event, in milliseconds.
	 * @param dblEventTimeOffset Double value of Event Time Offset
	 */
	public void setEventTimeOffset(double dblEventTimeOffset)
	{
		/*Accept the Event Time Offset 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,0x2134, dblEventTimeOffset,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008,0x2134,DicomConstants.DCM_DT_FD, dblEventTimeOffset);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Event Time Offset.
	 * Signed value of the time between Acquisition DateTime(0008,002A) and the event, in milliseconds.
	 * @return double - double value of Event Time Offset
	 */
	public double getEventTimeOffset()
	{
		Object objValue = getValue(0x0008,0x2134);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Retrieves pre-initialized object of Event 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 EventCodeSequence - instance of EventCodeSequence. 
	 */
	public EventCodeSequence getEventCodeSequence()
	{
		EventCodeSequence objEventCodeSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0008, 0x2135);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objEventCodeSequence = (EventCodeSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objEventCodeSequence = (EventCodeSequence)objDicomV3Factory.createSequence(0x0008, 0x2135, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0008, 0x2135, objEventCodeSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0008, 0x2135, DicomConstants.DCM_DT_SQ, objEventCodeSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objEventCodeSequence;
	}
	
	/**
	 * Sets Event Timer Name(s).
	 * Name that identifies the event timer.
	 * @param strArrEventTimerNames String value of Event Timer Name(s).
	 */
	public void setEventTimerNames(String[] strArrEventTimerNames)
	{
		/* Accept the Event Timer Name(s) 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(0x0008,0x2132, strArrEventTimerNames,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008,0x2132,DicomConstants.DCM_DT_LO, strArrEventTimerNames);

		addDataElement(objIDataElement);
	}

	/**
	 * Return Event Timer Name(s).
	 * Name that identifies the event timer.
	 * @return String - value of Event Timer Name(s).
	 */
	public String[] getEventTimerNames()
	{
		Object objValue = getValue(0x0008,0x2132);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}
}
