/*******************************************************************************
 *  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.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;

/**
 *  This class contains the Attributes required for Query Model. Also contains methods to populate and fill dataset of Query Model.
 */

public class SOPCommanAttribute extends Attributes {

	/**
	 * This is default Constructor for SOPCommanAttribute.
	 */
	public SOPCommanAttribute() {
		super();
	}
	
	/**
	 * The method is used to set Unique identifier the SOP Class.
	 * DE based on the transfer syntax and populates the DE with right values.
	 * This De is then added to the Module DataSet
	 * 
	 * @param strSOPClassUID the str sop class uid
	 */
	public void setSOPClassUID(String strSOPClassUID)
	{
		/*Accept Unique identifier the SOP Class in String format of type UI.
		 * 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,0x0016, DicomConstants.DCM_DT_UI, strSOPClassUID);
	}

	/**
	 * The method is used to set Unique identifier the SOP Instance.
	 * DE based on the transfer syntax and populates the DE with right values.
	 * This De is then added to the Module DataSet
	 * 
	 * @param strSOPInstanceUID  Unique identifier the SOP Instance.
	 */
	public void setSOPInstanceUID(String strSOPInstanceUID)
	{
		/*Accept Unique identifier the SOP Instance in String format of type UI.
		 * 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,0x0018, DicomConstants.DCM_DT_UI, strSOPInstanceUID);
	}
	/**
	 * Retrieves the UID of SOP Class.
	 * 
	 * @return String - returns the UID of SOP Class
	 */
	public String getSOPClassUID()
	{
		Object objValue = objIDataSet.getValue(0x0008,0x0016);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Retreives the UID of SOP Instance.
	 * 
	 * @return String - retruns the SOP Instance UID
	 */
	public String getSOPInstanceUID()
	{
		Object objValue = objIDataSet.getValue(0x0008,0x0018);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Populates the query Model using filled dataset.
	 */
	public void populate(IDataSet objIDataSet)
	{
		super.populate(objIDataSet);
	}	
	
	/**
	 * Fills the dataset using already populated Query Model.
	 */
	public void fill(IDataSet objIDataSet)
	{
		super.fill(objIDataSet);
	}
}
