/*******************************************************************************
 *  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.Tag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.SingleCollection;

// TODO: Auto-generated Javadoc
/**
 \* This module defines the Attributes relevant to the result's impressions.
 */

public class ResultsImpressionModule extends Module 
{

	
	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;
	
	/**
	 * Instantiates a new results impression module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public ResultsImpressionModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}
	
	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x4008,0x0300));
		objSingleCollection.add(new Tag(0x4008,0x4000));
	}
	
	/* Added by AD on 14/08/07,
	 * For normalized IODs, the type(Mandatory/Optional) of a Module depends upon the
	 * Requirement Type which defines if this module is required by a SCP class or an
	 * SCP class. Hence,the validation of Modules in a Normalized IOD totally depends 
	 * upon the decision that the is it an SCU/SCP that needs the module.Also, Type of the Modules
	 * describes the type of the Attributes inside the Module. Ex: Mandatory Modules contain Attributes that are
	   included in all SOP Instances employing this IOD.
	 * Decision on implementation of this kind of validation is yet to be done. Hence,
	 * i am putting a empty validate 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 - If validation of Module fails
	 */
	public boolean validateModule()throws InvalidModuleException
	{
		return true;
	}
	
	/**
	 * Sets Impressions that summmarize the full results.
	 * 
	 * @param strImpressions - String value of Short impressions summarizing the full results
	 */
	public void setImpressions(String strImpressions)
	{
		/*Accept Impressions in String format of type ST.
		 * 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(0x4008,0x0300, DicomConstants.DCM_DT_ST, strImpressions);
	}
	
	/**
	 * Retrieves Impressions that summmarize the full results.
	 * 
	 * @return String - String value of Impressions.
	 */
	public String getImpressions()
	{Object objectValue = getValue(0x4008,0x0300);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}
		
	/**
	 * Sets the User-defined comments about the results.
	 * 
	 * @param strResultsComments - String value of User-defined comments.
	 */
	public void setResultsComments(String strResultsComments)
	{
		/*Accept Results Comments in String format of type ST.
		 * 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(0x4008,0x4000, DicomConstants.DCM_DT_ST, strResultsComments);
	}
	
	/**
	 * Retrieves User Defined Comments about the Results.
	 * 
	 * @return String - String value of User Defined Comments.
	 */
	public String getResultsComments()
	{Object objectValue = getValue(0x4008,0x4000);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}
	
	/* 
	 * This method is used by the Module Iterator to iterate through the DataSet and return only
	 * those elements that belong to the respective Module class whose getVectorOfKeys is called.
	 */
	/**
	 * 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;
	}
}
