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

import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataElement;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
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;

/**
* This item class contains the methods to set, get and validate the attribute present in X DS Retrieval Sequence {@link XDSRetrievalSequence}.
 *
 */

public class XDSRetrievalSequenceItem extends Item  
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	XDSRetrievalSequenceItem()
	{
		super();
	}

	/**
	 * This constructor creates the item with specified TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	XDSRetrievalSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates XDSRetrievalSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	XDSRetrievalSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/**
	 * Sets a Repository Unique ID.
	 * @param strRepositoryUniqueID String value of Repository Unique ID.
	 */
	public void setRepositoryUniqueID(String strRepositoryUniqueID)
	{
		/*Accept the Repository Unique ID 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
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0400, 0xE030, strRepositoryUniqueID,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0400, 0xE030,DicomConstants.DCM_DT_UI, strRepositoryUniqueID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves a Repository Unique ID.
	 * @return String - value of Repository Unique ID.
	 */
	public String getRepositoryUniqueID()
	{
		Object objValue = getValue(0x0400, 0xE030);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets a Home Community ID.
	 * @param strHomeCommunityID String value of Home Community ID.
	 */
	public void setHomeCommunityID(String strHomeCommunityID)
	{
		/*Accept the Home Community ID 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
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0400, 0xE031, strHomeCommunityID,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0400, 0xE031,DicomConstants.DCM_DT_UI, strHomeCommunityID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves a Home Community ID.
	 * @return String - value of Home Community ID.
	 */
	public String getHomeCommunityID()
	{
		Object objValue = getValue(0x0400, 0xE031);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Validates all the attributes in XDSRetrievalSequenceItem  that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			if(!contains(0x0400,0xE030))
				throw new MandatoryMissingException("0400,E030") ;
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
}
