/*******************************************************************************
 *  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.enums.EnumExclusiveComponentType;
import cdac.medinfo.sdk.dcm30_04.enums.EnumMandatoryComponentType;
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 Component Types Sequence .
 */

public class ComponentTypesSequenceItem extends Item  
{

	private static final long serialVersionUID = 1L;

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

	/**
	 * This constructor creates ComponentTypesSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	ComponentTypesSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	/**
	 * Validates all the attributes in ComponentTypesSequenceItem 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(0x0076,0x0034))
				throw new MandatoryMissingException("0076,0034");
			if(!contains(0x0076,0x0036))
				throw new MandatoryMissingException("0076,0036");
			if(!contains(0x0076,0x0038))
				throw new MandatoryMissingException("0076,0038");
			if(!contains(0x0076,0x0040))
				throw new MandatoryMissingException("0076,0040");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	/**
	 * Sets the Value Component Type Code Sequence
	 * @param strComponentTypeCodeSequence -Specifies type of the value ComponentTypeCodeSequence
	 */
	public void setComponentTypeCodeSequence(String strComponentTypeCodeSequence)
	{
		/*Accept the ComponentTypeCodeSequence 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(0x0076,0x0034, strComponentTypeCodeSequence,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0076,0x0034,DicomConstants.DCM_DT_CS, strComponentTypeCodeSequence);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves type of the value of Component Type Code Sequence
	 * @return String - Type of the value ComponentTypeCodeSequence.
	 */
	public String getComponentTypeCodeSequence()
	{
		Object objValue = getValue(0x0076,0x0034);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets type of Exclusive Component Type
	 * Indicates that only one component of this Component Typeshall be used in an assembly..
	 * Defined Terms:
	 * 1) YES.
	 * 2) NO.
	 * @param enumExclusiveComponentType enum value of Exclusive Component Type.
	 */
	public void setExclusiveComponentType(EnumExclusiveComponentType enumExclusiveComponentType)
	{
		/* Accept the ExclusiveComponentType 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(0x0076,0x0036, enumExclusiveComponentType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0076,0x0036,DicomConstants.DCM_DT_CS, enumExclusiveComponentType.getValue());

		addDataElement(objIDataElement);
	}
	public String getExclusiveComponentType()
	{
		Object objValue = getValue(0x0076,0x0036);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	

	/**
	 * Sets type of MandatoryComponentType.
	 *Defined Terms:
	 * 1) YES.
	 * 2) NO.
	 * @param enumMandatoryComponentType enum value of Mandatory Component Type.
	 */
	public void setMandatoryComponentType(EnumMandatoryComponentType enumMandatoryComponentType)
	{
		/* Accept the MandatoryComponentType 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(0x0076,0x0038, enumMandatoryComponentType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0076,0x0038,DicomConstants.DCM_DT_CS, enumMandatoryComponentType.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of MandatoryComponentType. 
	 * @return String - value of Mandatory Component Type.
	 */
	public String getMandatoryComponentType()
	{
		Object objValue = getValue(0x0076,0x0038);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Retrieves pre-initialized object of ComponentSequence.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 ComponentSequence - instance of ComponentSequence. 
	 */
	public ComponentSequence getComponentSequence()
	{
		ComponentSequence objComponentSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0076,0x0040);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objComponentSequence = (ComponentSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objComponentSequence = (ComponentSequence)objDicomV3Factory.createSequence(0x0076,0x0040, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0076,0x0040, objComponentSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0076,0x0040, DicomConstants.DCM_DT_SQ, objComponentSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objComponentSequence;
	}

}

