/*******************************************************************************
 *  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.ReferencedPatientSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedPerformedProcedureStepSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedResultsSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedVisitSequence;
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.exceptions.ItemLimitException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConfig;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.DicomLogger;
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 that reference SOP Instances Subordinate or Superior to this
 * SOP Class in the Naming Hierarchy.
 */
public class StudyRelationshipModule extends Module  
{


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


	/**
	 * Instantiates a new study relationship module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public StudyRelationshipModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x1125));
		objSingleCollection.add(new Tag(0x0008,0x1120));
		objSingleCollection.add(new Tag(0x0008,0x1100));
		objSingleCollection.add(new Tag(0x0008,0x1111));
		objSingleCollection.add(new Tag(0x0020,0x000D));
		objSingleCollection.add(new Tag(0x0008,0x0050));
	}

	/**
	 * validates the module according to the rules specified by the DICOM Standard.
	 * 
	 * @return boolean - returns the validation status as success or failure
	 * 
	 * @throws InvalidModuleException the invalid module exception
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{			
			int iNoOfItems = getReferencedPatientSequence().noOfItems();
			if(iNoOfItems > 1)
				throw new ItemLimitException("0008,1120 shall contain Single Item");
		}
		catch(ItemLimitException ile)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(ile.getMessage());

			
				throw new InvalidModuleException(this.getClass().getSimpleName());
		}
		return true;
	}

	/**
	 * Unique identifier for the Study.
	 * 
	 * @param strStudyInstanceUID the str study instance uid
	 */
	public void setStudyInstanceUID(String strStudyInstanceUID)
	{
		/* Accept Unique identifier for the Study in String format of type UI.
		 * 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(0x0020, 0x000D, DicomConstants.DCM_DT_UI, strStudyInstanceUID);
	}

	/**
	 * A RIS generated number that identifies the order for the Study.
	 * 
	 * @param strAccessionNumber the str accession number
	 */
	public void setAccessionNumber(String strAccessionNumber)
	{
		/*Accept departmental IS generated number in String 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,0x0050, DicomConstants.DCM_DT_SH, strAccessionNumber);
	}

	/**
	 * Returns the study instance UID.
	 * 
	 * @return String - returns the study instance UID
	 */
	public String getStudyInstanceUID()
	{
		 Object objValue = getValue(0x0020,0x000D);
   if(objValue!=null)
      return objValue.toString();
   return null;

	}

	/**
	 * Returns the Accession Number.
	 * 
	 * @return String - returns the Accession Number
	 */
	public String getAccessionNumber()
	{Object objectValue = getValue(0x0008,0x0050);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves pre-initialized object of Referenced Visit 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
	 * 
	 * @return ReferencedVisitSequence - instance of Referenced Visit Sequence.
	 */
	public ReferencedVisitSequence getReferencedVisitSequence()
	{
		ReferencedVisitSequence objReferencedVisitSequence = (ReferencedVisitSequence)getDicomValue(0x0008, 0x1125);
		if(objReferencedVisitSequence == 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();
			objReferencedVisitSequence = (ReferencedVisitSequence)objDicomV3Factory.createSequence(0x0008, 0x1125, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x1125, DicomConstants.DCM_DT_SQ, objReferencedVisitSequence.getValue());
		}
		return objReferencedVisitSequence;
	}

	/**
	 * Return instance of Referenced Patien tSequence
	 * Uniquely identifies the Patient SOP Instance that relates to the Study SOP Instance. Only a single Item
	 * shall be permitted in this Sequence.
	 * 
	 * @return Referenced Patient Sequence - returns the object of Referenced Patient 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;
	}

	/**
	 * Return instance of Referenced Results Sequence
	 * Uniquely identifies the results SOP Instance for which the interpretation SOP Instance applies. Zero
	 * or more Items may be included in this Sequence.
	 * 
	 * @return Referenced Results Sequence - returns the object of Referenced Results Sequence
	 */
	public ReferencedResultsSequence getReferencedResultsSequence()
	{
		ReferencedResultsSequence objReferencedResultsSequence = (ReferencedResultsSequence)getDicomValue(0x0008, 0x1100);
		if(objReferencedResultsSequence == 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();
			objReferencedResultsSequence = (ReferencedResultsSequence)objDicomV3Factory.createSequence(0x0008, 0x1100, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x1100, DicomConstants.DCM_DT_SQ, objReferencedResultsSequence.getValue());
		}
		return objReferencedResultsSequence;
	}

	/**
	 * Uniquely identifies the Performed Procedure Step SOP Instances to which the Study SOP Instance is
	 * related (e.g. a Modality or General-Purpose Performed Procedure Step SOP Instance or Study
	 * Component SOP Instance).
	 * 
	 * @return ReferencedPerformedProcedureStepSequence - returns the object of Referenced Performed Procedure Step Sequence
	 */
	public ReferencedPerformedProcedureStepSequence getReferencedPerformedProcedureStepSequence()
	{
		ReferencedPerformedProcedureStepSequence objReferencedPerformedProcedureStepSequence = (ReferencedPerformedProcedureStepSequence)getDicomValue(0x0008,0x1111);
		if(objReferencedPerformedProcedureStepSequence == 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();
			objReferencedPerformedProcedureStepSequence = (ReferencedPerformedProcedureStepSequence)objDicomV3Factory.createSequence(0x0008,0x1111, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008,0x1111, DicomConstants.DCM_DT_SQ, objReferencedPerformedProcedureStepSequence.getValue());
		}
		return objReferencedPerformedProcedureStepSequence;
	}

	/* 
	 * 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 collection of Tags - returns the customized collection of data element
	 * tags belonging to this module
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
