/*******************************************************************************
 *  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.dicommodel.modules;



import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedSeriesSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;

import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
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;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.SingleCollection;

/**
 \* This module describes the attributes in Study Content Module.
 */
public class StudyContentModule extends Module
{


	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;

	/**
	 * Creates Imaging Service Request Module with default initialization.
	 * @param objIDataSet the obj i data set
	 */
	public StudyContentModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0020,0x0010));
		objSingleCollection.add(new Tag(0x0020,0x000D));
		objSingleCollection.add(new Tag(0x0008,0x1115));
	}

	/**
	 * This method validates each Attribute in the Module according to the Type
	 * of the Attribute.Attributes are of 5 types.
	 * Type 1,Type 2 are Mandatory:
	 * Mandatory Attributes have to present in the Module.
	 * Type 1C,2C are Conditional:
	 * Conditional Attributes' presence depend on a condition.
	 * If the condition is satisfied the Attribute has to be present.
	 * Type 3 are Optional
	 * Optional Attributes can be added as and when required.
	 * @return true, if validate module
	 * @throws InvalidModuleException - If validation of Module fails
	 */
	public boolean validateModule()throws InvalidModuleException
	{

		try
		{			
			if(!isPresent(0x0010,0x0010))
				throw new MandatoryMissingException("0020,0010");
			if(!isPresent(0x0010,0x0020))
				throw new MandatoryMissingException("0020,000D");
			if(!isPresent(0x0010,0x0020))
				throw new MandatoryMissingException("0008,1115");
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

			
				throw new InvalidModuleException(this.getClass().getSimpleName(),mme);
		}
		catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(cfe.getMessage());

			
				throw new InvalidModuleException(this.getClass().getSimpleName(),cfe);
		}
		return true;
	}

	/**
	 * This method returns the vector of keys representing the DataElements
	 * that belong to this module.
	 * @return vector of Tags - returns the vector containing the collection of tags
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}

	/**
	 * Sets User or equipment generated Study identifier.
	 * @param strStudyID string value of Study ID
	 */
	public void setStudyID(String strStudyID)
	{
		/*Accept User or equipment generated Study identifier in String format 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 Hash Map
		 * 0x0008, 0x1062
		 */
		addDataElement(0x0020, 0x0010, DicomConstants.DCM_DT_SH, strStudyID);
	}

	/**
	 * Retrieves Study ID.
	 * @return String - Study ID.
	 */
	public String getStudyID()
	{
		Object objValue = getValue(0x0020,0x0010);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Unique identifier for the Study.
	 * @param strStudyInstanceUID string value of Study Instance UID.
	 */
	public void setStudyInstanceUID(String strStudyInstanceUID)
	{
		/* Accept Unique identifier for the Study in String format of type UI.
		 * 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 Hash Map
		 */
		addDataElement(0x0020, 0x000D, DicomConstants.DCM_DT_UI, strStudyInstanceUID);
	}

	/**
	 * Retrieves Study Instance UID.
	 * @return String - Study Instance UID.
	 */
	public String getStudyInstanceUID()
	{
		Object objValue = getValue(0x0020,0x000D);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sequence of Repeating Items where each Item includes the Attributes of a
	 * Series. Zero or more Items may be included in this Sequence.
	 * @return ReferencedSeriesSequence - instance of Referenced Reference Image Sequence.
	 */
	public ReferencedSeriesSequence getReferencedSeriesSequence()
	{
		ReferencedSeriesSequence objReferencedSeriesSequence = (ReferencedSeriesSequence)getDicomValue(0x0008,0x1115);
		if(objReferencedSeriesSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objReferencedSeriesSequence = (ReferencedSeriesSequence)objDicomV3Factory.createSequence(0x0008,0x1115, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008,0x1115, DicomConstants.DCM_DT_SQ, objReferencedSeriesSequence.getValue());
		}
		return objReferencedSeriesSequence;
	}
}