/*******************************************************************************
 *  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.enums.EnumLateralSpreadingDeviceType;
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 Lateral Spreading Device Sequence.
 */

public class LateralSpreadingDeviceSequenceItem extends Item
{

	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	LateralSpreadingDeviceSequenceItem()
	{
		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 with specified TransferSyntax 
	 * and default DictionaryReader.
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	LateralSpreadingDeviceSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates LateralSpreadingDeviceSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used.
	 */
	LateralSpreadingDeviceSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	/**
	 * Validates all the attributes in Lateral Spreading Device Sequence Item that are present in the DataSet
	 * @return int - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try{
			if(!contains(0x300A,0x0334))
				throw new MandatoryMissingException("300A,0334");
			if(!contains(0x300A,0x0336))
				throw new MandatoryMissingException("300A,0336");
			if(!contains(0x300A,0x0338))
				throw new MandatoryMissingException("300A,0338");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}

		return true;
	}
	
	/**
	 * Sets Lateral Spreading Device Number.
	 * @param strLateralSpreadingDeviceNumber String value of Lateral Spreading Device Number.
	 */
	public void setLateralSpreadingDeviceNumber (String strLateralSpreadingDeviceNumber )
	{
		/*Accept the Lateral Spreading Device 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(0x300A,0x0334, strLateralSpreadingDeviceNumber ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0334,DicomConstants.DCM_DT_IS, strLateralSpreadingDeviceNumber );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Lateral Spreading Device Number.
	 * @return String - value of Lateral Spreading Device Number.
	 */
	public String getLateralSpreadingDeviceNumber()
	{
		Object objValue = getValue(0x300A,0x0334);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the Lateral Spreading Device ID.
	 * @param strLateralSpreadingDeviceID
	 */
	public void setLateralSpreadingDeviceID(String strLateralSpreadingDeviceID)
	{
		/*Accept the Lateral Spreading Device ID 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(0x300A, 0x0336, strLateralSpreadingDeviceID,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x300A, 0x0336,DicomConstants.DCM_DT_SH, strLateralSpreadingDeviceID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Lateral Spreading Device ID.
	 * @return String - value of Lateral Spreading Device ID.
	 */
	public String getLateralSpreadingDeviceID()
	{
		Object objValue = getValue(0x300A, 0x0336);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Accessory Code.
	 * @param strAccessoryCode String value of Accessory Code.
	 */
	public void setAccessoryCode(String strAccessoryCode)
	{
		/* Accept the Accessory Code 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(0x300A,0x00F9, strAccessoryCode,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x00F9,DicomConstants.DCM_DT_LO, strAccessoryCode);

		addDataElement(objIDataElement);
	}

	/**
	 * Return Accessory Code.
	 * @return String - value of Accessory Code.
	 */
	public String getAccessoryCode()
	{
		Object objValue = getValue(0x300A,0x00F9);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Lateral Spreading Device Type
	 * Defined Terms:
	 * 1) SCATTERER.
	 * 2) MAGNET.
	 * @param enumLateralSpreadingDeviceType enum value of Lateral Spreading Device Type.
	 */
	public void setLateralSpreadingDeviceType(EnumLateralSpreadingDeviceType enumLateralSpreadingDeviceType)
	{
		/* Accept the Lateral Spreading Device Type 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(0x300A,0x0338, enumLateralSpreadingDeviceType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0338,DicomConstants.DCM_DT_CS, enumLateralSpreadingDeviceType.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of Lateral Spreading Device. 
	 * @return String - value of Lateral Spreading Device Type.
	 */
	public String getLateralSpreadingDeviceType()
	{
		Object objValue = getValue(0x300A,0x0338);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Lateral Spreading Device Description.
	 * @param strLateralSpreadingDeviceDescription String value of LateralSpreadingDeviceDescription.
	 */
	public void setLateralSpreadingDeviceDescription(String strLateralSpreadingDeviceDescription)
	{
		/* Accept the Lateral Spreading Device Description 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(0x300A,0x033A, strLateralSpreadingDeviceDescription,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x033A,DicomConstants.DCM_DT_LO, strLateralSpreadingDeviceDescription);

		addDataElement(objIDataElement);
	}

	/**
	 * Return Lateral Spreading Device Description.
	 * @return String - value of Lateral Spreading Device Description.
	 */
	public String getLateralSpreadingDeviceDescription()
	{
		Object objValue = getValue(0x300A,0x033A);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

}
