/*******************************************************************************
 *  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.IssuerofPatientIDMacro;
import cdac.medinfo.sdk.dcm30_04.baselibs.IssuerofServiceEpisodeIDSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedPatientSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ScheduledStepAttributesSequence;
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 Performed Procedure Step Relationship Module.
 */
public class PerformedProcedureStepRelationshipModule extends Module  
{

 
 /**
  * The obj single collection.
  */
 public static ISingleCollection<ITag> objSingleCollection = null;
 
 	/**
	 * The obj Issuer of Patient ID Macro.
	 */
 	IssuerofPatientIDMacro objIssuerofPatientIDMacro = null;
	 

	/**
	 * Creates Performed Procedure Step Relationship Module with default initialization.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public PerformedProcedureStepRelationshipModule(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(0x0008,0x1120));
		objSingleCollection.add(new Tag(0x0038,0x0060));
		objSingleCollection.add(new Tag(0x0038,0x0064));
		objSingleCollection.add(new Tag(0x0038,0x0062));
		objSingleCollection.add(new Tag(0x0040,0x0270));
	}

	/**
	 * 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;
	}

	/**
	 * Get the Instance of Issuer of Patient ID Macro.Attributes related to Issuer of Patient ID Macro will be set in Macro
	 * using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco
	 * Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was
	 * set in the last call to its setter method.
	 * 
	 * @return - object of Issuer of Patient ID Macro
	 */
	public IssuerofPatientIDMacro getIssuerofPatientIDMacro()
	{
		if(objIssuerofPatientIDMacro == null)
			objIssuerofPatientIDMacro = new IssuerofPatientIDMacro(objIDataSet);
		return objIssuerofPatientIDMacro; 
	}

	
	/**
	 * 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 ReferencedPatientSequence.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 ReferencedPatientSequence - instance of Referenced Reference Image Sequence.
	 */
	public ReferencedPatientSequence getReferencedPatientSequence()
	{
		ReferencedPatientSequence objReferencedPatientSequence = (ReferencedPatientSequence)getDicomValue(0x0008, 0x1120);
		if(objReferencedPatientSequence == 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();
			objReferencedPatientSequence = (ReferencedPatientSequence)objDicomV3Factory.createSequence(0x0008, 0x1120, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x1120, DicomConstants.DCM_DT_SQ, objReferencedPatientSequence.getValue());
		}
		return objReferencedPatientSequence;
	}
	
	/**
	 * Sets Identifier of the Service Episode as assigned by the healthcare provider.
	 * 
	 * @param strServiceEpisodeID String value of Service Episode ID
	 */
	public void setServiceEpisodeID(String strServiceEpisodeID)
	{
		/*Accept name of Service Episode ID 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(0x0038, 0x0060, DicomConstants.DCM_DT_LO, strServiceEpisodeID);
	}

	/**
	 * Retrieves Service Episode ID.
	 * 
	 * @return String - String value of Service Episode ID
	 */
	public String getServiceEpisodeID()
	{
		Object objectValue = getValue(0x0038, 0x0060);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}
	
	/**
	 * This method provides the pre-initialized object of Issuer of Service Episode ID Sequence.
	 * 
	 * @return - object of Issuer of Service Episode ID 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 IssuerofServiceEpisodeIDSequence getIssuerofServiceEpisodeIDSequence()
	{
		IssuerofServiceEpisodeIDSequence objIssuerofServiceEpisodeIDSequence = (IssuerofServiceEpisodeIDSequence)getDicomValue(0x0038, 0x0064);
		if(objIssuerofServiceEpisodeIDSequence == 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();
			objIssuerofServiceEpisodeIDSequence = (IssuerofServiceEpisodeIDSequence)objDicomV3Factory.createSequence(0x0038, 0x0064, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0038, 0x0064, DicomConstants.DCM_DT_SQ, objIssuerofServiceEpisodeIDSequence.getValue());
		}
		return objIssuerofServiceEpisodeIDSequence;
	}

	/**
	 * Sets Description of the type of service episode.
	 * 
	 * @param strServiceEpisodeDescription String value of Service Episode Description
	 */
	public void setServiceEpisodeDescription(String strServiceEpisodeDescription)
	{
		/*Accept Service Episode Description 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(0x0038, 0x0062, DicomConstants.DCM_DT_LO, strServiceEpisodeDescription);
	}
	
	/**
	 * Retrieves Service Episode Description.
	 * 
	 * @return String - String value of Service Episode Description
	 */
	public String getServiceEpisodeDescription()
	{
		Object objectValue = getValue(0x0038, 0x0062);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}
	
	/**
	 * Retrieves pre-initialized object of ScheduledStepAttributesSequence.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 ScheduledStepAttributesSequence - instance of Referenced Reference Image Sequence.
	 */
	public ScheduledStepAttributesSequence getScheduledStepAttributesSequence()
	{	
		ScheduledStepAttributesSequence objScheduledStepAttributesSequence = (ScheduledStepAttributesSequence)getDicomValue(0x0040,0x0270);
		if(objScheduledStepAttributesSequence == 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();
			objScheduledStepAttributesSequence = (ScheduledStepAttributesSequence)objDicomV3Factory.createSequence(0x0040,0x0270, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040,0x0270, DicomConstants.DCM_DT_SQ, objScheduledStepAttributesSequence.getValue());
		}
		return objScheduledStepAttributesSequence;
	}
}
