/*******************************************************************************
 *  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.baselibs;

import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataElement;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.enums.EnumMACAlgorithm;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.exceptions.ValidationException;
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;
/**
* This item class contains methods to validate, set and get the attributes of Referenced SOP Instance MAC Sequence .
 */

public class ReferencedSOPInstanceMACSequenceItem extends Item
{
	


	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	ReferencedSOPInstanceMACSequenceItem()
	{
		super();
	}

	/*
	 * This constructor calls the respective superclass constructor
	 * This constructor should throw exception if null TS is tried to be set
	 */
	/**
	 * This constructor creates the item with specified TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	ReferencedSOPInstanceMACSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates ReferencedSOPInstanceMACSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used.
	 */
	ReferencedSOPInstanceMACSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/*
	 * (non-Javadoc) This method validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in ReferencedSOPInstanceMACSequenceItem that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try{
			if(!contains(0x0400,0x0010))
				throw new MandatoryMissingException("0400,0010");
			if(!contains(0x0400,0x0015))
				throw new MandatoryMissingException("0400,0015");
			if(!contains(0x0400,0x0020))
				throw new MandatoryMissingException("0400,0020");
			if(!contains(0x0400,0x0404))
				throw new MandatoryMissingException("0400,0404");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	
	/**
	 * Sets MAC Calculation Transfer Syntax UID.
	 * @param strMACCalculationTransferSyntaxUID String value of MAC Calculation Transfer Syntax UID.
	 */
	public void setMACCalculationTransferSyntaxUID(String strMACCalculationTransferSyntaxUID)
	{
		/*Accept the MAC Calculation Transfer Syntax UID 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 Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0400, 0x0010, strMACCalculationTransferSyntaxUID,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0400, 0x0010,DicomConstants.DCM_DT_UI, strMACCalculationTransferSyntaxUID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves MAC Calculation Transfer Syntax UID.
	 * @return String - value of MAC Calculation Transfer Syntax UID.
	 */
	public String getMACCalculationTransferSyntaxUID()
	{
		Object objValue = getValue(0x0400, 0x0010);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets type of MAC Algorithm
	 * Defined Terms:
	 * 1)RIPEMD160	
	 * 2)MD5	
	 * 3)HA1	
	 * 4)SHA256	
	 * 5)SHA384	
	 * 6)SHA512
.
	 * @param enumMACAlgorithm enum value of MAC Algorithm.
	 */
	public void setMACAlgorithm(EnumMACAlgorithm enumMACAlgorithm)
	{
		/* Accept the MAC Algorithm Type 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 Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0400,0x0015, enumMACAlgorithm.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0400,0x0015,DicomConstants.DCM_DT_CS, enumMACAlgorithm.getValue());

		addDataElement(objIDataElement);
	}

	/**
	 * Return type of MAC Algorithm used . 
	 * @return String - value of MAC Algorithm.
	 */
	public String getMACAlgorithm()
	{
		Object objValue = getValue(0x0400,0x0015);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets a list of Data Elements Signed Tags.
	 * @param objDataElementsSigned collection of Data Elements Signed.
	 */
	public void setDataElementsSigned(ISingleCollection<ITag> objDataElementsSigned)
	{
		/*Accept the Data Elements Signed in String format of type AT.
		 * 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
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0400, 0x0020, objDataElementsSigned,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0400, 0x0020,DicomConstants.DCM_DT_AT, objDataElementsSigned);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves a list of Data Elements Signed .
	 * @return ISingleCollection<ITag> - collection of Data Elements Signed.
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<ITag> getDataElementsSigned()
	{
		Object objValue = getValue(0x0400, 0x0020);
		if(objValue != null)
			return (ISingleCollection<ITag>)objValue;
		return null;
	}
	
	/**
	 * Sets the MAC .
	 * @param vectMAC collection of byte array of MAC values.
	 */
	public void setMAC(ISingleCollection<byte[]> vectMAC)
	{
		/*Accept the MAC in vector of byte array format of type OB.
		 * 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
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0400, 0x0404, vectMAC,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0400, 0x0404,DicomConstants.DCM_DT_OB, vectMAC);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves the MAC generated.
	 * the Certificate of the MAC (0400,0404).
	 * @return ISingleCollection<byte<byte[]> - collection of byte array of MAC values.
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<byte[]> getMAC()
	{
		Object objValue = getValue(0x0400, 0x0404);
		if(objValue != null)
			return (ISingleCollection<byte[]>)objValue;
		return null;
	}
}
