/*******************************************************************************
 *  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.enums.EnumFrameType;
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 methods to set,get and validate attributes of MRImageFrameTypeSequence.
 */
public class MRImageFrameTypeSequenceItem extends Item
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	private CommonCTOrMRImageDescriptionMacro objCommonCTOrMRImageDescriptionMacro = null;
	private MRImageDescriptionMacro objMrImageDescriptionMacro = null;

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	MRImageFrameTypeSequenceItem()
	{
		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 and internal code sequence macro with default TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	MRImageFrameTypeSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	
	
	/**
	 * Retrieves the Instance of CommonCTOrMRImageDescriptionMacro
	 * @return Instance of {@link CommonCTOrMRImageDescriptionMacro}
	 */
	public CommonCTOrMRImageDescriptionMacro getCommonCTOrMRImageDescriptionMacro()
	{
		if(objCommonCTOrMRImageDescriptionMacro == null)
			objCommonCTOrMRImageDescriptionMacro = new CommonCTOrMRImageDescriptionMacro(this);
		return objCommonCTOrMRImageDescriptionMacro;
	}
	
	/**
	 * Retrieves the Instance of MRImageDescriptionMacro
	 * @return Instance of {@link MRImageDescriptionMacro}
	 */
	public MRImageDescriptionMacro getMRImageDescriptionMacro()
	{
		if(objMrImageDescriptionMacro == null)
			objMrImageDescriptionMacro = new MRImageDescriptionMacro(this);
		return objMrImageDescriptionMacro;
	}

	/**
	 * Sets Type of Frame
	 * @param enumFrameType Specifies Enum value of FrameType
	 */
	public void setFrameType(EnumFrameType.Value1 enumFrameType)
	{
		/*Accept the Type of Frame 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 Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0008,0x9007, enumFrameType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008,0x9007,DicomConstants.DCM_DT_CS, enumFrameType.getValue());

		addDataElement(objIDataElement);
	}

	/**
	 * Return Type of Frame
	 * @return String -  Specifies String value of Mask Operation
	 */
	public String getFrameType()
	{
		Object objValue = getValue(0x0008,0x9007);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/*
	 * (non-Javadoc) This mathod validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in MRImageFrameTypeSequenceItem 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
		{
			super.validateForModule();
			if(!contains(0x0008,0x9007))							// Validation condition specified for this attribute is not cleared 3rd PDF, page No 603
				throw new MandatoryMissingException("0008,9007");
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
}
