/*******************************************************************************
 *  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.ReferencedCurveSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedImageSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedOverlaySequence;
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
/*
 * Modified by PB on 8/8/07
 * The module holds its map of data in a collection wrapper called SingleCollection
 */
/**
 \* This module contains Attributes that identify an independent Curve; i.e. a Curve
 * which is handled as a separate information entity.
 * 
 * 
 */
public class CurveIdentificationModule extends Module 
{


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


	/**
	 * Instantiates a new curve identification module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public CurveIdentificationModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();

		objSingleCollection.add(new Tag(0x0020,0x0024));
		objSingleCollection.add(new Tag(0x0008,0x0025));
		objSingleCollection.add(new Tag(0x0008,0x0035));
		objSingleCollection.add(new Tag(0x0008,0x1140));
		objSingleCollection.add(new Tag(0x0008,0x1130));
		objSingleCollection.add(new Tag(0x0008,0x1145));
	}

	/*
	 * Modified by AD on 20/08/07
	 */
	/**
	 * 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(0x0020,0x0024))
				throw new MandatoryMissingException("Missing Mandatory Element 0x0020,0x0024");
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		return true;
	}

	/**
	 * A number that identifies this Curve.
	 * 
	 * @param strCurveNumber - the curve number
	 */
	public void setCurveNumber(String strCurveNumber)
	{
		/*Accept Curve Number 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, 0x0024, DicomConstants.DCM_DT_IS, strCurveNumber);
	}

	/**
	 * The date the Curve was created.
	 * 
	 * @param strCurveDate - the date of the curve
	 */
	public void setCurveDate(String strCurveDate)
	{
		/*Accept Curve 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 Hash Map
		 */
		addDataElement(0x0008, 0x0025, DicomConstants.DCM_DT_DA, strCurveDate);
	}

	/**
	 * The time the Curve was created.
	 * 
	 * @param strCurveTime - the time of the curve
	 */
	public void setCurveTime(String strCurveTime)
	{
		/*Accept Curve 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 Hash Map
		 */
		addDataElement(0x0008, 0x0035, DicomConstants.DCM_DT_TM, strCurveTime);
	}

	/**
	 * Returns number that identifies this Curve.
	 * 
	 * @return - the number of the curve
	 */
	public String getCurveNumber()
	{
		Object objectValue = getValue(0x0020, 0x0024);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Returns The date the Curve was created.
	 * 
	 * @return - the date of the curve
	 */
	public String getCurveDate()
	{
		Object objectValue = getValue(0x0008, 0x0025);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * The time the Curve was created.
	 * 
	 * @return - the tinme of the curve
	 */
	public String getCurveTime()
	{
		Object objectValue = getValue(0x0008, 0x0035);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Returns Sequence that Uniquely identifies the images significantly related to this Curve.
	 * 
	 * @return - the referenced image sequence
	 */
	public ReferencedImageSequence getReferencedImageSequence()
	{
		ReferencedImageSequence objReferencedImageSequence = (ReferencedImageSequence)getDicomValue(0x0008, 0x1140);
		if(objReferencedImageSequence == 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();
			objReferencedImageSequence = (ReferencedImageSequence)objDicomV3Factory.createSequence(0x0008, 0x1140, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x1140, DicomConstants.DCM_DT_SQ, objReferencedImageSequence.getValue());
		}
		return objReferencedImageSequence;
	}

	/**
	 * Returns Sequence that Uniquely identifies Overlays significantly related to
	 * this Curve.
	 * 
	 * @return - the referenced overlay sequence
	 */
	public ReferencedOverlaySequence getReferencedOverlaySequence()
	{
		ReferencedOverlaySequence objReferencedOverlaySequence = (ReferencedOverlaySequence)getDicomValue(0x0008, 0x1130);
		if(objReferencedOverlaySequence == 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();
			objReferencedOverlaySequence = (ReferencedOverlaySequence)objDicomV3Factory.createSequence(0x0008, 0x1130, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x1130, DicomConstants.DCM_DT_SQ, objReferencedOverlaySequence.getValue());
		}
		return objReferencedOverlaySequence;
	}

	/**
	 * Returns Sequence that Uniquely identifies curves significantly related to
	 * this Curve.
	 * 
	 * @return - the referenced curve sequence
	 */
	public ReferencedCurveSequence getReferencedCurveSequence()
	{
		ReferencedCurveSequence objReferencedCurveSequence = (ReferencedCurveSequence)getDicomValue(0x0008, 0x1145);
		if(objReferencedCurveSequence == 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();
			objReferencedCurveSequence = (ReferencedCurveSequence)objDicomV3Factory.createSequence(0x0008, 0x1145, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0008, 0x1145, DicomConstants.DCM_DT_SQ, objReferencedCurveSequence.getValue());
		}
		return objReferencedCurveSequence;
	}

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