/*******************************************************************************
 *  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.utils.DicomConfig;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.DicomLogger;




/**
 * This item provides set and get functions for attributes that describe any multiplexed audio channels.
 */
public class MultiplexedAudioChannelsDescriptionCodeSequenceItem extends Item  
{
	

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

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

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

	/*
	 * Added exception handling code
	 */
	/*
	 * (non-Javadoc) This mathod validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in MultiplexedAudioChannelsDescriptionCodeSequenceItem 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(0x003A,0x0301))
				throw new MandatoryMissingException("003A,0301");
			if(!contains(0x003A,0x0302))
				throw new MandatoryMissingException("003A,0302");
			if(!contains(0x003A,0x0208))
				throw new MandatoryMissingException("003A,0208");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		return true;
	}

	/**
	 * Sets a reference to the audio channel as identified within Transfer Syntax encoded
	 * bit stream (1 for the main channel, 2 for the second channel and 3 to 9 to the
	 * complementary channels).
	 * @param strChannelIdentificationCode String value of Channel Identification Code.
	 */
	public void setChannelIdentificationCode(String strChannelIdentificationCode)
	{
		/*Accept the Channel Identification Code 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(0x003A, 0x0301, strChannelIdentificationCode,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x003A, 0x0301,DicomConstants.DCM_DT_IS, strChannelIdentificationCode);
//		Add the DataElement to the Item
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves a reference to the audio channel as identified within Transfer Syntax encoded
	 * bit stream.
	 * @return String - value of Channel Identification Code.
	 */
	public String getChannelIdentificationCode()
	{
		Object objValue = getValue(0x003A, 0x0301);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets a coded descriptor qualifying the mode of the channel:Enumerated Values:MONO = 1 signal,
	 * STEREO = 2 simultaneously acquired (left and right) signals.
	 * @param strChannelMode String value of Channel Mode.
	 */
	public void setChannelMode(String strChannelMode)
	{
		/*Accept the Channel Mode 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(0x003A, 0x0302, strChannelMode,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x003A, 0x0302,DicomConstants.DCM_DT_CS, strChannelMode);
//		Add the DataElement to the Item
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves a coded descriptor qualifying the mode of the channel.
	 * @return String - value of Channel Mode.
	 */
	public String getChannelMode()
	{
		Object objValue = getValue(0x003A, 0x0302);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Retrieves pre-initialized object of Channel Source 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 ChannelSourceSequence - instance of ChannelSourceSequence. 
	 */
	public ChannelSourceSequence getChannelSourceSequence()
	{
		ChannelSourceSequence objChannelSourceSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x003A,0x0303);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objChannelSourceSequence = (ChannelSourceSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objChannelSourceSequence = (ChannelSourceSequence)objDicomV3Factory.createSequence(0x003A,0x0303, objITransferSyntax, objIDictionaryReader);

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

}
