/*******************************************************************************
 *  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.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 Frame VOILUT Sequence.
 */

public class FrameVOILUTSequenceItem extends Item
{
	

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

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

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

	/**
	 * Validates all the attributes in FrameVOILUTSequenceItem 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(0x0028,0x1050))
				throw new MandatoryMissingException("0028,1050");
			if(!contains(0x0028,0x1051))
				throw new MandatoryMissingException("0028,1051");
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(mme.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),mme);
		}
		return true;
	}
	
	/**
	 * Sets the Window Center for display
	 * @param arrstrWindowCenter String array of Window Center
	 */
	public void setWindowCenter(String[] arrstrWindowCenter)
	{
		/*Accept the Window Center in String Array format of type DS.
		 * 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(0x0028,0x1050, arrstrWindowCenter,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0028,0x1050,DicomConstants.DCM_DT_DS, arrstrWindowCenter);

		addDataElement(objIDataElement);

	}
	/**
	 * Retrieves the Window Center for display
	 * @return String[] - String array of Window Center
	 */
	public String[] getWindowCenter()
	{
		Object objValue = getValue(0x0028,0x1050);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}

	/**
	 * Sets the Window Width for display
	 * @param arrstrWindowWidth String array of Window Width
	 */
	public void setWindowWidth(String[] arrstrWindowWidth)
	{
		/*Accept the Window Width in String format of type DS.
		 * 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(0x0028,0x1051, arrstrWindowWidth,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0028,0x1051,DicomConstants.DCM_DT_DS, arrstrWindowWidth);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Window Width for display
	 * @return String[] - String array of Window Width
	 */
	public String[] getWindowWidth()
	{
		Object objValue = getValue(0x0028,0x1051);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}

	/**
	 * Sets the Free form explanation of the meaning of the Window Center and Width.
	 * @param arrstrWindowCenterandWidthExplanation String array of explanation
	 */
	public void setWindowCenterandWidthExplanation(String[] arrstrWindowCenterandWidthExplanation)
	{
		/*Accept the Window Center and Width Explanation in String format 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(0x0028,0x1055, arrstrWindowCenterandWidthExplanation,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0028,0x1055,DicomConstants.DCM_DT_LO, arrstrWindowCenterandWidthExplanation);

		addDataElement(objIDataElement);

	}
	/**
	 * Retrieves the Free form explanation of the meaning of the Window Center and Width.
	 * @return String[] - String array of explanation
	 */
	public String[] getWindowCenterandWidthExplanation()
	{
		Object objValue = getValue(0x0028,0x1055);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}
	
	/**
	 * Sets the layer in which the graphics or text is to be rendered.
	 * @param strVOILUTFunction String value of VOI LUT Function
	 */
	public void setVOILUTFunction(String strVOILUTFunction)
	{
		/*Accept the VOILUTFunction 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(0x0028,0x1056, strVOILUTFunction,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0028,0x1056,DicomConstants.DCM_DT_CS, strVOILUTFunction);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the layer in which the graphics or text is to be rendered.
	 * @return String - value of VOI LUT Function
	 */
	public String getVOILUTFunction()
	{
		Object objValue = getValue(0x0028,0x1056);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
}
