/*******************************************************************************
 *  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.ReferencedStudySequence;
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
/**
 * The Visit IOD is tailored by Service Class Definitions that use services which
 * facilitate the exchange of visit-related information between DICOM Application Entities.
 */
public class VisitRelationshipModule extends Module  
{


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


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

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x1110));
		objSingleCollection.add(new Tag(0x0008,0x1120));
	}

	/**
	 * validates the module according to the rules specified by 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("Visit Relationship Module",ile);
		}
		return true;
	}

	/**
	 * This method provides the pre-initialized object of Referenced Study Sequence.
	 * 
	 * @return - object of Referenced Study 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
	 * Referenced Study Sequence - returns the Referenced Study Sequence
	 */
	public ReferencedStudySequence getReferencedStudySequence()
	{
		ReferencedStudySequence objReferencedStudySequence = (ReferencedStudySequence)getDicomValue(0x0008, 0x1110);
		if(objReferencedStudySequence == 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();
			objReferencedStudySequence = (ReferencedStudySequence)objDicomV3Factory.createSequence(0x0008, 0x1110, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x1110, DicomConstants.DCM_DT_SQ, objReferencedStudySequence.getValue());
		}
		return objReferencedStudySequence;
	}

	/**
	 * This method provides the pre-initialized object of Referenced Patient Sequence.
	 * 
	 * @return - object of Referenced Patient 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
	 * Referenced Patient Sequence - returns the 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;
	}

	/* 
	 * 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 collectionf containing
	 * data element tags belonging to this module
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
