/*******************************************************************************
 *  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.InterpretationApproverSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.InterpretationDiagnosisCodesSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ResultsDistributionListSequence;
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 approval of an interpretation.
 * 
 * 
 */
public class InterpretationApprovalModule extends Module  
{

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

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

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x4008,0x0111));
		objSingleCollection.add(new Tag(0x4008,0x0115));
		objSingleCollection.add(new Tag(0x4008,0x0117));
		objSingleCollection.add(new Tag(0x4008,0x0118));
	}

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

	/**
	 * Identifies the approvers of the interpretation. Zero or more Items may be included in this Sequence.
	 * 
	 * @return InterpretationApproverSequence - instance of InterpretationApproverSequence
	 */
	public InterpretationApproverSequence getInterpretationApproverSequence()
	{
		InterpretationApproverSequence objInterpretationApproverSequence = (InterpretationApproverSequence)getDicomValue(0x4008,0x0111);
		if(objInterpretationApproverSequence == 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();
			objInterpretationApproverSequence = (InterpretationApproverSequence)objDicomV3Factory.createSequence(0x4008,0x0111, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x4008,0x0111, DicomConstants.DCM_DT_SQ, objInterpretationApproverSequence.getValue());
		}
		return objInterpretationApproverSequence;
	}

	/**
	 * Sets Interpretation Diagnosis Description.
	 * @param strInterpretationDiagnosisDescription the str interpretation diagnosis description
	 */
	public void setInterpretationDiagnosisDescription(String strInterpretationDiagnosisDescription)
	{
		/*Accept Interpretation Diagnosis Description in String format of type LT.
		 * 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,0x0115, DicomConstants.DCM_DT_LT, strInterpretationDiagnosisDescription);
	}

	/**
	 * Return Interpretation Diagnosis Description.
	 * 
	 * @return String - String value of Interpretation Diagnosis Description.
	 */
	public String getInterpretationDiagnosisDescription()
	{Object objectValue = getValue(0x4008,0x0115);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Return a sequence that conveys the interpretation diagnosis. One or more Items may be included in
	 * this Sequence.
	 * 
	 * @return InterpretationDiagnosisCodesSequence - Instance of Interpretation Diagnosis Codes Sequence
	 */
	public InterpretationDiagnosisCodesSequence getInterpretationDiagnosisCodesSequence()
	{
		InterpretationDiagnosisCodesSequence objInterpretationDiagnosisCodesSequence = (InterpretationDiagnosisCodesSequence)getDicomValue(0x4008,0x0117);
		if(objInterpretationDiagnosisCodesSequence == 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();
			objInterpretationDiagnosisCodesSequence = (InterpretationDiagnosisCodesSequence)objDicomV3Factory.createSequence(0x4008,0x0117, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x4008,0x0117, DicomConstants.DCM_DT_SQ, objInterpretationDiagnosisCodesSequence.getValue());
		}
		return objInterpretationDiagnosisCodesSequence;
	}

	/**
	 * Return Sequence that holds Names and addresses of persons to receive a copy of the report and amendments.
	 * Zero or more Items may be included in this Sequence.
	 * 
	 * @return ResultsDistributionListSequence - Instance of Results Distribution List Sequence
	 */
	public ResultsDistributionListSequence getResultsDistributionListSequence()
	{
		ResultsDistributionListSequence objResultsDistributionListSequence = (ResultsDistributionListSequence)getDicomValue(0x4008,0x0118);
		if(objResultsDistributionListSequence == 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();
			objResultsDistributionListSequence = (ResultsDistributionListSequence)objDicomV3Factory.createSequence(0x4008,0x0118, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x4008,0x0118, DicomConstants.DCM_DT_SQ, objResultsDistributionListSequence.getValue());
		}
		return objResultsDistributionListSequence;
	}
}
