/*******************************************************************************
 *  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.PerformedProcedureStepSummaryMacro;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedPerformedProcedureStepSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.RequestAttributesSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.SeriesDescriptionCodeSequence;
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.enums.EnumModality;

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 class defines the Encapsulated Document Series Attributes.
 * @author saloni
 *
 */
public class EncapsulatedDocumentSeriesModule extends Module
{
	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;



	/**
	 * Instantiates a new EncapsulatedDocumentSeriesModule
	 * 
	 * @param objIDataSet the obj i data set
	 */
	PerformedProcedureStepSummaryMacro objPerformedProcedureStepSummaryMacro=null;
	public EncapsulatedDocumentSeriesModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x0060));
		objSingleCollection.add(new Tag(0x0020, 0x000E));
		objSingleCollection.add(new Tag(0x0020,0x0011));
		objSingleCollection.add(new Tag(0x0008,0x1111));
		objSingleCollection.add(new Tag(0x0018, 0x1030));
		objSingleCollection.add(new Tag(0x0008, 0x103E));		
		objSingleCollection.add(new Tag(0x0008, 0x103F));
		objSingleCollection.add(new Tag(0x0040, 0x0275));	
	}

	/**
	 * 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 Boolean - status indicating success or failure
	 * 
	 * @throws InvalidModuleException - Throws when validation for any Module.
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{	
			if(!isPresent(0x0008,0x0060))
			{
				throw new MandatoryMissingException("Missing Mandatory DataElement 0008,0060");
			}
			if(!isPresent(0x0020, 0x000E))
			{
				throw new MandatoryMissingException("Missing Mandatory DataElement 0020,000E");
			}
			if(!isPresent(0x0020, 0x0011))
			{
				throw new MandatoryMissingException("Missing Mandatory DataElement 0020,0011");
			}
		}
		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;
	}

	/**
	 * Sets the Modality.
	 * 
	 * @param enumModality : Type of equipment that originally acquired
	 * the data used to create the images in this
	 * Series.
	 */	
	public void setModality(EnumModality enumModality)
	{
		/*Accept the Modality value 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 Hash Map
		 */
		addDataElement(0x0008, 0x0060, DicomConstants.DCM_DT_CS, enumModality.getValue());
	}
	/**
	 * Retrieves Type of equipment that originally acquired the data used to create the images in this Series.
	 * 
	 * @return String - String value of Modality.
	 */
	public String getModality()
	{
		Object objectValue = getValue(0x0008, 0x0060);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}
	
	/**
	 * Sets a Unique identifier of the Series.
	 * @param strSeriesInstanceUID String value of Unique identifier of the Series.
	 */
	public void setSeriesInstanceUID(String strSeriesInstanceUID)
	{
		/*Accept the Unique identifier of the Series. 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 Data Set
		 */
		addDataElement(0x0020, 0x000E, DicomConstants.DCM_DT_UI,strSeriesInstanceUID);
	}

	/**
	 * Retrieves a Unique identifier of the Series.
	 * @return String - value of Unique identifier of the Series.
	 */
	public String getSeriesInstanceUID()
	{
		Object objValue = getValue(0x0020, 0x000E);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets a number that identifies the Series.
	 * @param strSeriesNumber String value of number that identifies the Series.
	 */
	public void setSeriesNumber(String strSeriesNumber)
	{
		/*Accept the SeriesNumber 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 Data Set
		 */
		addDataElement(0x0020, 0x0011, DicomConstants.DCM_DT_IS,strSeriesNumber);
	}

	/**
	 * Retrieves a number that identifies the Series.
	 * @return String - value of number that identifies the Series.
	 */
	public String getSeriesNumber()
	{
		Object objValue = getValue(0x0020, 0x0011);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Returns provides the pre-initialized object of Referenced Performed Procedure Step 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 - object of Referenced Performed Procedure Step Sequence.
	 */
	public ReferencedPerformedProcedureStepSequence getReferencedPerformedProcedureStepSequence()
	{
		ReferencedPerformedProcedureStepSequence objReferencedPerformedProcedureStepSequence = (ReferencedPerformedProcedureStepSequence)getDicomValue(0x0008, 0x1111);
		if(objReferencedPerformedProcedureStepSequence == 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();
			objReferencedPerformedProcedureStepSequence = (ReferencedPerformedProcedureStepSequence)objDicomV3Factory.createSequence(0x0008, 0x1111, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x1111, DicomConstants.DCM_DT_SQ, objReferencedPerformedProcedureStepSequence.getValue());
		}
		return objReferencedPerformedProcedureStepSequence;
	}
	/**
	 * Sets Description of the conditions under which the Series was performed.
	 * @param strProtocolName String value of Protocol Name
	 */
	public void setProtocolName(String strProtocolName)
	{
		/* Accept the Protocol Name in String format 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
		 */
		addDataElement(0x0018, 0x1030, DicomConstants.DCM_DT_LO,strProtocolName);
	}

	/**
	 * Return Description of the conditions under which the Series was performed.
	 * @return String - value of Protocol Name
	 */
	public String getProtocolName()
	{
		Object objValue = getValue(0x0018, 0x1030);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Set Description of the Series
	 * @param strProtocolName String value of PSeriesDescription
	 */
	public void setSeriesDescription(String strProtocolName)
	{
		/* Accept the SeriesDescription in String format 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
		 */
		addDataElement(0x0008, 0x103E, DicomConstants.DCM_DT_LO,strProtocolName);
	}

	/**
	 * Return Description of the Series
	 * @return String - value of SeriesDescription
	 */
	public String getSeriesDescription()
	{
		Object objValue = getValue(0x0008, 0x103E);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Returns provides the pre-initialized object of Series Description Code 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 - object of RSeries Description Code Sequence
	 */
	public SeriesDescriptionCodeSequence getSeriesDescriptionCodeSequence()
	{
		SeriesDescriptionCodeSequence objSeriesDescriptionCodeSequence = (SeriesDescriptionCodeSequence)getDicomValue(0x0008, 0x103F);
		if(objSeriesDescriptionCodeSequence == 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();
			objSeriesDescriptionCodeSequence = (SeriesDescriptionCodeSequence)objDicomV3Factory.createSequence(0x0008, 0x103F, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x103F, DicomConstants.DCM_DT_SQ, objSeriesDescriptionCodeSequence.getValue());
		}
		return objSeriesDescriptionCodeSequence;
	}
	/**
	 * Returns provides the pre-initialized object of Request Attributes 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 - object of Request Attributes Sequence
	 */
	public RequestAttributesSequence getRequestAttributesSequence()
	{
		RequestAttributesSequence objRequestAttributesSequence = (RequestAttributesSequence)getDicomValue(0x0040, 0x0275);
		if(objRequestAttributesSequence == 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();
			objRequestAttributesSequence = (RequestAttributesSequence)objDicomV3Factory.createSequence(0x0040, 0x0275, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040, 0x0275, DicomConstants.DCM_DT_SQ, objRequestAttributesSequence.getValue());
		}
		return objRequestAttributesSequence;
	}

	/**
	 * Get the Instance of  Performed Procedure Step Summary Macro Attributes.
	 * @return - object of Performed Procedure Step Summary Macro Attributes which the user programmer can populate
	 */
	public PerformedProcedureStepSummaryMacro getPerformedProcedureStepSummaryMacro()
	{
		if(objPerformedProcedureStepSummaryMacro == null)
			objPerformedProcedureStepSummaryMacro = new PerformedProcedureStepSummaryMacro(objIDataSet);
		return objPerformedProcedureStepSummaryMacro; 
	}
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	/**
	 * Returns the collection of keys representing the DataElements that belong to this module.
	 * @return Collection of Tags - returns the collection of tags
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
