/*******************************************************************************
 *  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.ConditionFailedException;
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 specifies the attributes of the MR Image Description Macro.
 */

public class MRImageDescriptionMacro extends Macro  
{
	


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

	/*
	 * This constructor sets the DataSet as the DataHolder for this Macro.
	 * It also sets the TransferSyntax,DictionaryReader as the same as in DataSet
	 */
	/**
	 * This constructor constructs a Macro with specified DataSet.
	 * @param objDataSet Collection of DataElements 
	 */
	public MRImageDescriptionMacro(IDataSet objDataSet)
	{
		super(objDataSet);
	}

	/*
	 * This constructor sets the Dataset and the specified dictionaryReader into the Macro
	 * It also sets the transfersyntax as same as in Dataset
	 */
	/**
	 * 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 MRImageDescriptionMacro(IDataSet objDataSet,IDictionaryReader objDictionaryReader)
	{
		super(objDataSet,objDictionaryReader);
	}

	/*
	 * This constructor sets the Item as the DataHolder for this Macro.
	 * It also sets the TransferSyntax,DictionaryReader as the same as in Item
	 */
	/**
	 * This constructor constructs a Macro with the specified Item
	 * @param objItem specifies instance of Item class
	 */
	public MRImageDescriptionMacro(IItem objItem)
	{
		super(objItem);
	}

	/*
	 * This constructor sets the Item and the specified dictionaryReader into the Macro
	 * It also sets the transfersyntax as same as in Item
	 */
	/**
	 * This constructor constructs a Macro with the specified Item and DictionaryReader
	 * @param objItem specifies instance of Item class
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	public MRImageDescriptionMacro(IItem objItem,IDictionaryReader objDictionaryReader)
	{
		super(objItem, objDictionaryReader);
	}

	/**
	 * Validates all the attributes in CodeSequenceMacro
	 * @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 CodeSequenceMacro 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
		{
			if(!objIDataSet.isPresent(0x0008,0x9208))
				throw new MandatoryMissingException("0008,9208");
			if(!objIDataSet.isPresent(0x0008,0x9209))
				throw new MandatoryMissingException("0008,9209");
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidMacroException(MRImageDescriptionMacro.class.getSimpleName(),ce); 
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidMacroException(MRImageDescriptionMacro.class.getSimpleName(),me);
		}
		return true;
	}

	/**
	 * Validates all the attributes 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
		{
			if(!objIItem.contains(0x0008,0x9208))
				throw new MandatoryMissingException("0008,9208");
			if(!objIItem.contains(0x0008,0x9209))
				throw new MandatoryMissingException("0008,9209");

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

	/**
	 * Sets representation of complex data of frames in the SOP Instance.
	 * @param strComplexImageComponent String value of Complex Image Component.
	 */
	public void setComplexImageComponent(String strComplexImageComponent)
	{
		/*Accept Complex Image Component in String format of type CS.
		 * 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 Hash Map
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0008, 0x9208,strComplexImageComponent,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0008, 0x9208, DicomConstants.DCM_DT_CS,strComplexImageComponent);

		objIDataSet.addDataElement(objIDataElement);
	}

	/**
	 * Return representation of complex data of frames in the SOP Instance.
	 * @return String - value of Complex Image Component.
	 */
	public String getComplexImageComponent()
	{
		Object objValue = getValue(0x0008, 0x9208);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets indication of acquisition contrast used with frames in the SOP Instance.
	 * @param strAcquisitionContrast String value of Acquisition Contrast.
	 */
	public void setAcquisitionContrast(String strAcquisitionContrast)
	{
		/*Accept Acquisition Contrast in String format of type CS.
		 * 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 Hash Map
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0008, 0x9209,strAcquisitionContrast,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0008, 0x9209, DicomConstants.DCM_DT_CS,strAcquisitionContrast);

		objIDataSet.addDataElement(objIDataElement);
	}

	/**
	 * Return indication of acquisition contrast used with frames in the SOP Instance.
	 * @return String - value of Acquisition Contrast.
	 */
	public String getAcquisitionContrast()
	{
		Object objValue = getValue(0x0008, 0x9209);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
}
