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




/**
* This item class contains the methods to set,get and validate the attribute present in Referenced Reference Image Sequence.
 */
public class ReferencedReferenceImageSequenceItem extends SOPInstanceReferenceMacroDependentItem  
{
	

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

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

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

	

	/**
	 * Sets Reference Image Number. Uniquely identifies Reference Image within Referenced Reference Image Sequence (300A,0042).
	 * @param strReferenceImageNumber String value of Reference Image Number.
	 */
	public void setReferenceImageNumber (String strReferenceImageNumber )
	{
		/*Accept the Reference Image Number  in String 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(0x300A,0x00C8, strReferenceImageNumber ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x00C8,DicomConstants.DCM_DT_IS, strReferenceImageNumber );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Reference Image Number. Uniquely identifies Reference Image within Referenced Reference Image Sequence (300A,0042).
	 * @return String - value of Reference Image Number.
	 */
	public String getReferenceImageNumber()
	{
		Object objValue = getValue(0x300A,0x00C8);
		if(objValue != null)
			return objValue.toString();
		return null;
	}


	/**
	 * Sets Cumulative Meterset Weight within current Beam at which image acquisition starts.
	 * @param strStartCumulativeMetersetWeight String value of Start Cumulative Meterset Weight.
	 */
	public void setStartCumulativeMetersetWeight (String strStartCumulativeMetersetWeight )
	{
		/*Accept the Start Cumulative Meterset Weight in String format of type DS.
		 * 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(0x300C,0x0008, strStartCumulativeMetersetWeight ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300C,0x0008,DicomConstants.DCM_DT_DS, strStartCumulativeMetersetWeight );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Cumulative Meterset Weight within current Beam at which image acquisition starts.
	 * @return String - value of  Start Cumulative Meterset Weight.
	 */
	public String getStartCumulativeMetersetWeight()
	{
		Object objValue = getValue(0x300C,0x0008);
		if(objValue != null)
			return objValue.toString();
		return null;
	}


	/**
	 * Sets Cumulative Meterset Weight within current Beam at which image acquisition ends.
	 * @param strEndCumulativeMetersetWeight String value of End Cumulative Meterset Weight.
	 */
	public void setEndCumulativeMetersetWeight (String strEndCumulativeMetersetWeight )
	{
		/*Accept the End Cumulative Meterset Weight in String format of type DS.
		 * 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(0x300C,0x0009, strEndCumulativeMetersetWeight ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300C,0x0009,DicomConstants.DCM_DT_DS, strEndCumulativeMetersetWeight );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Cumulative Meterset Weight within current Beam at which image acquisition ends.
	 * @return String - value of  End Cumulative Meterset Weight.
	 */
	public String getEndCumulativeMetersetWeight()
	{
		Object objValue = getValue(0x300C,0x0009);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Validates all the attributes in ReferencedReferenceImageSequenceItem  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,0x1150)))
				throw new ConditionFailedException("0008,1150 is required if Referenced Reference Image Sequence (300C,0042) is sent");
			if((!contains(0x0008,0x1155)))
				throw new ConditionFailedException("0008,1155 is required if Referenced Reference Image Sequence (300C,0042) is sent");
			if((!contains(0x300A,0x00C8)))
				throw new ConditionFailedException("300A,00C8 is required if Referenced Reference Image Sequence (300C,0042) is sent");

		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
}
