/*******************************************************************************
 *  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.HangingProtocolDefinitionSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.HangingProtocolUserIdentificationCodeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.SourceHangingProtocolSequence;
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.EnumHangingProtocolLevel;
import cdac.medinfo.sdk.dcm30_04.baselibs.ImageSetsSequence;
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 Hanging Protocol Definition Module.
*/
public class HangingProtocolDefinitionModule extends Module
{

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


	/**
	 * Creates instance of HangingProtocolDefinitionModule
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public HangingProtocolDefinitionModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0072, 0x0002));
		objSingleCollection.add(new Tag(0x0072, 0x0004));
		objSingleCollection.add(new Tag(0x0072, 0x0006));
		objSingleCollection.add(new Tag(0x0072, 0x0008));
		objSingleCollection.add(new Tag(0x0072, 0x000A));
		objSingleCollection.add(new Tag(0x0072, 0x000C));
		objSingleCollection.add(new Tag(0x0072, 0x0014));
		objSingleCollection.add(new Tag(0x0072, 0x0020));
		objSingleCollection.add(new Tag(0x0072, 0x000E));	
		objSingleCollection.add(new Tag(0x0072, 0x0010));
		objSingleCollection.add(new Tag(0x0072, 0x0012));

	}

	/**
	 * 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 true, if validate module
	 * 
	 * @throws InvalidModuleException - If validation of Module fails
	 */

