/*******************************************************************************
 *  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.services.hangingprotocol.sourceimpl;

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.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.enums.EnumHangingProtocolLevel;
import cdac.medinfo.sdk.dcm30_04.baselibs.ImageSetsSequence;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;

/**
 *  This class contains the Attributes required for Query Model. Also contains methods to populate and fill data set of Query Model.
 */
public class HangingProtocolDefinitionAttributes  extends Attributes
{
	/**
	 * This is default Constructor for HangingProtocolDefinitionAttributes.
	 */
	public HangingProtocolDefinitionAttributes() {
		super();
	}
	
	/**
	 * 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, getDataSet().getTransferSyntax(), getDataSet().getDictionaryReader());
			
			// 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,getDataSet().getTransferSyntax(), getDataSet().getDictionaryReader());
			
			// 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,getDataSet().getTransferSyntax(), getDataSet().getDictionaryReader());
			
			// 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,getDataSet().getTransferSyntax(), getDataSet().getDictionaryReader());
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0072, 0x0012, DicomConstants.DCM_DT_SQ, objSourceHangingProtocolSequence.getValue());
		}
		return objSourceHangingProtocolSequence;	
	}
	/**
	 * Populates the query Model using filled data set.
	 */
	public void populate(IDataSet objIDataSet)
	{
		super.populate(objIDataSet);
	}	
	
	/**
	 * Fills the data set using already populated Query Model.
	 */
	public void fill(IDataSet objIDataSet)
	{
		super.fill(objIDataSet);
	}
}
