/*******************************************************************************
 *  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.enums.EnumPresentationLUTShape;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
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 Presentation LUT Content Sequence Item.
 */
public class PresentationLUTContentSequenceItem extends Item  
{
	

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

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

	/**
	 * This constructor creates Presentation LUT 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 
	 */
	PresentationLUTContentSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/**
	 * Sets SOP Instance UID of the contained Presentation LUT Content SOP Class.
	 * Required if Sequence is sent.
	 * @param strSOPInstanceUID String value of SOP Instance UID of the contained Presentation LUT Content 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 Presentation LUT Content SOP Class.
	 * Required if the Presentation LUT 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;
	}

	/**
	 * Retrieves pre-initialized object of Presentation LUT 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 PresentationLUTSequence - instance of Presentation LUT Sequence. 
	 */
	public PresentationLUTSequence getPresentationLUTSequence()
	{
		PresentationLUTSequence objPresentationLUTSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x2050,0x0010);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objPresentationLUTSequence = (PresentationLUTSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objPresentationLUTSequence = (PresentationLUTSequence)objDicomV3Factory.createSequence(0x2050,0x0010, objITransferSyntax, objIDictionaryReader);

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

	/**
	 * Sets predefined Presentation LUT transformation. Required if Presentation LUT Sequence (2050,0010) is absent.
	 * Enumerated Values:
	 * 1) IDENTITY - no further translation necessary, input values are P-Values.
	 * 2) INVERSE - output values after inversion are P-Values
	 * @param enumPresentationLUTShape Enum value of Presentation LUT Shape.
	 */
	public void setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape)
	{
		/* Accept the Presentation LUT Shape in String format of type CS.
		 * 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(0x2050, 0x0020, enumPresentationLUTShape.getValue(),objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x2050, 0x0020,DicomConstants.DCM_DT_CS, enumPresentationLUTShape.getValue());
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves predefined Presentation LUT transformation.
	 * @return String - value of Presentation LUT Shape.
	 */
	public String getPresentationLUTShape()
	{
		Object objValue = getValue(0x2050, 0x0020);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Validates all the attributes in {@link PresentationLUTContentSequenceItem} 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 Required if Sequence is sent.");
			if(!contains(0x2050,0x0020) && !contains(0x2050,0x0010))
				throw new ConditionFailedException("2050,0010 Required if Presentation LUT Shape (2050,0020) is not present.");
			if(!contains(0x2050,0x0010) && !contains(0x2050,0x0020))
				throw new ConditionFailedException("2050,0020 Required if Presentation LUT Sequence (2050,0010) is not present.");
			if(contains(0x2050,0x0010))
				getPresentationLUTSequence().validateForModule();
		}
		catch( ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(cfe.getMessage());
			}
			throw new InvalidModuleException(this.getClass().getSimpleName(),cfe);
		}
		return true;
	}
}
