/*******************************************************************************
 *  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.PerformingPhysicianIdentificationSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ProcedureCodeSequence;
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.enums.EnumStudyComponentStatusID;
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 class specifies the Study Component Acquisition Module attributes.
 */
public class StudyComponentAcquisitionModule extends Module  
{

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

	/**
	 * Instantiates a new study component acquisition module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public StudyComponentAcquisitionModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x0060));
		objSingleCollection.add(new Tag(0x0008,0x1030));
		objSingleCollection.add(new Tag(0x0008,0x1032));
		objSingleCollection.add(new Tag(0x0008,0x1050));
		objSingleCollection.add(new Tag(0x0008,0x1052));
		objSingleCollection.add(new Tag(0x0032,0x1055));
	}

	/* (non-Javadoc)
	 * @see cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module#validateModule()
	 */
	public boolean validateModule()
	{
		return true;
	}

	/**
	 * Sets Type of equipment that originally acquired the data used to create the images in this Series.
	 * 
	 * @param enumModality  Enum value of 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());
	}

	/**
	 * Sets the performing physician names.
	 * 
	 * @param arrStrPerformingPhysicianNames  Name of the physician(s) administering the
	 * Series.
	 * 
	 * 
	 * This method is used to set the Performing Physicians' Names.
	 * The function accepts a String Array Value as the Series Time and creates the
	 * DE based on the transfer syntax and populates the DE with right values.
	 * This DE is then added to the Module HashMap
	 */	
	public void setPerformingPhysicianNames(String[] arrStrPerformingPhysicianNames)
	{
		/*Accept the Performing Physician Names value in String Array format of type PN.
		 * Read the Transfer Syntax and check to create ImplicitDE or ExplicitDE .
		 * 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, 0x1050, DicomConstants.DCM_DT_PN, arrStrPerformingPhysicianNames);
	}

	/**
	 * Sets Institution-generated description or classification of the Study performed.
	 * 
	 * @param strStudyDescription String value of Study Description.
	 */
	public void setStudyDescription(String strStudyDescription)
	{
		/*Accept Institution-generated description or classification of the Study (component) performed in String format of type LO.
		 * 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, 0x1030, DicomConstants.DCM_DT_LO, strStudyDescription);
	}

	/**
	 * Identifies the state of the Study Component.
	 * Enumerated values:CREATED = Instance created but not yet complete,
	 * INCOMPLETE = Acquisition not complete, COMPLETED = Acquisition complete, VERIFIED = Acquisition complete and Quality Control review complete,
	 * POSTINTERPRET = Instance created or updated after referenced Study Instance status =COMPLETED
	 * 
	 * @param enumStudyComponentStatusID  Enum value of Study Component Status ID.
	 */
	public void setStudyComponentStatusID(EnumStudyComponentStatusID enumStudyComponentStatusID)
	{
		/*Accept the Study Component Status ID 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
		 */
		String strStudyComponentStatusID = enumStudyComponentStatusID.getValue();
		addDataElement(0x0032, 0x1055, DicomConstants.DCM_DT_CS, strStudyComponentStatusID);
	}

	/**
	 * Retrieves Type of equipment that acquired the data used to create the images in this Study Component.
	 * 
	 * @return String - String value of Modality.
	 */
	public String getModality()
	{
		Object objectValue = getValue(0x0008, 0x0060);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves Institution-generated description or classification of the Study (component) performed.
	 * 
	 * @return String - String value of Performing Physician Names.
	 */
	public String[] getPerformingPhysicianNames()
	{
		Object objectValue = getValue(0x0008, 0x1050);
		if(objectValue!=null)
			return (String[])objectValue;
		return null;
	}

	/**
	 * This method Returns provides the pre-initialized object of Performing Physician Identification Sequence.
	 * 
	 * @return objPerformingPhysicianIdentificationSequence - object of Performing Physician Identification 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
	 */
	public PerformingPhysicianIdentificationSequence getPerformingPhysicianIdentificationSequence()
	{
		PerformingPhysicianIdentificationSequence objPerformingPhysicianIdentificationSequence = (PerformingPhysicianIdentificationSequence)getDicomValue(0x0008, 0x1052);
		if(objPerformingPhysicianIdentificationSequence == 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();
			objPerformingPhysicianIdentificationSequence = (PerformingPhysicianIdentificationSequence)objDicomV3Factory.createSequence(0x0008, 0x1052, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x1052, DicomConstants.DCM_DT_SQ, objPerformingPhysicianIdentificationSequence.getValue());
		}
		return objPerformingPhysicianIdentificationSequence;
	}

	/**
	 * Retrieves Institution-generated description or classification of the Study (component) performed.
	 * 
	 * @return String - String value of Performing Physician Names.
	 */
	public String getStudyDescription()
	{
		Object objectValue = getValue(0x0008, 0x1030);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * This method Returns provides the pre-initialized object of Procedure Code Sequence.
	 * 
	 * @return objProcedureCodeSequence - object of Procedure 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
	 */
	public ProcedureCodeSequence getProcedureCodeSequence()
	{
		ProcedureCodeSequence objProcedureCodeSequence = (ProcedureCodeSequence)getDicomValue(0x0008, 0x1032);
		if(objProcedureCodeSequence == 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();
			objProcedureCodeSequence = (ProcedureCodeSequence)objDicomV3Factory.createSequence(0x0008, 0x1032, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x1032, DicomConstants.DCM_DT_SQ, objProcedureCodeSequence.getValue());
		}
		return objProcedureCodeSequence;
	}	

	/**
	 * Retrieves the state of the Study Component.
	 * 
	 * @return String - String value of Study Component Status ID.
	 */
	public String getStudyComponentStatusID()
	{
		Object objectValue = getValue(0x0008, 0x1055);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/* 
	 * I have modified the collection type from vector to custom class
	 * This method is used by the Module Iterator to iterate through the DataSet and return only
	 * those elements that belong to the respective Module class whose getVectorOfKeys is called.
	 */
	/**
	 * 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;
	}
}
