/*******************************************************************************
 *  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.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.PerformedProtocolCodeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.PerformedSeriesSequence;
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.EnumModality;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.SingleCollection;

// TODO: Auto-generated Javadoc
/**
 \* This module describes the attributes in Image Acquisition Results Module.
 */
public class ImageAcquisitionResultsModule extends Module  
{

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

	/**
	 * Creates Image Acquisition Results Module with default initialization.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public ImageAcquisitionResultsModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x0060));
		objSingleCollection.add(new Tag(0x0020,0x0010));
		objSingleCollection.add(new Tag(0x0040,0x0260));
	}

	/**
	 * 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
	{
		//All Attributes are optional.
		return true;
	}
	
	/**
	 * 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;
	}

	/**
	 * Sets Type of equipment that originally acquired the data used to create the images associated with this
	 * Modality Performed Procedure Step.
	 * 
	 * @param enumModality the enum modality
	 */
	public void setModality(EnumModality enumModality)
	{
		/*Accept the Modality value 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(0x0008, 0x0060, DicomConstants.DCM_DT_CS, enumModality.getValue());
	}

	/**
	 * Retrieves Type of equipment that originally acquired the data used to create the images associated with this
	 * Modality Performed Procedure Step.
	 * 
	 * @return the modality
	 */
	public String getModality()
	{
		Object objValue = getValue(0x0008,0x0060);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets attribute identifies User or equipment generated Study Identifier.
	 * 
	 * @param strStudyID - String Study Identifier.
	 */	
	public void setStudyID(String strStudyID)
	{
		/*Accept User or equipment generated Study identifier in String format of type SH.
		 * 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
		 * 0x0008, 0x1062
		 */
		addDataElement(0x0020, 0x0010, DicomConstants.DCM_DT_SH, strStudyID);
	}

	/**
	 * Return attribute identifies User or equipment generated Study Identifier.
	 * 
	 * @return String - String Study Identifier.
	 */
	public String getStudyID()
	{
		Object objValue = getValue(0x0020,0x0010);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Retrieves pre-initialized object of Performed Protocol Code Sequence.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 PerformedProtocolCodeSequence - instance of Performed Protocol Code Sequence
	 */
	public PerformedProtocolCodeSequence getPerformedProtocolCodeSequence()
	{
		PerformedProtocolCodeSequence objPerformedProtocolCodeSequence = (PerformedProtocolCodeSequence)getDicomValue(0x0040,0x0260);
		if(objPerformedProtocolCodeSequence == 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();
			objPerformedProtocolCodeSequence = (PerformedProtocolCodeSequence)objDicomV3Factory.createSequence(0x0040,0x0260, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040,0x0260, DicomConstants.DCM_DT_SQ, objPerformedProtocolCodeSequence.getValue());
		}
		return objPerformedProtocolCodeSequence;
	}

	/**
	 * Retrieves pre-initialized object of PerformedSeriesSequence.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 PerformedSeriesSequence - instance of Performed Series Sequence
	 */
	public PerformedSeriesSequence getPerformedSeriesSequence()
	{
		PerformedSeriesSequence objPerformedSeriesSequence = (PerformedSeriesSequence)getDicomValue(0x0040,0x0340);
		if(objPerformedSeriesSequence == 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();
			objPerformedSeriesSequence = (PerformedSeriesSequence)objDicomV3Factory.createSequence(0x0040,0x0340, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040,0x0340, DicomConstants.DCM_DT_SQ, objPerformedSeriesSequence.getValue());
		}
		return objPerformedSeriesSequence;
	}
}
