/*******************************************************************************
 *  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.EnumImageSetSelectorUsageFlag;
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 Image Set Selector Sequence .
 */


public class ImageSetSelectorSequenceItem extends Item 
{

	private static final long serialVersionUID = 1L;
	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	ImageSetSelectorSequenceItem()
	{
		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
	 */
	ImageSetSelectorSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates ImageSetSelectorSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	ImageSetSelectorSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{	
			if(!contains(0x0072,0x0024))
				throw new MandatoryMissingException("0072,0024") ;
			if(!contains(0x0072,0x0026))
				throw new MandatoryMissingException("0072,0026") ;
			if(!contains(0x0072,0x0050))
				throw new MandatoryMissingException("0072,0050") ;
			if(!contains(0x0072,0x0028))
				throw new MandatoryMissingException("0072,0028") ;
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	
	/**
	 * Indicates the behavior of matching against an image object when Selector Attribute (0072,0026) is not available in the image object.
	 * Enumerated Values:
	 * 1) MATCH.
	 * 2) NO_MATCH.
	 * @param EnumImageSetSelectorUsageFlag enum value of Image Set Selector Usage Flag.
	 */
	public void setImageSetSelectorUsageFlag(EnumImageSetSelectorUsageFlag enumImageSetSelectorUsageFlag)
	{
		/* Accept the Image Set Selector Usage Flag.
		 * It is behavior of matching against an image object
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0072,0x0024, enumImageSetSelectorUsageFlag.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0072,0x0024,DicomConstants.DCM_DT_CS, enumImageSetSelectorUsageFlag.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of Image Set Selector Usage Flag. 
	 * @return String - value of Image Set Selector Usage Flag.
	 */
	public String getImageSetSelectorUsageFlag()
	{
		Object objValue = getValue(0x0072,0x0024);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the Selector Attribute Tag of the attribute which was overridden.
	 * @param objITag Tag object of Override Parameter Pointer.
	 */
	public void setSelectorAttribute(ITag objITag)
	{
		/* Accept the Value Type Tag object.
		 * Data Element Tag of an Attribute from an Image
		 * 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  Selector Attribute 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 the Selector Attribute VR Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME
	 * @param strValueType Specifies type of the value present in SelectorAttribute
	 */
	public void setSelectorAttributeVR(String strValueType)
	{
		/*Accept the Value Type in String format of type CS.
		 *The Value Representation of Selector Attribute (0072,0026).
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0072,0x0050, strValueType,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0072,0x0050,DicomConstants.DCM_DT_CS, strValueType);

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


	/**
	 * Positive integer identifying which value of a multi-valued attribute identified
	 * Selector Attribute (0072,0026) is to be used for Image Set selection.
	 * @param selectorValueNumber short value of Number of significant bits
	 */
	public void setSelectorValueNumber(short selectorValueNumber)
	{
		/* Accept the Selector Value Number of type US.
		 * It is used for Image Set selection
		 * The value 1 identifies the first value. The value zero identifies any value.
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)	
			objIDataElement = new ImplicitDE(0x0072,0x0028,selectorValueNumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0072,0x0028,DicomConstants.DCM_DT_US, selectorValueNumber);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves 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;
	}


}
