/*******************************************************************************
 *  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.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 transcription of an interpretation recording.
 * 
 * 
 */
public class InterpretationTranscriptionModule extends Module  
{

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

	/**
	 * Instantiates a new interpretation transcription module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public InterpretationTranscriptionModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x4008,0x0108));
		objSingleCollection.add(new Tag(0x4008,0x0109));
		objSingleCollection.add(new Tag(0x4008,0x010A));
		objSingleCollection.add(new Tag(0x4008,0x010B));
		objSingleCollection.add(new Tag(0x4008,0x010C));
	}

	/* 
	 * For normalized IODs, the type(Mandatory/Optional) of a Module depends upon the
	 * Requirement Type which defines if this module is required by a SCP class or an
	 * SCP class. Hence,the validation of Modules in a Normalized IOD totally depends 
	 * upon the decision that the is it an SCU/SCP that needs the module.Also, Type of the Modules
	 * describes the type of the Attributes inside the Module. Ex: Mandatory Modules contain Attributes that are
	   included in all SOP Instances employing this IOD.
	 * Decision on implementation of this kind of validation is yet to be done. Hence,
	 * i am putting a empty validate 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 Boolean - status indicating success or failure
	 * 
	 * @throws InvalidModuleException the invalid module exception
	 */ 
	public boolean validateModule()throws InvalidModuleException
	{
		return true;
	}

	/**
	 * Sets Interpretation Transcription Date.
	 * 
	 * @param strInterpretationTranscriptionDate - Specifies Date interpretation was transcribed.
	 */
	public void setInterpretationTranscriptionDate(String strInterpretationTranscriptionDate)
	{
		/*Accept Interpretation Transcription 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(0x4008,0x0108, DicomConstants.DCM_DT_DA, strInterpretationTranscriptionDate);
	}

	/**
	 * Retrieves Date interpretation was transcribed.
	 * 
	 * @return String - String value of Interpretation Transcription Date.
	 */
	public String getInterpretationTranscriptionDate()
	{Object objectValue = getValue(0x4008,0x0108);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Sets Interpretation Transcription Time.
	 * 
	 * @param strInterpretationTranscriptionTime - String value of Interpretation Transcription Time
	 */
	public void setInterpretationTranscriptionTime(String strInterpretationTranscriptionTime)
	{
		/* Accept Interpretation Transcription 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(0x4008,0x0109, DicomConstants.DCM_DT_TM, strInterpretationTranscriptionTime);
	}

	/**
	 * Return Time interpretation was transcribed.
	 * 
	 * @return String - String value of Interpretation Transcription Time.
	 */
	public String getInterpretationTranscriptionTime()
	{Object objectValue = getValue(0x4008,0x0109);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Sets Interpretation Transcriber's Name.
	 * 
	 * @param strInterpretationTranscriber - Specifies Name of person who transcribed the interpretation.
	 */
	public void setInterpretationTranscriber(String strInterpretationTranscriber)
	{
		/*Accept Interpretation Transcriber 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(0x4008,0x010A, DicomConstants.DCM_DT_PN, strInterpretationTranscriber);
	}

	/**
	 * Return Interpretation Transcriber's Name.
	 * 
	 * @return String - String value of Interpretation Transcriber.
	 */
	public String getInterpretationTranscriber()
	{
		 Object objValue = getValue(0x4008,0x010A);
   if(objValue!=null)
      return objValue.toString();
   return null;

	}

	/**
	 * Sets Interpretation Text.
	 * 
	 * @param strInterpretationText - Specifies Text of the interpretation.
	 */
	public void setInterpretationText(String strInterpretationText)
	{
		/*Accept Interpretation Text 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(0x4008,0x010B, DicomConstants.DCM_DT_ST, strInterpretationText);
	}

	/**
	 * Retrieves Text of the interpretation.
	 * 
	 * @return String - String value of Interpretation Text.
	 */
	public String getInterpretationText()
	{
		 Object objValue = getValue(0x4008,0x010B);
   if(objValue!=null)
      return objValue.toString();
   return null;

	}

	/**
	 * Sets Interpretation Author's Name.
	 * 
	 * @param strInterpretationAuthor - Specifies Name of author of interpretation.
	 */
	public void setInterpretationAuthor(String strInterpretationAuthor)
	{
		/*Accept Interpretation Author 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(0x4008,0x010C, DicomConstants.DCM_DT_PN, strInterpretationAuthor);
	}

	/**
	 * Retrieves Interpretation Author's Name.
	 * 
	 * @return String - String value of Interpretation Author.
	 */
	public String getInterpretationAuthor()
	{
		 Object objValue = getValue(0x4008,0x010C);
   if(objValue!=null)
      return objValue.toString();
   return null;

	}

	/* 
	 * 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 this method is called.
	 */
	/**
	 * This method returns the vector of keys representing the DataElements
	 * that belong to this module.
	 * 
	 * @return collection of Tags - returns instance of ISingleCollection containing collection of Tags.
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
