/*******************************************************************************
 *  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.AdmittingDiagnosesCodeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ConsultingPhysicianIdentificationSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferringPhysicianIdentificationSequence;
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.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 admitting a patient during a visit.
*/
public class VisitAdmissionModule extends Module  
{

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

	/**
	 * Instantiates a new visit admission module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public VisitAdmissionModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x0090));
		objSingleCollection.add(new Tag(0x0008,0x0092));
		objSingleCollection.add(new Tag(0x0008,0x0094));
		objSingleCollection.add(new Tag(0x0008,0x0096));
		objSingleCollection.add(new Tag(0x0008,0x1080));
		objSingleCollection.add(new Tag(0x0008,0x1084));
		objSingleCollection.add(new Tag(0x0038,0x0016));
		objSingleCollection.add(new Tag(0x0038,0x0020));
		objSingleCollection.add(new Tag(0x0038,0x0021));
		objSingleCollection.add(new Tag(0x0008,0x009C));
		objSingleCollection.add(new Tag(0x0008,0x009D));
	}

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

	/**
	 * Sets Name of the patient's referring physician.
	 * 
	 * @param strReferringPhysicianName String value of Referring Physician Name.
	 */
	public void setReferringPhysicianName(String strReferringPhysicianName)
	{
		/*Accept Name of the patient's referring physician in String format of type PN.
		 * 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, 0x0090, DicomConstants.DCM_DT_PN, strReferringPhysicianName);
	}

	/**
	 * Stes Referring physician's address.
	 * 
	 * @param strReferringPhysicianAddress String value of Referring Physician Address.
	 */
	public void setReferringPhysicianAddress(String strReferringPhysicianAddress)
	{
		/*Accept Referring Physician's Address in String format of type ST.
		 * 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, 0x0092, DicomConstants.DCM_DT_ST, strReferringPhysicianAddress);
	}

	/**
	 * Sets Referring physician's telephone numbers.
	 * 
	 * @param arrStrReferringPhysicianTelephoneNumbers String array of Referring Physician Telephone Numbers
	 */
	public void setReferringPhysicianTelephoneNumbers(String[] arrStrReferringPhysicianTelephoneNumbers)
	{
		/*Accept Referring Physicians Telephone Numbers in String Array format of type SH.
		 * 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, 0x0094, DicomConstants.DCM_DT_SH, arrStrReferringPhysicianTelephoneNumbers);
	}
	
	/**
	 * Sets Consulting Physicians Name.
	 * 
	 * @param strArrConsultingPhysiciansName String array value of Consulting Physicians Name.
	 */
	public void setConsultingPhysiciansName(String[] strArrConsultingPhysiciansName)
	{
		/*Accept Consulting Physicians Name in String format of type PN.
		 * 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, 0x009C, DicomConstants.DCM_DT_PN, strArrConsultingPhysiciansName);
	}

	/**
	 * Sets Description of admitting diagnosis (diagnoses).
	 * 
	 * @param arrStrAdmittingDiagnosesDescription String value of Admitting Diagnoses Description.
	 */
	public void setAdmittingDiagnosesDescription(String[] arrStrAdmittingDiagnosesDescription)
	{
		/* Accept Admitting Diagnoses Description in String Array format of type CS.
		 * 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, 0x1080, DicomConstants.DCM_DT_LO, arrStrAdmittingDiagnosesDescription);
	}

	/**
	 * Sets Mode of admission: emergency, normal.
	 * 
	 * @param strRouteOfAdmissions String value of Route Of Admission.
	 */
	public void setRouteOfAdmissions(String strRouteOfAdmissions)
	{
		/*Accept Route of Admissions in String format of type ST.
		 * 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(0x0038,0x0016, DicomConstants.DCM_DT_LO, strRouteOfAdmissions);
	}

	/**
	 * Sets Date patient visit began.
	 * 
	 * @param strAdmittingDate String value of Admitting Date.
	 */
	public void setAdmittingDate(String strAdmittingDate)
	{
		/*Accept Admitting 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(0x0038,0x0020, DicomConstants.DCM_DT_DA, strAdmittingDate);
	}

	/**
	 * Sets Time patient visit began.
	 * 
	 * @param strAdmittingTime String value of Admitting Time.
	 */
	public void setAdmittingTime(String strAdmittingTime)
	{
		/*Accept Admitting 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(0x0038,0x0021, DicomConstants.DCM_DT_TM, strAdmittingTime);
	}

	/**
	 * Retrieves Patient's primary referring physician for this visit.
	 * 
	 * @return String - String value of Referring Physician Name
	 */
	public String getReferringPhysicianName()
	{Object objectValue = getValue(0x0008,0x0090);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves Referring physician's address.
	 * 
	 * @return String - String value of Referring physician's address
	 */
	public String getReferringPhysicianAddress()
	{Object objectValue = getValue(0x0008,0x0092);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves Referring physician's telephone numbers.
	 * 
	 * @return String - String value of Referring physician's telephone numbers
	 */
	public String[] getReferringPhysicianTelephoneNumbers()
	{Object objectValue = getValue(0x0008,0x0094);
		if(objectValue!=null)
			return (String[])objectValue;
		return null;
	}

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

	/**
	 * Retrieves Consulting Physicians Name.
	 * 
	 * @return String[] - String array of Consulting Physicians Name
	 */
	public String[] getConsultingPhysiciansName()
	{Object objectValue = getValue(0x0008,0x009C);
		if(objectValue!=null)
			return (String[])objectValue;
		return null;
	}
	
	/**
	 * Retrieves Description of admitting diagnosis (diagnoses).
	 * 
	 * @return String[] - String array of Admitting Diagnoses Description
	 */
	public String[] getAdmittingDiagnosesDescription()
	{Object objectValue = getValue(0x0008,0x1080);
		if(objectValue!=null)
			return (String[])objectValue;
		return null;
	}
	
	/**
	 * This method provides the pre-initialized object of Consulting Physician Identification Sequence.
	 * 
	 * @return - object of Consulting 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 ConsultingPhysicianIdentificationSequence getConsultingPhysicianIdentificationSequence()
	{
		ConsultingPhysicianIdentificationSequence objConsultingPhysicianIdentificationSequence = (ConsultingPhysicianIdentificationSequence)getDicomValue(0x0008, 0x009D);
		if(objConsultingPhysicianIdentificationSequence == 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();
			objConsultingPhysicianIdentificationSequence = (ConsultingPhysicianIdentificationSequence)objDicomV3Factory.createSequence(0x0008, 0x009D, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x009D, DicomConstants.DCM_DT_SQ, objConsultingPhysicianIdentificationSequence.getValue());
		}
		return objConsultingPhysicianIdentificationSequence;
	}

	/**
	 * This method provides the pre-initialized object of Admitting Diagnoses Code Sequence.
	 * 
	 * @return - object of Admitting Diagnoses 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 AdmittingDiagnosesCodeSequence getAdmittingDiagnosesCodeSequence()
	{
		AdmittingDiagnosesCodeSequence objAdmittingDiagnosesCodeSequence = (AdmittingDiagnosesCodeSequence)getDicomValue(0x0008, 0x1084);
		if(objAdmittingDiagnosesCodeSequence == 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();
			objAdmittingDiagnosesCodeSequence = (AdmittingDiagnosesCodeSequence)objDicomV3Factory.createSequence(0x0008, 0x1084, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x1084, DicomConstants.DCM_DT_SQ, objAdmittingDiagnosesCodeSequence.getValue());
		}
		return objAdmittingDiagnosesCodeSequence;
	}

	/**
	 * Retrieves Mode of admission: emergency, normal.
	 * 
	 * @return String - String value of Route of Admissions
	 */
	public String getRouteOfAdmissions()
	{Object objectValue = getValue(0x0038,0x0016);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves Date patient visit began.
	 * 
	 * @return String - String value of Admitting Date
	 */
	public String getAdmittingDate()
	{Object objectValue = getValue(0x0038,0x0020);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves Time patient visit began.
	 * 
	 * @return String - String value of Admitting Time
	 */
	public String getAdmittingTime()
	{Object objectValue = getValue(0x0038,0x0021);
		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;
	}
}
