/*******************************************************************************
 *  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.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 UV Mapping Sequence{@link UVMappingSequence }.
 */

public class UVMappingSequenceItem extends Item  
{
	

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

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

	/*
	 * This constructor calls the respective superclass constructor
	 * This constructor should throw exception if null TS is tried to be set
	 */
	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	UVMappingSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	
	/**
	 * Validates all the attributes in UVMappingSequenceItem 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(0x0080,0x0009))
				throw new MandatoryMissingException("0080,0009");
			if(!contains(0x0080,0x0010))
				throw new MandatoryMissingException("0080,0010");
			if(!contains(0x0080,0x0012))
				throw new MandatoryMissingException("0080,0012");
			if(!contains(0x0080,0x0011))
				throw new MandatoryMissingException("0080,0011");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	/**
	 * Sets the TextureLabel.
	 * @param strTextureLabel
	 */
	public void setTextureLabel(String strTextureLabel)
	{
		/*Accept the TextureLabel in String format of type SH.
		 * 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(0x0080,0x0009, strTextureLabel,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0080,0x0009,DicomConstants.DCM_DT_SH, strTextureLabel);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Texture Label.
	 * @return String - value of TextureLabel.
	 */
	public String getTextureLabel()
	{
		Object objValue = getValue(0x0080,0x0009);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/* Sets U Value Data.
	 * @param fArrUValueData float value of U Value Data
	 */
	public void setUValueData(float[] fArrUValueData)
	{
		/* Accept the U Value Data of type OF.
		 * 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(0x0080,0x0010,fArrUValueData,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0080,0x0010,DicomConstants.DCM_DT_OF, fArrUValueData);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves U Value Data.
	 * A data stream of U Value Data.
	 * @return float - float value of U Value Data
	 */
	public float[] getUValueData()
	{
		Object objValue = getValue(0x0080,0x0010);
		if(objValue != null)
			return (float[])objValue;
		return null;
	}

	/* Sets V Value Data.
	 * @param fArrVValueData float value of V Value Data
	 */
	public void setVValueData(float[] fArrVValueData)
	{
		/* Accept the U Value Data of type OF.
		 * 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(0x0080,0x0011,fArrVValueData,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0080,0x0011,DicomConstants.DCM_DT_OF, fArrVValueData);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves V Value Data.
	 * A data stream of V Value Data.
	 * @return float - float value of V Value Data
	 */
	public float[] getVValueData()
	{
		Object objValue = getValue(0x0080,0x0011);
		if(objValue != null)
			return (float[])objValue;
		return null;
	}

	/**
	 * Retrieves pre-initialized object of Referenced Texture 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 ReferencedTextureSequence - instance of ReferencedTextureSequence. 
	 */
	public ReferencedTextureSequence getReferencedTextureSequence()
	{
		ReferencedTextureSequence objReferencedTextureSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0080,0x0012);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objReferencedTextureSequence = (ReferencedTextureSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objReferencedTextureSequence = (ReferencedTextureSequence)objDicomV3Factory.createSequence(0x0080,0x0012, objITransferSyntax, objIDictionaryReader);

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

}
