/*******************************************************************************
 *  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.ITag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.enums.EnumSortingDirection;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.exceptions.ValidationException;
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 methods to validate, set and get the attributes of Sorting Operations Sequence .
 */

public class SortingOperationsSequenceItem extends HangingProtocolSelectorAttributeContextMacroDependentItem
{

	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	SortingOperationsSequenceItem()
	{
		super();
	}


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

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

	/**
	 * Validates all the attributes in SortingOperationsSequenceItem that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			if(contains(0x0072,0x0026) && contains(0x0072,0x0602))
					throw new ConditionFailedException("0x0072,0x0026");
			if(contains(0x0072,0x0028) && (!contains(0x0072,0x0026)))
				throw new ConditionFailedException("0x0072,0x0602") ;
			if(contains(0x0072,0x0602) && contains(0x0072,0x0026))
				throw new ConditionFailedException("0x0072,0x0602");
			if(!contains(0x0072,0x0604))
				throw new MandatoryMissingException("0072,0604") ;
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		catch(ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	
	/**
	 * Sets the Data Element Tag of the attribute which was overridden.
	 * @param objITag Tag object of Override Parameter Pointer.
	 */
	public void setSelectorAttribute(ITag objITag)
	{
		/* Accept the Value Type in String format of type AT.
		 * Data Element Tag of an Attribute from an Image IOD to be used for sorting
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0072,0x0026, objITag,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0072,0x0026,DicomConstants.DCM_DT_AT, objITag);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves  Data Element Tag of the attribute which was overridden.
	 * @return String - Tag object of Override Parameter Pointer.
	 */
	public ITag getSelectorAttribute()
	{
		Object objValue = getValue(0x0072,0x0026);
		if(objValue != null)
			return (ITag)objValue;
		return null;
	}
	
	/**
	 * Sets Number of significant bits within the Selector Value Number
	 * @param shSelectorValueNumber short value of Number of significant bits
	 */
	public void setSelectorValueNumber(short shSelectorValueNumber)
	{
		/* Accept the SelectorValueNumber of type US.
		 * Positive integer identifying which
		 * value of the attribute identified by SelectorAttribute (0072,0026) is to be used for sorting. 
		 * The value of 1 identifies the first value. Shall not be zero
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)	
			objIDataElement = new ImplicitDE(0x0072,0x0028,shSelectorValueNumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0072,0x0028,DicomConstants.DCM_DT_US, shSelectorValueNumber);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Number of significant bits within the Selector Value Number
	 * @return short - short value of Number of significant bits
	 */
	public short getSelectorValueNumber()
	{
		Object objValue = getValue(0x0072,0x0028);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	 * Sets the SortbyCategory value
	 * @param strSortbyCategory Specifies type of the value encoded in this Item
	 */
	public void setSortbyCategory(String strSortbyCategory)
	{
		/* Accept the Value Type in String format of type CS.
		 * Sort by Category is Category of the sorting operation
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0072, 0x0602, strSortbyCategory,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0072, 0x0602,DicomConstants.DCM_DT_CS, strSortbyCategory);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves type of the value encoded in this Item
	 * @return String - Type of the value encoded in this Item
	 */
	public String getSortbyCategory()
	{
		Object objValue = getValue(0x0072, 0x0602);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	
	/**
	 * Sets the SortingDirection value
	 * @param strSortingDirection Specifies type of the value encoded in this Item
	 */
	public void setSortingDirection(EnumSortingDirection enumSortingDirection)
	{
		/* Accept the Value Type in String format of type CS.
		 * Sorting Direction is Sorting direction to be applied to the value(s) in the image set of
		 * the attribute identified by Selector Attribute (0072,0026) or Sort-by Category (0072,0602).
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0072, 0x0604, enumSortingDirection,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0072, 0x0604,DicomConstants.DCM_DT_CS, enumSortingDirection);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves type of the value encoded in this Item
	 * @return String - Type of the value encoded in this Item
	 */
	public String getSortingDirection()
	{
		Object objValue = getValue(0x0072, 0x0604);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

}
