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



import cdac.medinfo.sdk.dcm30_04.baselibs.GeneralAnatomyRequiredMacro;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumImageLaterality;

import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
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;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.SingleCollection;

// TODO: Auto-generated Javadoc
/**
 \* This module contains IOD Attributes that describe the anatomy contained in a DX IOD.
 * 
 * 
 */
public class DXAnatomyImagedModule extends Module 
{


	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;

	/**
	 * The obj general anatomy required macro.
	 */
	GeneralAnatomyRequiredMacro objGeneralAnatomyRequiredMacro = null;

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0020, 0x0062));
	}

	/**
	 * Instantiates a new dX anatomy imaged module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public DXAnatomyImagedModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	/**
	 * This method validates each Attribute in the Module according to the Type
	 * of the Attribute.Attributes are of 5 types.
	 * Type 1,Type 2 are Mandatory:
	 * Mandatory Attributes have to present in the Module.
	 * Type 1C,2C are Conditional:
	 * Conditional Attributes' presence depend on a condition.
	 * If the condition is satisfied the Attribute has to be present.
	 * Type 3 are Optional
	 * Optional Attributes can be added as and when required.
	 * 
	 * @return - returns validation status as success or failure
	 * 
	 * @throws InvalidModuleException - If validation of Module fails
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{			if(!isPresent(0x0020,0x0062))
			throw new MandatoryMissingException("Missing Mandatory Element 0020,0062");

		}catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

			
				throw new InvalidModuleException(this.getClass().getSimpleName(),mme);

		}
		return true;
	}

	/**
	 * Sets Laterality of (possibly paired) body part (as described in Anatomic Region Sequence(0008,2218)) examined.
	 * Enumerated Values:
	 * R = right
	 * L = left
	 * U = unpaired
	 * B = both left and right
	 * 
	 * @param enumImageLaterality the enum image laterality
	 */
	public void setImageLaterality(EnumImageLaterality enumImageLaterality)
	{
		/*Accept Image Laterality 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
		 */
		addDataElement(0x0020, 0x0062, DicomConstants.DCM_DT_CS, enumImageLaterality.getValue());
	}

	/**
	 * Gets the image laterality.
	 * 
	 * @return the image laterality
	 */
	public String getImageLaterality()
	{
		Object objectValue = getValue(0x0020, 0x0062);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves instance of GeneralAnatomyRequiredMacro.
	 * 
	 * @return - instance of GeneralAnatomyRequiredMacro.
	 */
	public GeneralAnatomyRequiredMacro getGeneralAnatomyRequiredMacro()
	{
		if(objGeneralAnatomyRequiredMacro ==null)
		{
			objGeneralAnatomyRequiredMacro = new GeneralAnatomyRequiredMacro(objIDataSet,objIDictionaryReader);
		}
		return objGeneralAnatomyRequiredMacro;
	}

	/**
	 * This method returns the vector of keys representing the DataElements that belong to this module.
	 * 
	 * @return vector of Tags - returns the vector containing the collection of tags
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
