/*******************************************************************************
 *  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.AnatomicRegionSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.AnatomicRegionSequenceItem;
import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.PrimaryAnatomicStructureSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IItem;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumImageLaterality;
import cdac.medinfo.sdk.dcm30_04.enums.EnumPositionerType;

import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
import cdac.medinfo.sdk.dcm30_04.exceptions.ItemLimitException;
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.ICollectionIterator;
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 a Digital Intra-oral X-Ray Image including its
 * acquisition and positioning.
 * 
 * 
 */
public class IntraOralImageModule extends Module  
{


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


	/**
	 * Instantiates a new intra oral image module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public IntraOralImageModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

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

	/**
	 * 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 - validation status as success or failure
	 * 
	 * @throws InvalidModuleException - when the module is invalid
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{			if(!isPresent(0x0018, 0x1508))
			throw new MandatoryMissingException("0018,1508");
		if(!isPresent(0x0020, 0x0062))
			throw new MandatoryMissingException("0020,0062");
		if(!isPresent(0x0008, 0x2218))
			throw new MandatoryMissingException("0008,2218");
		if( !isPresent(0x0008,0x2220) && !isPresent(0x0008,0x2228))
			throw new ConditionFailedException("0008,2228 is required if Anatomic Region Modified Sequence (0008,2220) is not sent.");

		getAnatomicRegionSequence().validateForModule();
		ICollectionIterator<IItem> objAnatomicRegionSequenceIterator = getAnatomicRegionSequence().iterator();
		AnatomicRegionSequenceItem objAnatomicRegionSequenceItem = null;
		while(objAnatomicRegionSequenceIterator.hasNext())
		{
			objAnatomicRegionSequenceItem = (AnatomicRegionSequenceItem)objAnatomicRegionSequenceIterator.next();
			if((!isPresent(0x0008,0x2228)) && (!objAnatomicRegionSequenceItem.contains(0x0008,0x2220)))
				throw new ConditionFailedException("Element 0008,2220 is required if element 0008,2228 is not present");
			if(objAnatomicRegionSequenceItem.contains(0x0008,0x2220))
			{
				int  iNoOfItems = objAnatomicRegionSequenceItem.getAnatomicRegionModifierSequence().noOfItems();
				if(iNoOfItems > 1)
					throw new ItemLimitException("Sequence 0008,2220 must have sigle Item for this Module");
			}
		}
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(cfe.getMessage());

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

		}
		catch(ItemLimitException ile)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(ile.getMessage());

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

		}
		return true;
	}

	/**
	 * Sets Positioner Type. Enumerated Values: MAMMOGRAPHIC,NONE.
	 * 
	 * @param enumPositionerType the enum positioner type
	 */
	public void setPositionerType(EnumPositionerType enumPositionerType)
	{
		/* Accept Positioner Type 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(0x0018, 0x1508, DicomConstants.DCM_DT_CS, enumPositionerType.getValue());
	}

	/**
	 * Retrieves Positioner Type.
	 * 
	 * @return String - String value of Positioner Type.
	 */
	public String getPositionerType()
	{Object objectValue = getValue(0x0018,0x1508);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * 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 - Enum value of 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());
	}

	/**
	 * Retrieves Laterality of (possibly paired) body part (as described in Anatomic Region Sequence(0008,2218)) examined.
	 * 
	 * @return String - String value of Image Laterality.
	 */
	public String getImageLaterality()
	{
		Object objectValue = getValue(0x0020, 0x0062);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves an instance of {@link AnatomicRegionSequence} which identifies the anatomic region of interest in this image.
	 * 
	 * @return AnatomicRegionSequence - instance of Anatomic Region Sequence.
	 */
	public AnatomicRegionSequence getAnatomicRegionSequence()
	{
		AnatomicRegionSequence objAnatomicRegionSequence = (AnatomicRegionSequence)getDicomValue(0x0008, 0x2218);
		if(objAnatomicRegionSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objAnatomicRegionSequence = (AnatomicRegionSequence)objDicomV3Factory.createSequence(0x0008, 0x2218, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x2218, DicomConstants.DCM_DT_SQ, objAnatomicRegionSequence.getValue());
		}
		return objAnatomicRegionSequence;
	}

	/**
	 * Retrieves an instance of {@link PrimaryAnatomicStructureSequence} which describes the primary
	 * anatomic structures of interest in this image.
	 * 
	 * @return PrimaryAnatomicStructureSequence - instance of Primary Anatomic Structure Sequence.
	 */
	public PrimaryAnatomicStructureSequence getPrimaryAnatomicStructureSequence()
	{
		PrimaryAnatomicStructureSequence objPrimaryAnatomicStructureSequence = (PrimaryAnatomicStructureSequence)getDicomValue(0x0008, 0x2228);
		if(objPrimaryAnatomicStructureSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objPrimaryAnatomicStructureSequence = (PrimaryAnatomicStructureSequence)objDicomV3Factory.createSequence(0x0008, 0x2228, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x2228, DicomConstants.DCM_DT_SQ, objPrimaryAnatomicStructureSequence.getValue());
		}
		return objPrimaryAnatomicStructureSequence;
	}

	/**
	 * Returns the custom collection containing the list of DataElements belonging to the Mammographic Series
	 * Module specified by DICOM Standard.
	 * 
	 * @return ISingleCollection<ITag> - custom collection containing the list of DataElements.
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
