/*******************************************************************************
 *  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.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
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 the methods to set, get and validate the attribute present in Information From Manufacturer Sequence.
 */

public class InformationFromManufacturerSequenceItem extends Item
{

	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	InformationFromManufacturerSequenceItem()
	{
		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
	 */
	InformationFromManufacturerSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates InformationFromManufacturerSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used.
	 */
	InformationFromManufacturerSequenceItem(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 InformationFromManufacturerSequenceItem 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(0x0068,0x6270))
				throw new MandatoryMissingException("0068,6270");
			if(!contains(0x0068,0x6280))
				throw new MandatoryMissingException("0068,6280");
			if(contains(0x0042, 0x0011))
				if(!contains(0x0042,0x0012))
					throw new ConditionFailedException("0x0042,0x0012");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		catch(ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	
	/**
	 * Sets Information Issue Date Time.
	 * Date and Time the information was issued.
	 * @param strInformationIssueDateTime String value of Information Issue Date Time
	 */
	public void setInformationIssueDateTime(String strInformationIssueDateTime)
	{
		/* Accept the Information Issue Date Time of type DT.
		 * 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(0x0068,0x6270,strInformationIssueDateTime,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0068,0x6270,DicomConstants.DCM_DT_DT, strInformationIssueDateTime);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Information Issue Date Time.
	 * Date and Time the information was issued.
	 * @return String - value of Information Issue Date Time
	 */
	public String getInformationIssueDateTime()
	{
		Object objValue = getValue(0x0068,0x6270);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the Information Summary.
	 * Summary of the information.
	 * @param strInformationSummary - value of Information Summary
	 */
	public void setInformationSummary(String strInformationSummary)
	{
		/*Accept the Information Summary 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 Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0068, 0x6280, strInformationSummary,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0068, 0x6280,DicomConstants.DCM_DT_ST, strInformationSummary);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves the Information Summary.
	 * Summary of the information.
	 * @return String value of Information Summary.
	 */
	public String getInformationSummary()
	{
		Object objValue = getValue(0x0068, 0x6280);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the Encapsulated Document.
	 * Encapsulated Document stream, containing a document encoded according to the MIME Type.
	 * @param vectEncapsulatedDocument collection of byte array of Encapsulated Document.
	 */
	public void setEncapsulatedDocument(ISingleCollection<byte[]> vectEncapsulatedDocument)
	{
		/*Accept the Encapsulated Document 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(0x0042, 0x0011, vectEncapsulatedDocument,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0042, 0x0011,DicomConstants.DCM_DT_OB, vectEncapsulatedDocument);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves the Encapsulated Document.
	 * Encapsulated Document stream, containing a document encoded according to the MIME Type.
	 * @return ISingleCollection<byte[]> - collection of byte array of Encapsulated Document.
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<byte[]> getEncapsulatedDocument()
	{
		Object objValue = getValue(0x0042, 0x0011);
		if(objValue != null)
			return (ISingleCollection<byte[]>)objValue;
		return null;
	}
	
	/**
	 * Sets MIME Type of Encapsulated Document.
	 * The type of the encapsulated document stream described using the MIME Media Type.
	 * @param strMIMETypeofEncapsulatedDocument String value of MIME Type of Encapsulated Document.
	 */
	public void setMIMETypeofEncapsulatedDocument(String strMIMETypeofEncapsulatedDocument)
	{
		/* Accept the MIME Type of Encapsulated Document 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 Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0042,0x0012, strMIMETypeofEncapsulatedDocument,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0042,0x0012,DicomConstants.DCM_DT_LO, strMIMETypeofEncapsulatedDocument);

		addDataElement(objIDataElement);
	}

	/**
	 * Return MIME Type of Encapsulated Document.
	 * The type of the encapsulated document stream described using the MIME Media Type
	 * @return String - value of MIME Type of Encapsulated Document.
	 */
	public String getMIMETypeofEncapsulatedDocument()
	{
		Object objValue = getValue(0x0042,0x0012);
		if(objValue != null)
			return objValue.toString();
		return null;
	}


}
