/*******************************************************************************
 *  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.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 methods to validate, set and get the attributes of US Image Description Sequence{@link USImageDescriptionSequence}.
 */

public class USImageDescriptionSequenceItem extends Item
{
	

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

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

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

	/*
	 * (non-Javadoc) This mathod validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in USImageDescriptionSequenceItem 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(0x0008,0x9007))
				throw new MandatoryMissingException("0008,9007");
			if(!contains(0x0008,0x9206))
				throw new MandatoryMissingException("0008,9206");
			if(!contains(0x0008,0x9207))
				throw new MandatoryMissingException("0008,9207");
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}

	/**
	 * Sets Type of Frame. A multi-valued attribute analogous to Image Type.
	 * @param strFrameType String Value of Type of Frame. A multi-valued attribute analogous to Image Type.
	 */
	public void setFrameType(String strFrameType)
	{
		/*Accept the Frame 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(0x0008, 0x9007, strFrameType,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008, 0x9007,DicomConstants.DCM_DT_CS, strFrameType);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Type of Frame. A multi-valued attribute analogous to Image Type
	 * @return String Array -  Value of Type of Frame. A multi-valued attribute analogous to Image Type.
	 */
	public String[] getFrameType()
	{
		if(getDataForTag(0x0008, 0x9007)!=null)
		{
			if(getDataForTag(0x0008, 0x9007).getValue()!=null)
			{
				Object objValue = getDataForTag(0x0008, 0x9007).getValue();
				if(objValue!=null)
				{
					if(objValue instanceof String)
					{
						String strTemp = (String)objValue;
						String[] strArr = new String[1];
						strArr[0] = strTemp;
						return strArr;
					}
					else
						return (String[])objValue;
				}
			}
		}
		return null;
	}
	/**
	 * Sets the Indication if geometric manipulations are possible with frames in theSOP Instance.
	 * @param strVolumetricProperties Specifies type of the value encoded in this Item
	 */
	public void setVolumetricProperties(String strVolumetricProperties)
	{
		/*Accept the Volumetric Properties 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(0x0008, 0x9206, strVolumetricProperties,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008, 0x9206,DicomConstants.DCM_DT_CS, strVolumetricProperties);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Indication if geometric manipulations are possible with frames in theSOP Instance.
	 * @return String - Type of the value encoded in this Item
	 */
	public String getVolumetricProperties()
	{
		Object objValue = getValue(0x0008, 0x9206);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the Method used for volume calculations with frames in the SOP Instance.
	 * @param strVolumeBasedCalculationTechnique Specifies type of the value encoded in this Item
	 */
	public void setVolumeBasedCalculationTechnique(String strVolumeBasedCalculationTechnique)
	{
		/*Accept the Volume Based Calculation Technique 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(0x0008, 0x9207, strVolumeBasedCalculationTechnique,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0008, 0x9207,DicomConstants.DCM_DT_CS, strVolumeBasedCalculationTechnique);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Method used for volume calculations with frames in the SOP Instance.
	 * @return String - Type of the value encoded in this Item
	 */
	public String getVolumeBasedCalculationTechnique()
	{
		Object objValue = getValue(0x0008, 0x9207);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
}
