/*******************************************************************************
 *  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.ReferencedSeriesSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.StudiesContainingOtherReferencedInstancesSequence;
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.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.exceptions.ValidationException;
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 class CommonInstanceReferenceModule.
 */
public class CommonInstanceReferenceModule extends Module  
{

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

	
	/**
	 * Instantiates a new common instance reference module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public CommonInstanceReferenceModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

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

	/**
	 * Retrieves pre-initialized object of ReferencedSeriesSequence.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 ReferencedSeriesSequence - instance of Referenced Series Sequence
	 */
	public ReferencedSeriesSequence getReferencedSeriesSequence()
	{
		ReferencedSeriesSequence objReferencedSeriesSequence = (ReferencedSeriesSequence)getDicomValue(0x0008,0x1115);
		if(objReferencedSeriesSequence == 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();
			objReferencedSeriesSequence = (ReferencedSeriesSequence)objDicomV3Factory.createSequence(0x0008,0x1115, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008,0x1115, DicomConstants.DCM_DT_SQ, objReferencedSeriesSequence.getValue());
		}
		return objReferencedSeriesSequence;
	}
	
	/**
	 * Retrieves pre-initialized object of StudiesContainingOtherReferencedInstancesSequence.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 StudiesContainingOtherReferencedInstancesSequence - instance of Studies Containing Other Referenced Instances Sequence
	 */
	public StudiesContainingOtherReferencedInstancesSequence getStudiesContainingOtherReferencedInstancesSequence()
	{
		StudiesContainingOtherReferencedInstancesSequence objStudiesContainingOtherReferencedInstancesSequence = (StudiesContainingOtherReferencedInstancesSequence)getDicomValue(0x0008,0x1200);
		if(objStudiesContainingOtherReferencedInstancesSequence == 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();
			objStudiesContainingOtherReferencedInstancesSequence = (StudiesContainingOtherReferencedInstancesSequence)objDicomV3Factory.createSequence(0x0008,0x1200, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008,0x1200, DicomConstants.DCM_DT_SQ, objStudiesContainingOtherReferencedInstancesSequence.getValue());
		}
		return objStudiesContainingOtherReferencedInstancesSequence;
	}


	/**
	 * 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 Boolean - status indicating success or failure
	 * 
	 * @throws InvalidModuleException the invalid module exception
	 */
	public  boolean validateModule() throws InvalidModuleException
	{
		
			try
			{			//Check for the Type 1,2 Mandatory Attributes.

				/* Condition not Clear 
			 Studies Containing Other Referenced Instances Sequence (0008,1200) 1C Sequence of items each identifying a
			 Study other than the Study of which this Instance is a part, which Studies contain	Instances that are referenced elsewhere in
			 this Instance. One or more Items shall be present. Required if this Instance references Instances in other Studies.
			 PDF 3 Page No: 743 
				 */


			}
			catch(MandatoryMissingException mme)
			{
				if(DicomConfig.createInstance().isLoggingOn())
					DicomLogger.getLogger().log(mme.getMessage());

				
throw new InvalidModuleException(this.getClass().getSimpleName(),mme);

			}
			catch(ValidationException ve)
			{
				if(DicomConfig.createInstance().isLoggingOn())
					DicomLogger.getLogger().log(ve.getMessage());

				
throw new InvalidModuleException(this.getClass().getSimpleName(),ve);

					}
		return true;
	}

	/**
	 * This method returns the vector containing the list of DataElements belonging to the Spatial
	 * Registration Series Module specified by DICOM Standard.
	 * 
	 * @return collection - custom collection containing the list of DataElements belonging to the Common Instance Reference Module
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}

