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

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

import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
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.ResourceBundleWrapper;

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

	/**
	 * Instantiates a new N-Create RQ when Dicom Message is given by user.
	 * Retrieves Command Set and Data Set from the DicomMessage and sets in N-Create Request.
	 * @param objDicomMessage Object of DicomMessage from which N-Create request is initialized.
	 * @throws IOException Signals that an I/O exception has occurred.
	 */
	public NCreateRQ(DicomMessage objDicomMessage) throws IOException
	{
		objICommandSet = objDicomMessage.getCommandSet();
		objIDataSet = objDicomMessage.getDataSet();
	}
	
	/**
	 * Sets Affected SOP Class UID . 
	 * SOP Class UID associated with the operation.
	 * @param strAffectedSOPClassUID value of affected SOP Class UID.
	 */
	public void setAffectedSOPClassUID(String strAffectedSOPClassUID)
	{
		ICommandElement objICommandElement = null;
		objICommandElement = new CommandElement(0x0000, 0x0002,strAffectedSOPClassUID);
		objICommandSet.addCommandElement(objICommandElement);
	}

	/**
	 * Retrieves Affected SOP Class UID . 
	 * SOP Class UID associated with the operation.
	 * @return String - value of Affected SOP Class UID .
	 */
	public String getAffectedSOPClassUID()
	{
		Object objValue = getValue(0x0000,0x0002);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the UID of the SOP Instance to be stored.
	 * @param strAffectedSOPInstanceUID String value of Affected SOP Instance UID.
	 */
	public void setAffectedSOPInstanceUID(String strAffectedSOPInstanceUID)
	{
		ICommandElement objICommandElement = null;
		objICommandElement = new CommandElement(0x0000, 0x1000,strAffectedSOPInstanceUID);
		objICommandSet.addCommandElement(objICommandElement);
	}

	/**
	 * Retrieves the UID of the SOP Instance to be stored.
	 * @return String - value of Affected SOP Instance UID.
	 */
	public String getAffectedSOPInstanceUID()
	{
		Object objValue = getValue(0x0000,0x1000);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * This method makes N-Create RQ's according to the given DataSet and SOPInstanceUID
	 * @param strSOPClassUID value of SOPClassUID
	 * @param strSOPInstanceUID value of SOPInstance UID.
	 * @param objIDataSet object of DataSet to be set in NCreate RQ.
	 * @return NCreateRQ - instance of NCreate RQ
	 */
	public static NCreateRQ getDefaultRQ(String strSOPClassUID,String strSOPInstanceUID,IDataSet objIDataSet)
	{
		NCreateRQ objNCreateRQ = new NCreateRQ();
		objNCreateRQ.setAffectedSOPClassUID(strSOPClassUID);
		objNCreateRQ.setAffectedSOPInstanceUID(strSOPInstanceUID);
		objNCreateRQ.setCommandField(EnumCommandField.N_CREATE_RQ);
		if(null != objIDataSet && !objIDataSet.isEmpty())
			objNCreateRQ.setCommandDataSetType(DicomConstants.DCM_DATASET_PRESENT);
		else
			objNCreateRQ.setCommandDataSetType(DicomConstants.DCM_DATASET_NOT_PRESENT);
		objNCreateRQ.setMessageID(shMsgID++);
		objNCreateRQ.setDataSet(objIDataSet);
		objNCreateRQ.setCommandGroupLength(objNCreateRQ.getCommandSet().getCommandSetLength());

		//Validating RQ
		objNCreateRQ.validate();
		return objNCreateRQ;
	}
	
	/**
	 * 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_CREATE_RQ)
				throw new InvalidDICOMMessageException(ResourceBundleWrapper.getValue("exceptions","RQNotMatched",new Locale(DicomConfig.createInstance().getLocale())) + getCommandType().name());
			
			if(!objICommandSet.isPresent(0x0000,0x0002))			// Affected SOP Class UID
				throw new MandatoryMissingException("0000,0002");
			else
			{
				if(objICommandSet.getValue(0x0000,0x0002) == null)
					throw new InvalidDICOMMessageException(ResourceBundleWrapper.getValue("exceptions", "NullValue",new Locale(DicomConfig.createInstance().getLocale())) + 0x0000 + "," + 0x0002);
			}
		}
		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;
	}
}
