/*******************************************************************************
 *  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.ReferencedPerformedProcedureStepSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.SeriesDescriptionCodeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataElement;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDicomValue;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumModality;

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;

// TODO: Auto-generated Javadoc
/**
 \* This module contains Attributes of the Key Object Document Series Module.
 */
public class KeyObjectDocumentSeriesModule extends Module  
{


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


	/**
	 * Instantiates a new key object document series module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public KeyObjectDocumentSeriesModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

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

	/**
	 * 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 - returns validation status as success or failure
	 * 
	 * @throws InvalidModuleException If validation of Module fails
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{
			if(!isPresent(0x0008,0x0060))
				throw new MandatoryMissingException("0008,0060");
			if(!isPresent(0x0020,0x000E))
				throw new MandatoryMissingException("0020,000E");
			if(!isPresent(0x0020,0x0011))
				throw new MandatoryMissingException("0020,0011");
			if(!isPresent(0x0008,0x1111))
				throw new MandatoryMissingException("0008,1111");
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

			
				throw new InvalidModuleException(this.getClass().getSimpleName(),mme);

		}
		return true;
	}

	/**
	 * Sets the Type of equipment that originally acquired the data.
	 * 
	 * @param enumModality Enum value of the Type of equipment
	 */
	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 the Type of equipment that originally acquired the data.
	 * 
	 * @return String - String value of the Type of equipment
	 */
	public String getModality()
	{
		if (objIDataSet == null)
			return null;
		IDataElement objIDataElement =  objIDataSet.getDataForTag(0x0008,0x0060);
		if(objIDataElement == null)
			return null;
		IDicomValue objIDicomValue = objIDataElement.getDicomValue();
		if(objIDicomValue == null)
			return null;
		if(objIDicomValue.getValue()==null)
			return null;
		return objIDicomValue.getValue().toString();
	}

	/**
	 * Sets the Unique identifier of the Series.
	 * 
	 * @param strSeriesInstanceUID String value of number that identifies this Series
	 */
	public void setSeriesInstanceUID(String strSeriesInstanceUID)
	{
		/*Accept the Series Instance UID value 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, 0x000E, DicomConstants.DCM_DT_UI, strSeriesInstanceUID);
	}

	/**
	 * Retrieves the Unique identifier of the Series.
	 * 
	 * @return String - String value of a number that identifies this Series.
	 */
	public String getSeriesInstanceUID()
	{
		if (objIDataSet == null)
			return null;
		IDataElement objIDataElement =  objIDataSet.getDataForTag(0x0020,0x000E);
		if(objIDataElement == null)
			return null;
		IDicomValue objIDicomValue = objIDataElement.getDicomValue();
		if(objIDicomValue == null)
			return null;
		if(objIDicomValue.getValue()==null)
			return null;
		return objIDicomValue.getValue().toString();
	}

	/**
	 * Sets A number that identifies the Series.
	 * 
	 * @param strSeriesNumber the str series number
	 */
	public void setSeriesNumber(String strSeriesNumber)
	{
		/*Accept the Series Number value 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 Hash Map
		 */
		addDataElement(0x0020, 0x0011, DicomConstants.DCM_DT_IS, strSeriesNumber);
	}

	/**
	 * Retrieves A number that identifies the Series.
	 * 
	 * @return String - String value of a number that identifies this Series.
	 */
	public String getSeriesNumber()
	{
		if (objIDataSet == null)
			return null;
		IDataElement objIDataElement =  objIDataSet.getDataForTag(0x0020,0x0011);
		if(objIDataElement == null)
			return null;
		IDicomValue objIDicomValue = objIDataElement.getDicomValue();
		if(objIDicomValue == null)
			return null;
		if(objIDicomValue.getValue()==null)
			return null;
		return objIDicomValue.getValue().toString();
	}
	
	/**
	 * Sets the series date.
	 * 
	 * @param strSeriesDate : Date the Series started.
	 */	
	public void setSeriesDate(String strSeriesDate)
	{
		/*Accept the Series Date value in String format of type DA.
		 * 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, 0x0021, DicomConstants.DCM_DT_DA, strSeriesDate);
	}

	/**
	 * Retrieves Series Date.
	 * 
	 * @return String - String value of SeriesDate
	 */
	public String getSeriesDate()
	{
		Object objValue = objIDataSet.getValue(0x0008, 0x0021);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the series time.
	 * 
	 * @param strSeriesTime : Time the Series started.
	 * 
	 */	
	public void setSeriesTime(String strSeriesTime)
	{
		/*Accept the Series Time value in String format of type TM.
		 * 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, 0x0031, DicomConstants.DCM_DT_TM, strSeriesTime);
	}

	/**
	 * Retrieves Series Time.
	 * 
	 * @return String - String value of Series Time.
	 */
	public String getSeriesTime()
	{
		Object objValue = objIDataSet.getValue(0x0008, 0x0031);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the protocol name.
	 * 
	 * @param strProtocolName : User-defined description of the conditions
	 * under which the Series was performed.
	 */
	public void setProtocolName(String strProtocolName)
	{
		/*Accept the Protocol Name value 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 Module Hash Map
		 */
		addDataElement(0x0018, 0x1030, DicomConstants.DCM_DT_LO, strProtocolName);
	}

	/**
	 * Retrieves Protocol Name.
	 * 
	 * @return String - String value of Protocol Name.
	 */
	public String getProtocolName()
	{
		Object objValue = objIDataSet.getValue(0x0018, 0x1030);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the series description.
	 * 
	 * @param strSeriesDescription : User provided description of the Series
	 */
	public void setSeriesDescription(String strSeriesDescription)
	{
		/*Accept the Series Description value 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 Module Hash Map
		 */
		addDataElement(0x0008, 0x103E, DicomConstants.DCM_DT_LO, strSeriesDescription);
	}

	/**
	 * Retrieves Series Description.
	 * 
	 * @return String - String value of SeriesDescription.
	 */
	public String getSeriesDescription()
	{
		Object objValue = objIDataSet.getValue(0x0008, 0x103E);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * This method provides the pre-initialized object of Series Description Code Sequence.
	 * 
	 * @return - 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
	 */
	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;
	}

	/**
	 * Retrieves pre-initialized object of ReferencedPerformedProcedureStepSequence.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 ReferencedPerformedProcedureStepSequence - instance of ReferencedPerformedProcedureStepSequence.
	 */
	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;
	}

	/**
	 * 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;
	}
}
