/*******************************************************************************
 *  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.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
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 Recorded Channel Shield Sequence.
 */
public class RecordedChannelShieldSequenceItem extends Item  
{
	

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

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	RecordedChannelShieldSequenceItem()
	{
		super();
	}

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

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

	/**
	 * Sets Identification number of the Channel Shield.
	 * @param strReferencedChannelShieldNumber String value of Referenced Channel Shield Number.
	 */
	public void setReferencedChannelShieldNumber(String strReferencedChannelShieldNumber)
	{
		/* Accept the Referenced Channel Shield Number 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(0x3008,0x0152,strReferencedChannelShieldNumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0152,DicomConstants.DCM_DT_IS, strReferencedChannelShieldNumber);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Identification number of the Channel Shield.
	 * @return String - value of Identification number of the Channel Shield. 
	 */
	public String getReferencedChannelShieldNumber()
	{
		Object objValue = getValue(0x3008,0x0152);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets User or machine supplied identifier for Channel Shield.
	 * @param strChannelShieldID String value of Channel Shield ID.
	 */
	public void setChannelShieldID(String strChannelShieldID)
	{
		/* Accept the Channel Shield ID 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,0x02B3,strChannelShieldID,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x02B3,DicomConstants.DCM_DT_SH, strChannelShieldID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves User or machine supplied identifier for Channel Shield.
	 * @return String - value of Channel Shield ID.
	 */
	public String getChannelShieldID()
	{
		Object objValue = getValue(0x300A,0x02B3);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets User-defined name for Channel Shield.
	 * @param strChannelShieldName String value of User-defined name for Channel Shield.
	 */
	public void setChannelShieldName(String strChannelShieldName)
	{
		/* Accept the Channel Shield Name 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,0x02B4,strChannelShieldName,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x02B4,DicomConstants.DCM_DT_LO, strChannelShieldName);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves User-defined name for Channel Shield.
	 * @return String - value of User-defined name for Channel Shield.
	 */
	public String getChannelShieldName()
	{
		Object objValue = getValue(0x300A,0x02B4);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Validates all the attributes in {@link RecordedChannelShieldSequenceItem} 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(0x3008,0x0152))
				throw new ConditionFailedException("3008,0152");
			if(!contains(0x300A,0x02B3))
				throw new ConditionFailedException("300A,02B3");
		}
		catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(cfe.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),cfe);
		}
		return true;
	}
}