	public boolean validateModule()throws InvalidModuleException
	{

		try
		{
			/*
			 * Validation Rules for Mandatory Elements
			 */
			if(!isPresent(0x0072, 0x0002))
				throw new MandatoryMissingException("Missing Mandatory Element 0072,0002");
			if(!isPresent(0x0072, 0x0004))
				throw new MandatoryMissingException("Missing Mandatory Element 0072,0004");
			if(!isPresent(0x0072, 0x0006))
				throw new MandatoryMissingException("Missing Mandatory Element 0072,0006");
			if(!isPresent(0x0072, 0x0008))
				throw new MandatoryMissingException("Missing Mandatory Element 0072,0008");
			if(!isPresent(0x0072, 0x000A))
				throw new MandatoryMissingException("Missing Mandatory Element 0072,000A");
			if(!isPresent(0x0072, 0x000C))
				throw new MandatoryMissingException("Missing Mandatory Element 0072,000C");
			if(!isPresent(0x0072, 0x0014))
				throw new MandatoryMissingException("Missing Mandatory Element 0072,0014");
			if(!isPresent(0x0072, 0x0020))
				throw new MandatoryMissingException("Missing Mandatory Element 0072,0020");
			if(!isPresent(0x0072, 0x000E))
				throw new MandatoryMissingException("Missing Mandatory Element 0072,000E");

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

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

		}
		return true;
	}
	/**
	 * Sets the Hanging Protocol Name.
	 * @param strHangingProtocolName
	 */
	public void setHangingProtocolName(String strHangingProtocolName)
	{
		/*Accept the Hanging Protocol Name in String format of type SH.
		 * 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(0x0072, 0x0002, DicomConstants.DCM_DT_SH,strHangingProtocolName);
	}
	/**
	 * Retrieves Hanging Protocol Name
	 * @return String - value of Hanging Protocol Name
	 */
	public String getHangingProtocolName()
	{
		Object objValue = getValue(0x0072, 0x0002);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets the Explanation of the objective or intent of the Hanging Protocol
	 * @param strHangingProtocolDescription
	 */
	public void setHangingProtocolDescription(String strHangingProtocolDescription)
	{
		/*Accept the Hanging Protocol Name in String format of type SH.
		 * 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(0x0072, 0x0004, DicomConstants.DCM_DT_LO,strHangingProtocolDescription);
	}
	/**
	 * Retrieves Explanation of the objective or intent of the Hanging Protocol
	 * @return String - value of Hanging Protocol Description
	 */
	public String getHangingProtocolDescription()
	{
		Object objValue = getValue(0x0072, 0x0004);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the level at which this Hanging Protocol is defined, and the intended use.
	 * @param enumHangingProtocolLevel enum value of Hanging Protocol Level.
	 */
	public void setHangingProtocolLevel(EnumHangingProtocolLevel enumHangingProtocolLevel)
	{
		/* Accept the Hanging Protocol Level 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(0x0072, 0x0006, DicomConstants.DCM_DT_CS,enumHangingProtocolLevel.getValue());
	}
	/**
	 * Return the level at which this Hanging Protocol is defined, and the intended use.
	 * @return String - value of Hanging Protocol Level.
	 */
	public String getHangingProtocolLevel()
	{
		Object objValue = getValue(0x0072, 0x0006);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the creator of the Hanging Protocol.
	 * @param strHangingProtocolCreator
	 */
	public void setHangingProtocolCreator(String strHangingProtocolCreator)
	{
		/*Accept the Hanging Protocol Creator in String format of type SH.
		 * 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(0x0072, 0x0008, DicomConstants.DCM_DT_LO,strHangingProtocolCreator);
	}
	/**
	 * Retrieves the creator of the Hanging Protocol.
	 * @return String - value of Hanging Protocol Creator
	 */
	public String getHangingProtocolCreator()
	{
		Object objValue = getValue(0x0072, 0x0008);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets the Date and time on which the Hanging Protocol was created.
	 * @param strHangingProtocolCreationDateTime
	 */
	public void setHangingProtocolCreationDateTime(String strHangingProtocolCreationDateTime)
	{
		/*Accept the Hanging Protocol CreationDateTime in String format of type SH.
		 * 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(0x0072, 0x000A, DicomConstants.DCM_DT_DT,strHangingProtocolCreationDateTime);
	}
	/**
	 * Retrieves Date and time on which the Hanging Protocol was created.
	 * @return String - value of Hanging Protocol CreationDateTime
	 */
	public String getHangingProtocolCreationDateTime()
	{
		Object objValue = getValue(0x0072, 0x000A);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Retrieves pre-initialized object of HangingProtocolDefinitionSequence
	 * @return HangingProtocolDefinitionSequence - HangingProtocolDefinitionSequence
	 */
	public HangingProtocolDefinitionSequence getHangingProtocolDefinitionSequence()
	{
		HangingProtocolDefinitionSequence objHangingProtocolDefinitionSequence = (HangingProtocolDefinitionSequence)getDicomValue(0x0072, 0x000C);
		if(objHangingProtocolDefinitionSequence == 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();
			objHangingProtocolDefinitionSequence = (HangingProtocolDefinitionSequence)objDicomV3Factory.createSequence(0x0072, 0x000C, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0072, 0x000C, DicomConstants.DCM_DT_SQ, objHangingProtocolDefinitionSequence.getValue());
		}
		return objHangingProtocolDefinitionSequence;	
	}
	/**
	 * Sets the number of prior image sets used in this HangingProtocol.
	 * @param shNumberOfPriorsReferenced short value of Number of PriorsReferenced
	 */
	public void setNumberOfPriorsReferenced(short shNumberOfPriorsReferenced)
	{
		/* Accept the WaveformBitsStored of type US.
		 * 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(0x0072, 0x0014, DicomConstants.DCM_DT_US,shNumberOfPriorsReferenced);
	}

	/**
	 * Retrieves the number of prior image sets used in this HangingProtocol.
	 * @return short - short value of Number of PriorsReferenced
	 */
	public short getNumberOfPriorsReferenced()
	{
		Object objValue = getValue(0x0072, 0x0014);
		if(objValue != null)
			return Short.parseShort(objValue.toString());

		return DicomConstants.DCM_NO_VALUE;
	}
	/**
	 * Retrieves pre-initialized object of ImageSetsSequence
	 * @return ImageSetsSequence - ImageSetsSequence
	 */
	public ImageSetsSequence getImageSetsSequence()
	{
		ImageSetsSequence objImageSetsSequence = (ImageSetsSequence)getDicomValue(0x0072, 0x0020);
		if(objImageSetsSequence == 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();
			objImageSetsSequence = (ImageSetsSequence)objDicomV3Factory.createSequence(0x0072, 0x0020, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0072, 0x0020, DicomConstants.DCM_DT_SQ, objImageSetsSequence.getValue());
		}
		return objImageSetsSequence;	
	}
	/**
	 * Retrieves pre-initialized object of HangingProtocolUserIdentificationCodeSequence
	 * @return HangingProtocolUserIdentificationCodeSequence - HangingProtocolUserIdentificationCodeSequence
	 */
	public HangingProtocolUserIdentificationCodeSequence getHangingProtocolUserIdentificationCodeSequence()
	{
		HangingProtocolUserIdentificationCodeSequence objHangingProtocolUserIdentificationCodeSequence = (HangingProtocolUserIdentificationCodeSequence)getDicomValue(0x0072, 0x000E);
		if(objHangingProtocolUserIdentificationCodeSequence == 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();
			objHangingProtocolUserIdentificationCodeSequence = (HangingProtocolUserIdentificationCodeSequence)objDicomV3Factory.createSequence(0x0072, 0x000E, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0072, 0x000E, DicomConstants.DCM_DT_SQ, objHangingProtocolUserIdentificationCodeSequence.getValue());
		}
		return objHangingProtocolUserIdentificationCodeSequence;	
	}
	/**
	 * Sets the Group or site for which this Hanging Protocol was defined.
	 * @param strHangingProtocolUserGroupName
	 */
	public void setHangingProtocolUserGroupName(String strHangingProtocolUserGroupName)
	{
		/*Accept the Hanging Protocol UserGroup Name in String format of type SH.
		 * 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(0x0072, 0x0010, DicomConstants.DCM_DT_LO,strHangingProtocolUserGroupName);
	}
	/**
	 * Retrieves the Group or site for which this Hanging Protocol was defined.
	 * @return String - value of Hanging Protocol UserGroup Name
	 */
	public String getHangingProtocolUserGroupName()
	{
		Object objValue = getValue(0x0072, 0x0010);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Retrieves pre-initialized object of Source Hanging ProtocolSequence
	 * @return SourceHangingProtocolSequence - Source Hanging ProtocolSequence
	 */
	public SourceHangingProtocolSequence getSourceHangingProtocolSequence()
	{
		SourceHangingProtocolSequence objSourceHangingProtocolSequence = (SourceHangingProtocolSequence)getDicomValue(0x0072, 0x0012);
		if(objSourceHangingProtocolSequence == 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();
			objSourceHangingProtocolSequence = (SourceHangingProtocolSequence)objDicomV3Factory.createSequence(0x0072, 0x0012, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0072, 0x0012, DicomConstants.DCM_DT_SQ, objSourceHangingProtocolSequence.getValue());
		}
		return objSourceHangingProtocolSequence;	
	}
	/**
	 * This method returns the custom collection containing the list of DataElements belonging to the CT
	 * Image Module specified by DICOM Standard.
	 * 
	 * @return collection - custom collection containing the list of DataElements belonging to the CT Image Module
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
