/*******************************************************************************
 *  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.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 the methods to set, get and validate the attribute present in Annotation Content Sequence Item.
 */
public class AnnotationContentSequenceItem extends Item  
{
	

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

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax.
	 */
	AnnotationContentSequenceItem()
	{
		super();
	}

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

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

	/**
	 * Sets SOP Instance UID of the contained Annotation SOP Class. 
	 * Required if Sequence is sent.
	 * @param strSOPInstanceUID -String value of SOP Instance UID of the contained Annotation SOP Class.
	 */
	public void setSOPInstanceUID(String strSOPInstanceUID)
	{
		/* Accept the SOP Instance UID 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(0x0008,0x0018,strSOPInstanceUID,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008,0x0018,DicomConstants.DCM_DT_UI, strSOPInstanceUID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves SOP Instance UID of the contained Annotation SOP Class. 
	 * Required if the Annotation Content Sequence is sent.
	 * @return String - value of  SOP Instance UID.
	 */
	public String getSOPInstanceUID()
	{
		Object objValue = getValue(0x0008,0x0018);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets the position of the annotation box in the parent film box. 
	 * Required if the Annotation Content Sequence is sent.
	 * @param shAnnotationPosition -short value of Annotation Position.
	 */
	public void setAnnotationPosition(short shAnnotationPosition)
	{
		/* Accept the Annotation Position of type US.
		 * 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(0x2030,0x0010,shAnnotationPosition,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x2030,0x0010,DicomConstants.DCM_DT_US, shAnnotationPosition);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves the position of the annotation box in the parent film box. 
	 * @return short - value of Annotation Position.
	 */
	public short getAnnotationPosition()
	{
		Object objValue = getValue(0x2030,0x0010);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	 * Sets Text String. 
	 * @param strTextString -String value of Text String.
	 */
	public void setTextString(String strTextString)
	{
		/* Accept the Text String of type LO.
		 * 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(0x2030,0x0020,strTextString,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x2030,0x0020,DicomConstants.DCM_DT_LO,strTextString);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Text String. 
	 * @return String - value of Text String.
	 */
	public String getTextString()
	{
		Object objValue = getValue(0x2030,0x0020);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Validates all the attributes in {@link AnnotationContentSequence} 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(0x0008,0x0018))
				throw new ConditionFailedException("0008,0018");
			if(!contains(0x2030,0x0010))
				throw new ConditionFailedException("2030,0010");
			if(!contains(0x2030,0x0020))
				throw new ConditionFailedException("2030,0020");

		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(), me);
		}
		return true;
	}
}
