/*******************************************************************************
 *  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.ITag;
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 Corrected Parameter Sequence .
 */

public class CorrectedParameterSequenceItem extends Item  
{

	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	CorrectedParameterSequenceItem()
	{
		super();
	}

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

	/**
	 * This constructor creates CorrectedParameterSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	CorrectedParameterSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	/*
	 * (non-Javadoc) This mathod validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in Corrected Parameter Sequence Item 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
		{
			//validation of mandatory elements
			if(!contains(0x3008,0x0061))
				throw new MandatoryMissingException("3008,0061");
			if(!contains(0x3008,0x0063))
				throw new MandatoryMissingException("3008,0063");
			if(!contains(0x3008,0x0065))
				throw new MandatoryMissingException("3008,0065");
			if(!contains(0x3008,0x006A))
				throw new MandatoryMissingException("3008,006A");
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}

	/**
	 * Sets the Data Element Tag of the parent sequence 
	 * containing the attribute that was corrected.
	 * @param objITag Tag object of Parameter Sequence Pointer.
	 */
	public void setParameterSequencePointer(ITag objITag)
	{
		/*Accept the Parameter Sequence Pointer in String format of type AT.
		 * 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(0x3008,0x0061, objITag,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0061,DicomConstants.DCM_DT_AT, objITag);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves  the Data Element Tag of the parent sequence 
	 * containing the attribute that was corrected.
	 * @return String - Tag object of Parameter Sequence Pointer.
	 */
	public ITag getParameterSequencePointer()
	{
		Object objValue = getValue(0x3008,0x0061);
		if(objValue != null)
			return (ITag)objValue;
		return null;
	}
	
	/**
	 * Sets Parameter Item Index.
	 * @param strParameterItemInde-x String value of Parameter Item Index.
	 */
	public void setParameterItemIndex(String strParameterItemIndex )
	{
		/*Accept the Parameter Item Index 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(0x3008,0x0063, strParameterItemIndex ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0063,DicomConstants.DCM_DT_IS, strParameterItemIndex );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Parameter Item Index.
	 * @return String - value of Parameter Item Index.
	 */
	public String getParameterItemIndex()
	{
		Object objValue = getValue(0x3008,0x0063);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the Data Element Tag of the attribute that was corrected.
	 * @param objITag Tag object of Parameter Pointer.
	 */
	public void setParameterPointer(ITag objITag)
	{
		/*Accept the Parameter Pointer in String format of type AT.
		 * 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(0x3008,0x0065, objITag,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0065,DicomConstants.DCM_DT_AT, objITag);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Data Element Tag of the attribute that was corrected.
	 * @return String - Tag object of Parameter Pointer.
	 */
	public ITag getParameterPointer()
	{
		Object objValue = getValue(0x3008,0x0065);
		if(objValue != null)
			return (ITag)objValue;
		return null;
	}
	
	/**
	 * Sets the Correction Value.
	 * @param fCorrectionValue Float value of the Correction Value.
	 */
	public void setCorrectionValue( float fCorrectionValue)
	{
		/*
		 * Accept the Correction Value in String format of type FL.
		 * 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(0x3008,0x006A, fCorrectionValue,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x006A,DicomConstants.DCM_DT_FL, fCorrectionValue);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Correction Value.
	 * @return float - Float value of the Correction Value.
	 */
	public float getCorrectionValue()
	{
		Object objValue = getValue(0x3008,0x006A);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
}
