/*******************************************************************************
 *  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.ReferencedGeneralPurposeScheduledProcedureStepSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedRequestSequence;
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.EnumPatientsSex;
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 General Purpose Performed Procedure Step Relationship Module.
 */
public class GeneralPurposePerformedProcedureStepRelationshipModule extends Module  
{

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

	/**
	 * Creates Annotation List Module with default initialization.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public GeneralPurposePerformedProcedureStepRelationshipModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0010,0x0010));
		objSingleCollection.add(new Tag(0x0010,0x0020));
		objSingleCollection.add(new Tag(0x0010,0x0021));
		objSingleCollection.add(new Tag(0x0010,0x0030));
		objSingleCollection.add(new Tag(0x0010,0x0040));
		objSingleCollection.add(new Tag(0x0040,0xA370));
		objSingleCollection.add(new Tag(0x0040,0x4016));
	}

	/**
	 * 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 attribute identifies Patient's full legal name.
	 * 
	 * @param strPatientsName - String identifies Patient's full legal name.
	 */	
	public void setPatientsName(String strPatientsName)
	{
		/*Accept Image identification characteristics 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 Hash Map
		 */
		addDataElement(0x0010,0x0010, DicomConstants.DCM_DT_PN, strPatientsName);
	}

	/**
	 * Return Patient's full legal name.
	 * 
	 * @return String - String identifies Patient's full legal name.
	 */
	public String getPatientsName()
	{
		Object objValue = getValue(0x0010,0x0010);
		if(objValue != null)
			return objValue.toString();
		return null;
	}



	/**
	 * Sets attribute identifies Primary hospital identification number or code for the
	 * patient.
	 * 
	 * @param StrPatientID - String identifies Primary hospital identification number
	 */	
	public void setPatientID(String strPatientID)
	{
		/*Accept Image identification characteristics 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 Hash Map
		 */
		addDataElement(0x0010,0x0020, DicomConstants.DCM_DT_LO, strPatientID);
	}

	/**
	 * Return identifies Primary hospital identification number or code for the
	 * patient.
	 * 
	 * @return String - String identifies Primary hospital identification number
	 */
	public String getPatientID()
	{
		Object objValue = getValue(0x0010,0x0020);
		if(objValue != null)
			return objValue.toString();
		return null;
	}


	/**
	 * Sets attribute identifies Assigning Authority that issued the Patient ID.
	 * 
	 * @param strIssuerOfPatientID - String Patient ID.
	 */	
	public void setIssuerofPatientID(String strIssuerOfPatientID)
	{
		/*Accept Image identification characteristics 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 Hash Map
		 */
		addDataElement(0x0010,0x0021, DicomConstants.DCM_DT_LO, strIssuerOfPatientID);
	}

	/**
	 * Return attribute identifies Assigning Authority that issued the Patient ID.
	 * 
	 * @return String - String Patient ID.
	 */
	public String getIssuerofPatientID()
	{
		Object objValue = getValue(0x0010,0x0021);
		if(objValue != null)
			return objValue.toString();
		return null;
	}


	/**
	 * Sets attribute identifies Date of birth of the named patient.
	 * 
	 * @param StrPatientsBirthDate - String Date of birth
	 */	
	public void setPatientsBirthDate(String StrPatientsBirthDate)
	{
		/*Accept Image identification characteristics 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 Hash Map
		 */
		addDataElement(0x0010,0x0030, DicomConstants.DCM_DT_DA, StrPatientsBirthDate);
	}

	/**
	 * Return Date of birth of the named patient.
	 * 
	 * @return String - String identifies Date of birth
	 */
	public String getPatientsBirthDate()
	{
		Object objValue = getValue(0x0010,0x0030);
		if(objValue != null)
			return objValue.toString();
		return null;
	}


	/**
	 * Sets attribute identifies sex of Patient.
	 * 
	 * @param enumPatientsSex - Enum value sex of Patient
	 */
	public void setPatientsSex(EnumPatientsSex enumPatientsSex)
	{
		/* Accept Structure Set Label in String format of type US.
		 * 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 Data Set
		 */
		addDataElement(0x0010,0x0040, DicomConstants.DCM_DT_CS, enumPatientsSex.getValue());
	}

	/**
	 * Retrieves sex of Patient.
	 * 
	 * @return the patients sex
	 */
	public String getPatientsSex()
	{
		Object objValue = getValue(0x0010,0x0040);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

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


	/**
	 * Retrieves pre-initialized object of ReferencedGeneralPurposeScheduledProcedureStepSequence.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 ReferencedGeneralPurposeScheduledProcedureStepSequence - instance of Referenced General Purpose Scheduled Procedure Step Sequence
	 */
	public ReferencedGeneralPurposeScheduledProcedureStepSequence getReferencedGeneralPurposeScheduledProcedureStepSequence()
	{
		ReferencedGeneralPurposeScheduledProcedureStepSequence objReferencedGeneralPurposeScheduledProcedureStepSequence = (ReferencedGeneralPurposeScheduledProcedureStepSequence)getDicomValue(0x0040,0x4016);
		if(objReferencedGeneralPurposeScheduledProcedureStepSequence == 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();
			objReferencedGeneralPurposeScheduledProcedureStepSequence = (ReferencedGeneralPurposeScheduledProcedureStepSequence)objDicomV3Factory.createSequence(0x0040,0x4016, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040,0x4016, DicomConstants.DCM_DT_SQ, objReferencedGeneralPurposeScheduledProcedureStepSequence.getValue());
		}
		return objReferencedGeneralPurposeScheduledProcedureStepSequence;
	}
}
