/*******************************************************************************
 *  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.ContentIdentificationMacro;
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.InvalidMacroException;
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 specifies the attributes of Presentation State Identification Module.
 */
public class PresentationStateIdentificationModule extends Module  
{
	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;


	/**
	 * The obj Content Identification Macro.
	 */
	ContentIdentificationMacro objContentIdentificationMacro = null;
	
	/**
	 * Instantiates a new presentation state module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public PresentationStateIdentificationModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0070,0x0082));
		objSingleCollection.add(new Tag(0x0070,0x0083));
	}

	/**
	 * 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
		{
			getContentIdentificationMacro().validate();
			
			if(!isPresent(0x0070,0x0082))
				throw new MandatoryMissingException("0070,0082");
			if(!isPresent(0x0070,0x0083))
				throw new MandatoryMissingException("0070,0083");
			
		}
		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);

		}
		catch(InvalidMacroException ve)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(ve.getMessage());

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

		}
		return true;
	}
	
	/**
	 * Get the Instance of Content Identification Macro.Attributes related to Content Identification Macro will be set in Macro
	 * using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco
	 * Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was
	 * set in the last call to its setter method.
	 * 
	 * @return - object of Content Identification Macro
	 */
	public ContentIdentificationMacro getContentIdentificationMacro()
	{
		if(objContentIdentificationMacro == null)
			objContentIdentificationMacro = new ContentIdentificationMacro(objIDataSet);
		return objContentIdentificationMacro; 
	}


	/**
	 * Sets Date on which this presentation was created.
	 * 
	 * @param strPresentationCreationDate String value of Date on which this presentation was created.
	 */
	public void setPresentationCreationDate(String strPresentationCreationDate)
	{
		/* Accept Presentation Creation Date 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 Data Set
		 */
		addDataElement(0x0070, 0x0082, DicomConstants.DCM_DT_DA, strPresentationCreationDate);
	}

	/**
	 * Retrieves Date on which this presentation was created.
	 * 
	 * @return String - String value of Date on which this presentation was created.
	 */
	public String getPresentationCreationDate()
	{
		Object objValue = objIDataSet.getValue(0x0070, 0x0082);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Time on which this presentation was created.
	 * 
	 * @param strPresentationCreationTime String value of Time on which this presentation was created.
	 */
	public void setPresentationCreationTime(String strPresentationCreationTime)
	{
		/* Accept Presentation Creation Time 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 Data Set
		 */
		addDataElement(0x0070, 0x0083, DicomConstants.DCM_DT_TM, strPresentationCreationTime);
	}

	/**
	 * Retrieves Time on which this presentation was created.
	 * 
	 * @return String - String value of Time on which this presentation was created.
	 */
	public String getPresentationCreationTime()
	{
		Object objValue = objIDataSet.getValue(0x0070, 0x0083);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

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