/*******************************************************************************
 *  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.IDicomValue;
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 methods to validate,set and get the attributes in {@link ROIContourSequence}.
 */
public class ROIContourSequenceItem extends Item  
{
	


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


	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	ROIContourSequenceItem()
	{
		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.
	 */
	ROIContourSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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


	/**
	 * Validates all the attributes in ROIContourSequenceItem according the rules defined by the Contour Sequence.
	 * @return boolean - Success -true, Failure - false.
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			if(!contains(0x3006,0x0084))
				throw new MandatoryMissingException("3006,0084");
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}

	/**
	 * Sets value that uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).
	 * @param strReferencedROINumber String value of Referenced ROI Number.
	 */
	public void setReferencedROINumber(String strReferencedROINumber)
	{
		/*Accept the Referenced ROI Number in String format of type IS.
		 * 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(0x3006,0x0084, strReferencedROINumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3006,0x0084,DicomConstants.DCM_DT_IS, strReferencedROINumber);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves  value that uniquely identifies the referenced ROI described in the Structure Set ROI Sequence (3006,0020).
	 * @return String - value of Referenced ROI Number.
	 */
	public String getReferencedROINumber()
	{
		Object objValue = getValue(0x3006,0x0084);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets RGB triplet color representation for ROI, specified using the range 0-255.
	 * @param arrStrROIDisplayColor  String array value of ROI Display Color.
	 */
	public void setROIDisplayColor(String[] arrStrROIDisplayColor)
	{
		/* Accept the ROI Display Color in String format of type IS.
		 * 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(0x3006, 0x002A, arrStrROIDisplayColor,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3006, 0x002A,DicomConstants.DCM_DT_IS, arrStrROIDisplayColor);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves RGB triplet color representation for ROI, specified using the range 0-255.
	 * @return String - array value of ROI Display Color.
	 */
	public String[] getROIDisplayColor()
	{
		Object objValue = getValue(0x3006, 0x002A);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}


	/**
	 * Sets default single gray unsigned value in which it is recommended thatthe contour be rendered on a monochrome display.
	 * @param shRecommendedDisplayGrayscaleValue short value of RecommendedDisplayGrayscaleValue
	 */
	public void setRecommendedDisplayGrayscaleValue(short shRecommendedDisplayGrayscaleValue)
	{
		/* Accept the RecommendedDisplayGrayscaleValue 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(0x0062,0x000C,shRecommendedDisplayGrayscaleValue,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0062,0x000C,DicomConstants.DCM_DT_US, shRecommendedDisplayGrayscaleValue);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves default single gray unsigned value in which it is recommended thatthe contour be rendered on a monochrome display.
	 * @return short - short value of RecommendedDisplayGrayscaleValue
	 */
	public short getRecommendedDisplayGrayscaleValue()
	{
		Object objValue = getValue(0x0062,0x000C);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	public void setRecommendedDisplayCIELabValue(short[] arrShRecommendedDisplayCIELabValue)
	{
		/*Accept the RecommendedDisplayCIELabValue in Array of short format 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(0x0062, 0x000D, arrShRecommendedDisplayCIELabValue,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0062, 0x000D,DicomConstants.DCM_DT_US, arrShRecommendedDisplayCIELabValue);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves RecommendedDisplayCIELabValue
	 * @return short Array of RecommendedDisplayCIELabValue
	 */
	public short[] getRecommendedDisplayCIELabValue()
	{
		Object objValue = getValue(0x0062, 0x000D);
		if(objValue != null)
			return (short[])objValue;
		return null;
	}
	
	/**
	 * Retrieves pre-initialized object of Contour Sequence.If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence.
	 * @return ContourSequence - instance of ContourSequence. 
	 */
	public ContourSequence getContourSequence()
	{
		ContourSequence objContourSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x3006,0x0040);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objContourSequence = (ContourSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objContourSequence = (ContourSequence)objDicomV3Factory.createSequence(0x3006,0x0040, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x3006,0x0040, objContourSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x3006,0x0040, DicomConstants.DCM_DT_SQ, objContourSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objContourSequence;
	}
}
