/*******************************************************************************
 *  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.PerformedProtocolCodeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedPerformedProcedureStepSequence;
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.enums.EnumModality;
import cdac.medinfo.sdk.dcm30_04.enums.EnumPerformedProtocolType;

import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
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;

/**
\* This module is used for Enhanced US Series Module.
*/
public class EnhancedUSSeriesModule extends Module 
{

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

	
	public EnhancedUSSeriesModule(IDataSet objIDataSet) {
		super(objIDataSet);
		
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x0060)); 
		objSingleCollection.add(new Tag(0x0008,0x1111)); 
		objSingleCollection.add(new Tag(0x0040,0x0260)); 
		objSingleCollection.add(new Tag(0x0040,0x0261)); 
		
		
	}
	@Override
	public boolean validateModule() {
		try
		{		
		
			if(!isPresent(0x0008,0x0060))
				throw new MandatoryMissingException("0008,0060");
			
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(cfe.getMessage());

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

		}
		return true;
	}

	/**
	 * Sets the Modality Type Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME
	 * @param enumModality Specifies type of the value encoded in this Item
	 */
	public void setModality(EnumModality enumModality)
	{
		/*Accept the Value Type in String format of type CS.
		 * 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 Data Set
		 */
		
		addDataElement(0x0008, 0x0060, DicomConstants.DCM_DT_IS, enumModality);
	}
	/**
	 * Retrieves type of the value encoded in this Item
	 * @return String - Type of the value encoded in this Item
	 */
	public String getModality()
	{
		Object objValue = getValue(0x0008, 0x0060);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

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

	/**
	 * This method provides the pre-initialized object of Performed Protocol Code Sequence.
	 * @return - object of Performed Protocol Code 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
	 */
	public PerformedProtocolCodeSequence getPerformedProtocolCodeSequence()
	{
		PerformedProtocolCodeSequence objPerformedProtocolCodeSequence = (PerformedProtocolCodeSequence)getDicomValue(0x0040, 0x0260);
		if(objPerformedProtocolCodeSequence == 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();
			objPerformedProtocolCodeSequence = (PerformedProtocolCodeSequence)objDicomV3Factory.createSequence(0x0040, 0x0260, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040, 0x0260, DicomConstants.DCM_DT_SQ, objPerformedProtocolCodeSequence.getValue());
		}
		return objPerformedProtocolCodeSequence;
	}
	
	/**
	 * Sets PerformedProtocolType
	 * @param enumPerformedProtocolType - Enum value PerformedProtocolType
	 */
	public void setPerformedProtocolType(EnumPerformedProtocolType enumPerformedProtocolType)
	{
		/*Accept PerformedProtocolType in String format of type ST.
		 * 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 Data Set
		 */
		addDataElement(0x0040, 0x0261, DicomConstants.DCM_DT_CS, enumPerformedProtocolType.getValue());
	}

	/**
	 * Retrieves the PerformedProtocolType
	 * 
	 * @return String - returns the PerformedProtocolType
	 */
	public String getPerformedProtocolType()
	{
		Object objectValue = getValue(0x0040, 0x0261);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}
	
	
}
