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

public class PlanningLandmarkLineSequenceItem extends PlanningLandmarkLineMacroDependentItem
{
	


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

	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	PlanningLandmarkLineSequenceItem()
	{
		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
	 */
	PlanningLandmarkLineSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	/*
	 * (non-Javadoc) This method validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in PlanningLandmarkLineSequenceItem 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,0x6530))
				throw new MandatoryMissingException("0068,6530");
			if(!contains(0x0068,0x6545))
				throw new MandatoryMissingException("0068,6545");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	
	/**
	 * Sets Planning Landmark ID.
	 * Numeric ID of the planning landmark.
	 * @param shPlanningLandmarkID short value of Planning Landmark ID
	 */
	public void setPlanningLandmarkID(short shPlanningLandmarkID)
	{
		/* Accept the Planning Landmark ID 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,0x6530,shPlanningLandmarkID,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0068,0x6530,DicomConstants.DCM_DT_US, shPlanningLandmarkID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Planning Landmark ID.
	 * Numeric ID of the planning landmark.
	 * @return short - short value of Planning Landmark ID
	 */
	public short getPlanningLandmarkID()
	{
		Object objValue = getValue(0x0068,0x6530);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	 * Sets Planning Landmark Description.
	 * Purpose or intended use of the landmark.
	 * @param strPlanningLandmarkDescription String value of Planning Landmark Description.
	 */
	public void setPlanningLandmarkDescription(String strPlanningLandmarkDescription)
	{
		/* Accept the Planning Landmark 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(0x0068,0x6540, strPlanningLandmarkDescription,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0068,0x6540,DicomConstants.DCM_DT_LO, strPlanningLandmarkDescription);

		addDataElement(objIDataElement);
	}

	/**
	 * Return Planning Landmark Description.
	 * Purpose or intended use of the landmark.
	 * @return String - value of Planning Landmark Description.
	 */
	public String getPlanningLandmarkDescription()
	{
		Object objValue = getValue(0x0068,0x6540);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Retrieves pre-initialized object of Planning Landmark Identification Code 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 PlanningLandmarkIdentificationCodeSequence - instance of PlanningLandmarkIdentificationCodeSequence. 
	 */
	public PlanningLandmarkIdentificationCodeSequence getPlanningLandmarkIdentificationCodeSequence()
	{
		PlanningLandmarkIdentificationCodeSequence objPlanningLandmarkIdentificationCodeSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0068, 0x6545); 
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objPlanningLandmarkIdentificationCodeSequence = (PlanningLandmarkIdentificationCodeSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objPlanningLandmarkIdentificationCodeSequence = (PlanningLandmarkIdentificationCodeSequence)objDicomV3Factory.createSequence(0x0068, 0x6545, objITransferSyntax, objIDictionaryReader);

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

}
