/*******************************************************************************
 *  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.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 specifies attributes that identify a Series in the context  of a clinical trial.
 */
public class ClinicalTrialSeriesModule extends Module  
{


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


	/**
	 * Creates Clinical Trial Series Module with default initialization.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public ClinicalTrialSeriesModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0012,0x0060));
		objSingleCollection.add(new Tag(0x0012,0x0071));
		objSingleCollection.add(new Tag(0x0012,0x0072));
	}

	/**
	 * 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
		{			/*
		 * Validation Rules for Mandatory Elements
		 */
			if(!isPresent(0x0012,0x0060))
				throw new MandatoryMissingException("0012,0060");
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		return true;
	}

	/**
	 * The method is used to set The name of the institution that is responsible
	 * for coordinating the medical imaging data for the clinical trial.
	 * DE based on the transfer syntax and populates the DE with right values.
	 * This De is then added to the Module HashMap
	 * 
	 * @param strClinicalTrialCooradinatingCenterName The name of the clinical trial protocol.
	 */
	public void setClinicalTrialCooradinatingCenterName(String strClinicalTrialCooradinatingCenterName)
	{
		/* Accept The name of the institution that is responsible for coordinating 
		 * the medical imaging data for the clinical trial 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 Hash Map
		 */
		addDataElement(0x0012, 0x0060, DicomConstants.DCM_DT_LO, strClinicalTrialCooradinatingCenterName);
	}

	/**
	 * Retrieves the name of the institution that is responsible
	 * for coordinating the medical imaging data for the clinical trial.
	 * 
	 * @return String - name of the Clinical Trial Coordinating Center Name
	 */
	public String getClinicalTrialCooradinatingCenterName()
	{
		Object objValue = getValue(0x0012,0x0060);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Clinical Trial Series ID.
	 * An identifier of the series in the context of a clinical trial.
	 * @param strClinicalTrialSeriesID String value of Clinical Trial Series ID.
	 */
	public void setClinicalTrialSeriesID(String strClinicalTrialSeriesID)
	{
		/* Accept Clinical Trial Series ID 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 Hash Map
		 */
		addDataElement(0x0012, 0x0071, DicomConstants.DCM_DT_LO, strClinicalTrialSeriesID);
	}

	/**
	 * Retrieves Clinical Trial Series ID.
	 * An identifier of the series in the context of a clinical trial.
	 * @return String - String value of Clinical Trial Series ID.
	 */
	public String getClinicalTrialSeriesID()
	{
		Object objValue = getValue(0x0012,0x0071);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Clinical Trial Series Description.
	 * A description of the series in the context of a clinical trial.
	 * @param strClinicalTrialSeriesDescription String value of Clinical Trial Series Description.
	 */
	public void setClinicalTrialSeriesDescription(String strClinicalTrialSeriesDescription)
	{
		/* Accept Clinical Trial Series Description 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 Hash Map
		 */
		addDataElement(0x0012, 0x0072, DicomConstants.DCM_DT_LO, strClinicalTrialSeriesDescription);
	}

	/**
	 * Retrieves Clinical Trial Series Description.
	 * A description of the series in the context of a clinical trial.
	 * @return String - String value of Clinical Trial Series Description.
	 */
	public String getClinicalTrialSeriesDescription()
	{
		Object objValue = getValue(0x0012,0x0072);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

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


}
