/*******************************************************************************
 *  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 Graphic Group Sequence .
 */

public class GraphicGroupSequenceItem extends Item {



	private static final long serialVersionUID = 1L;
	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	GraphicGroupSequenceItem()
	{
		super();
	}


	/**
	 * This constructor creates the item and internal code sequence macro with specified TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	GraphicGroupSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{	
			if(!contains(0x0070,0x0295))
				throw new MandatoryMissingException("0070,0295") ;
			if(!contains(0x0070,0x0207))
				throw new MandatoryMissingException("0070,0207") ;
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	
	/**
	 * Sets Graphic Group ID
	 * @param iGraphicGroupID long value of Graphic Group ID.
	 */
	public void setGraphicGroupID(int iGraphicGroupID)
	{
		/* Accept the Graphic Group ID of type UL.
		 * A unique number identifying the Graphic Group
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)	
			objIDataElement = new ImplicitDE(0x0070,0x0295, iGraphicGroupID,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0070,0x0295,DicomConstants.DCM_DT_UL, iGraphicGroupID);
		//Add the DataElement to the Item
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Graphic Group ID.
	 * @return long - value of Graphic Group ID.
	 */
	public int getGraphicGroupID()
	{
		Object objValue = getValue(0x0070,0x0295);
		if(objValue != null)
			return Integer.parseInt(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	 * Sets Graphic Group Label.
	 * @param strGraphicGroupLabel String value of Graphic Group Label.
	 */
	public void setGraphicGroupLabel(String strGraphicGroupLabel)
	{
		/* Accept the strGraphicGroupLabel in String format of type LO.
		 * It is Name used to identify the Graphic Group Label
		 * 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(0x0070,0x0207, strGraphicGroupLabel,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0070,0x0207,DicomConstants.DCM_DT_LO, strGraphicGroupLabel);

		addDataElement(objIDataElement);
	}

	/**
	 * Return user-defined label identifier for Graphic Group Label Type.
	 * @return String - value of strGraphicGroupLabel.
	 */
	public String getGraphicGroupLabel()
	{
		Object objValue = getValue(0x0070,0x0207);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the Graphic Group Description
	 * @param strGraphicGroupDescription value
	 */
	public void setGraphicGroupDescription(String strGraphicGroupDescription)
	{
		/*Accept the strGraphicGroupDescription in String format of type ST.
		 *It is Description of the group.
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0070,0x0208, strGraphicGroupDescription,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0070,0x0208,DicomConstants.DCM_DT_ST, strGraphicGroupDescription);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves the Graphic Group Description
	 * @return String value of strGraphicGroupDescription.
	 */
	public String getGraphicGroupDescription()
	{
		Object objValue = getValue(0x0070,0x0208);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

}
