/*******************************************************************************
 *  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 the methods to set, get and validate the attribute present in HPGL Pen Sequence.
 */

public class HPGLPenSequenceItem extends Item
{

	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 * and default DictionaryReader
	 */
	HPGLPenSequenceItem()
	{
		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 
	 * and default DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax  
	 */
	HPGLPenSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}
	/**
	 * This constructor creates 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 
	 */
	HPGLPenSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/**
	 * Validates all the attributes in HPGLPenSequenceItem 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(0x0068,0x6330))
				throw new MandatoryMissingException("0068,6330");
			if(!contains(0x0068,0x6340))
				throw new MandatoryMissingException("0068,6340");
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}

	/**
	 * Sets Numeric ID of the pen in the HPGL document
	 * @param shHPGLPenNumber short value of Numeric ID of the pen in the HPGL document
	 */
	public void setHPGLPenNumber(short shHPGLPenNumber)
	{
		/* Accept the Numeric ID of the pen in the HPGL document 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(0x0068,0x6330,shHPGLPenNumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0068,0x6330,DicomConstants.DCM_DT_US, shHPGLPenNumber);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Numeric ID of the pen in the HPGL document
	 * @return short - short value of Numeric ID of the pen in the HPGL document
	 */
	public short getHPGLPenNumber()
	{
		Object objValue = getValue(0x0068,0x6330);
		if(objValue != null)
			return Short.parseShort(objValue.toString());

		return DicomConstants.DCM_NO_VALUE;
	}
	/**
	 * Sets Label of the pen.
	 * @param strHPGLPenLabel String value of Label of the pen.
	 */
	public void setHPGLPenLabel(String strRescaleType)
	{
		/* Accept the HPGLPenLabel 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(0x0068,0x6340, strRescaleType,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0068,0x6340,DicomConstants.DCM_DT_LO, strRescaleType);

		addDataElement(objIDataElement);
	}

	/**
	 * Return Label of the pen.
	 * @return String - value of Label of the pen.
	 */
	public String getHPGLPenLabel()
	{
		Object objValue = getValue(0x0068,0x6340);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets Description of the kind of information drawn with the pen.
	 * @param strHPGLPenDescription 
	 */
	public void setHPGLPenDescription(String strHPGLPenDescription)
	{
		/*Accept the Coding Scheme Name in String format of type ST.
		 * 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(0x0068,0x6345, strHPGLPenDescription,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0068,0x6345,DicomConstants.DCM_DT_ST, strHPGLPenDescription);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Description of the kind of information drawn with the pen.
	 * @return String value of HPGL Pen Description
	 */
	public String getHPGLPenDescription()
	{
		Object objValue = getValue(0x0068,0x6345);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
}
