/*******************************************************************************
 *  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.NonDICOMOutputCodeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.OutputInformationSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.RequestedSubsequentWorkitemCodeSequence;
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
/**
 * General Purpose Results Module specifies attributes that describe the creation of results during
 * the performance of the General Purpose Procedure Step and that provide references to the Results
 * and Structured Reporting SOP Instances associated with this General Purpose Performed Procedure Step.
 */
public class GeneralPurposeResultsModule extends Module  
{

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

	/**
	 * Instantiates a new general purpose results module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public GeneralPurposeResultsModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0040,0x4033));
		objSingleCollection.add(new Tag(0x0040,0x4031));
		objSingleCollection.add(new Tag(0x0040,0x4032));
	}

	/**
	 * 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 - returns validation status as success or failure
	 * 
	 * @throws InvalidModuleException - If validation of Module fails
	 */
	public boolean validateModule() throws InvalidModuleException
	{
		return true;
	}


	/**
	 * Retrieves pre-initialized object of OutputInformationSequence.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 OutputInformationSequence - instance of Output Information Sequence
	 */
	public OutputInformationSequence getOutputInformationSequence()
	{
		OutputInformationSequence objOutputInformationSequence = (OutputInformationSequence)getDicomValue(0x0040,0x4033);
		if(objOutputInformationSequence == 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();
			objOutputInformationSequence = (OutputInformationSequence)objDicomV3Factory.createSequence(0x0040,0x4033, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040,0x4033, DicomConstants.DCM_DT_SQ, objOutputInformationSequence.getValue());
		}
		return objOutputInformationSequence;
	}

	/**
	 * Retrieves pre-initialized object of RequestedSubsequentWorkitemCodeSequence.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 RequestedSubsequentWorkitemCodeSequence - instance of Referenced Reference Image Sequence.
	 */
	public RequestedSubsequentWorkitemCodeSequence getRequestedSubsequentWorkitemCodeSequence()
	{
		RequestedSubsequentWorkitemCodeSequence objRequestedSubsequentWorkitemCodeSequence = (RequestedSubsequentWorkitemCodeSequence)getDicomValue(0x0040,0x4031);
		if(objRequestedSubsequentWorkitemCodeSequence == 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();
			objRequestedSubsequentWorkitemCodeSequence = (RequestedSubsequentWorkitemCodeSequence)objDicomV3Factory.createSequence(0x0040,0x4031, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040,0x4031, DicomConstants.DCM_DT_SQ, objRequestedSubsequentWorkitemCodeSequence.getValue());
		}
		return objRequestedSubsequentWorkitemCodeSequence;
	}

	/**
	 * Retrieves pre-initialized object of NonDICOMOutputCodeSequence.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 NonDICOMOutputCodeSequence - instance of Referenced Reference Image Sequence.
	 */
	public NonDICOMOutputCodeSequence getNonDICOMOutputCodeSequence()
	{
		NonDICOMOutputCodeSequence objNonDICOMOutputCodeSequence = (NonDICOMOutputCodeSequence)getDicomValue(0x0040,0x4032);
		if(objNonDICOMOutputCodeSequence == 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();
			objNonDICOMOutputCodeSequence = (NonDICOMOutputCodeSequence)objDicomV3Factory.createSequence(0x0040,0x4032, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040,0x4032, DicomConstants.DCM_DT_SQ, objNonDICOMOutputCodeSequence.getValue());
		}
		return objNonDICOMOutputCodeSequence;
	}

	/**
	 * This method returns the vector of keys representing the DataElements
	 * that belong to this module.
	 * 
	 * @return vector of Tags - returns the vector containing the collection of tags.
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
