/*******************************************************************************
 *  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.nget.commons;

import java.io.IOException;
import java.util.Locale;

import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumCommandField;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.services.dicomnetcommons.ICommandElement;
import cdac.medinfo.sdk.dcm30_04.services.dicomnetcommons.InvalidCommandSetException;
import cdac.medinfo.sdk.dcm30_04.services.dicomnetcommons.InvalidDICOMMessageException;
import cdac.medinfo.sdk.dcm30_04.services.dimsecommons.CommandElement;
import cdac.medinfo.sdk.dcm30_04.services.dimsecommons.DIMSERequest;
import cdac.medinfo.sdk.dcm30_04.services.dimsecommons.DicomMessage;
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.ResourceBundleWrapper;

/**
 * This class defines the required fields to create request to perform N-Get Service.
 * It provides the required methods for all mandatory and optional fields of N-Get Request.  
 */
public class NGetRQ extends DIMSERequest
{
	/**
	 * Instantiates a new N-Get RQ. Creates default Dicom Message for N-Get RQ.
	 */
	public NGetRQ()
	{
	}

	/**
	 * Instantiates a new N-Get RQ when Dicom Message is given by user.
	 * Retrieves Command Set and Data Set from the DicomMessage and sets in N-Get Request.
	 * @param objDicomMessage Object of DicomMessage from which N-Get request is initialized.
	 * @throws IOException Signals that an I/O exception has occurred.
	 */
	public NGetRQ(DicomMessage objDicomMessage) throws IOException
	{
		objICommandSet = objDicomMessage.getCommandSet();
		objIDataSet = objDicomMessage.getDataSet();
	}

	/**
	 * Sets Requested SOP Class UID . 
	 * SOP Class UID associated with the operation.
	 * @param strRequestedSOPClassUID value of Requested SOP Class UID.
	 */
	public void setRequestedSOPClassUID(String strRequestedSOPClassUID)
	{
		ICommandElement objICommandElement = null;
		objICommandElement = new CommandElement(0x0000, 0x0003,strRequestedSOPClassUID);
		objICommandSet.addCommandElement(objICommandElement);
	}

	/**
	 * Retrieves Requested SOP Class UID . 
	 * SOP Class UID associated with the operation.
	 * @return String - value of Requested SOP Class UID .
	 */
	public String getRequestedSOPClassUID()
	{
		Object objValue = getValue(0x0000,0x0003);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets the UID of the SOP Instance to be retrieved.
	 * @param strRequestedSOPInstanceUID String value of Requested SOP Instance UID.
	 */
	public void setRequestedSOPInstanceUID(String strRequestedSOPInstanceUID)
	{
		ICommandElement objICommandElement = null;
		objICommandElement = new CommandElement(0x0000, 0x1001,strRequestedSOPInstanceUID);
		objICommandSet.addCommandElement(objICommandElement);
	}

	/**
	 * Retrieves the UID of the SOP Instance to be retrieved.
	 * @return String - value of Requested SOP Instance UID.
	 */
	public String getRequestedSOPInstanceUID()
	{
		Object objValue = getValue(0x0000,0x1001);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets collection of Attribute Tag for each of the n Attributes applicable to the N-GET operation.
	 * @param objITagCollection collection of Attribute Tag.
	 */
	public void setAttributeIdentifierList(ISingleCollection<ITag> objITagCollection)
	{
		ICommandElement objICommandElement = null;
		objICommandElement = new CommandElement(0x0000,0x1005,objITagCollection);
		objICommandSet.addCommandElement(objICommandElement);
	}

	/**
	 * Retrieves collection of Attribute Tag for each of the n Attributes applicable to the N-GET operation.
	 * @return ISingleCollection<ITag> - collection of Attribute Tag.
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<ITag> getAttributeIdentifierList()
	{
		Object objValue = getValue(0x0000,0x1005);
		if(objValue != null)
			return (ISingleCollection<ITag>)objValue;
		return null;
	}

	/**
	 * This method makes N-Get RQ's according to the given parameters.
	 * @param strSOPClassUID value of SOPClassUID.
	 * @param strReqSOPInstanceUID value of Requested SOP Instance UID.
	 * @param objITagCollection list of requested attributes.
	 * @return NGetRQ instance of N-Get RQ.
	 */
	public static NGetRQ getDefaultRQ(String strSOPClassUID,String strReqSOPInstanceUID,ISingleCollection<ITag> objITagCollection)
	{
		NGetRQ objNGetRQ = new NGetRQ();
		objNGetRQ.setRequestedSOPClassUID(strSOPClassUID);
		objNGetRQ.setRequestedSOPInstanceUID(strReqSOPInstanceUID);
		objNGetRQ.setCommandField(EnumCommandField.N_GET_RQ);
		objNGetRQ.setCommandDataSetType(DicomConstants.DCM_DATASET_NOT_PRESENT);
		objNGetRQ.setAttributeIdentifierList(objITagCollection);
		objNGetRQ.setMessageID(shMsgID++);
		objNGetRQ.setCommandGroupLength(objNGetRQ.getCommandSet().getCommandSetLength());

		//Validating RQ
		objNGetRQ.validate();
		return objNGetRQ;
	}
	
	/**
	 * Validates the request for their mandatory attributes only.
	 * @return true, if validation is successful.
	 * @throws InvalidDICOMMessageException If validation of mandatory fields fails.
	 */
	public boolean validate() throws InvalidDICOMMessageException
	{
		super.validate();
		try
		{		
			//Checks for service type.
			if(getCommandType() != EnumCommandField.N_GET_RQ)
				throw new InvalidDICOMMessageException(ResourceBundleWrapper.getValue("exceptions","RQNotMatched",new Locale(DicomConfig.createInstance().getLocale())) + getCommandType().name());
			
			if(!objICommandSet.isPresent(0x0000,0x0003))			// Requested SOP Class UID
				throw new MandatoryMissingException("0000,0003");
			else
			{
				if(objICommandSet.getValue(0x0000,0x0003) == null)
					throw new InvalidDICOMMessageException(ResourceBundleWrapper.getValue("exceptions", "NullValue",new Locale(DicomConfig.createInstance().getLocale())) + 0x0000 + "," + 0x0003);
			}
			
			if(!objICommandSet.isPresent(0x0000,0x1001))		// Requested SOP Instance UID
				throw new MandatoryMissingException("0000,1001");
			else
			{
				if(objICommandSet.getValue(0x0000,0x1001) == null)
					throw new InvalidDICOMMessageException(ResourceBundleWrapper.getValue("exceptions", "NullValue",new Locale(DicomConfig.createInstance().getLocale())) + 0x0000 + "," + 0x1001);
			}
		}
		catch(MandatoryMissingException mme)
		{
			InvalidCommandSetException objCommandSetException = new InvalidCommandSetException(mme);
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

			throw new InvalidDICOMMessageException(this.getClass().getSimpleName(),objCommandSetException);
		}	
		return true;
	}
}
