/*******************************************************************************
 *  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.PhysiciansReadingStudyIdentificationSequence;
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.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 defines the Attributes relevant to the reading of a study.
 */
public class StudyReadModule extends Module  
{

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

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

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x1060));
		objSingleCollection.add(new Tag(0x0008,0x1062));
		objSingleCollection.add(new Tag(0x0032,0x0034));
		objSingleCollection.add(new Tag(0x0032,0x0035));
	}

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

	/**
	 * Sets Name of the physician(s) reading the study.
	 * 
	 * @param arrStrNameOfPhysiciansReadingStudy String array of Name Of Physicians Reading Study
	 */
	public void setNameOfPhysiciansReadingStudy(String[] arrStrNameOfPhysiciansReadingStudy)
	{
		/*Accept Scheduled Name of Physician(s) Reading Study in String Array format of type AE.
		 * 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 Data Set
		 */
		addDataElement(0x0008, 0x1060, DicomConstants.DCM_DT_PN, arrStrNameOfPhysiciansReadingStudy);
	}

	/**
	 * Sets Date on which the study was read.
	 * 
	 * @param strStudyReadDate String value of Study Read Date.
	 */
	public void setStudyReadDate(String strStudyReadDate)
	{
		/*Accept User or equipment generated Study Read Date in String format of type DA.
		 * 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(0x0032,0x0034, DicomConstants.DCM_DT_DA, strStudyReadDate	);
	}

	/**
	 * Sets Time at which the study was read.
	 * 
	 * @param strStudyReadTime String value of Study Read Time.
	 */
	public void setStudyReadTime(String strStudyReadTime)
	{
		/*Accept User or equipment generated Study Read Time in String format of type TM.
		 * 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(0x0032,0x0035, DicomConstants.DCM_DT_TM, strStudyReadTime	);
	}

	/**
	 * Retrieves Name of the physician(s) reading the study.
	 * 
	 * @return String[] - String array of Name Of Physicians Reading Study.
	 */
	public String[] getNameOfPhysiciansReadingStudy()
	{Object objectValue = getValue(0x0008,0x1060);
		if(objectValue!=null)
			return (String[])objectValue;
		return null;
	}

	/**
	 * Retrieves Date on which the study was read.
	 * 
	 * @return String - String value of Study Read Date.
	 */
	public String getStudyReadDate()
	{Object objectValue = getValue(0x0032,0x0034);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves Time at which the study was read.
	 * 
	 * @return String - String value of Study Read Time.
	 */
	public String getStudyReadTime()
	{Object objectValue = getValue(0x0032,0x0035);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * This method provides the pre-initialized object of Physicians Reading Study Identification Sequence.
	 * 
	 * @return objPhysiciansReadingStudyIdentificationSequence - object of Physicians Reading Study 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 PhysiciansReadingStudyIdentificationSequence getPhysiciansReadingStudyIdentificationSequence()
	{
		PhysiciansReadingStudyIdentificationSequence objPhysiciansReadingStudyIdentificationSequence = (PhysiciansReadingStudyIdentificationSequence)getDicomValue(0x0008, 0x1062);
		if(objPhysiciansReadingStudyIdentificationSequence == 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();
			objPhysiciansReadingStudyIdentificationSequence = (PhysiciansReadingStudyIdentificationSequence)objDicomV3Factory.createSequence(0x0008, 0x1062, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x1062, DicomConstants.DCM_DT_SQ, objPhysiciansReadingStudyIdentificationSequence.getValue());
		}
		return objPhysiciansReadingStudyIdentificationSequence;
	}
	/* 
	 * 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;
	}
}
