/*******************************************************************************
 *  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.InvalidMacroException;
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 methods to set,get and validate the attributes in Referenced Waveform Sequence.
 */
public class ReferencedWaveformSequenceItem extends Item  
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	HierarchicalSOPInstanceReferenceMacro objHierarchicalSOPInstanceReferenceMacro = null;;

	/**
	 * This constructor creates the item and internal HierarchicalSOPInstanceReference Macro with default TransferSyntax 
	 */
	ReferencedWaveformSequenceItem()
	{
		super();
		objHierarchicalSOPInstanceReferenceMacro = new HierarchicalSOPInstanceReferenceMacro(this);
	}

	/**
	 * This constructor creates the item and internal HierarchicalSOPInstanceReference Macro with default TransferSyntax.
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax. 
	 */
	ReferencedWaveformSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
		objHierarchicalSOPInstanceReferenceMacro = new HierarchicalSOPInstanceReferenceMacro(this);
	}

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

	/**
	 * Retrieves instance of HierarchicalSOPInstanceReferenceMacro.
	 * @return - instance of HierarchicalSOPInstanceReferenceMacro.
	 */
	public HierarchicalSOPInstanceReferenceMacro getHierarchicalSOPInstanceReferenceMacro()
	{
		return objHierarchicalSOPInstanceReferenceMacro;
	}

	/**
	 * Validates all the attributes in ReferencedWaveformSequenceItem 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
		{
			objHierarchicalSOPInstanceReferenceMacro.validate();
			if(!contains(0x0040,0xA170))
				throw new MandatoryMissingException("0040,A170");
			else
				getPurposeOfReferenceCodeSequence().validateForModule();
		}
		catch( InvalidMacroException ime)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ime.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ime);
		}
		return true;
	}

	/**
	 * Retrieves pre-initialized object of PurposeOfReferenceCodeSequence.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 PurposeOfReferenceCodeSequence - instance of PurposeOfReferenceCodeSequence. 
	 */
	public PurposeOfReferenceCodeSequence getPurposeOfReferenceCodeSequence()
	{
		PurposeOfReferenceCodeSequence objPurposeOfReferenceCodeSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0040, 0xA170);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objPurposeOfReferenceCodeSequence = (PurposeOfReferenceCodeSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objPurposeOfReferenceCodeSequence = (PurposeOfReferenceCodeSequence)objDicomV3Factory.createSequence(0x0040, 0xA170, objITransferSyntax, objIDictionaryReader);

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