/*******************************************************************************
 *  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.DisplaySubsystemSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.EquipmentAdministratorSequence;
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;
/**
\* This module is used for Display System Module.
*/
public class DisplaySystemModule extends Module
{

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


	/**
	 * Creates DisplaySystemModule with default initialization.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public DisplaySystemModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x0070));
		objSingleCollection.add(new Tag(0x0008,0x0080));
		objSingleCollection.add(new Tag(0x0008,0x0081));
		objSingleCollection.add(new Tag(0x0018,0x1000));
		objSingleCollection.add(new Tag(0x0008,0x1010));
		objSingleCollection.add(new Tag(0x0008,0x1040));
		objSingleCollection.add(new Tag(0x0008,0x1090));
		objSingleCollection.add(new Tag(0x0028,0x7000));
		objSingleCollection.add(new Tag(0x0028,0x7001));
		objSingleCollection.add(new Tag(0x0028,0x7023));
	}

	/**
	 * 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 boolean - returns validation status as success or failure
	 * 
	 * @throws InvalidModuleException - If validation of Module fails
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{
			/*
			 * Validation Rules for Mandatory Elements
			 */
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		return true;
	}

	/**
	 * Sets Manufacturer
	 * @param strManufacturer String value of Manufacturer
	 */
	public void setManufacturer(String strManufacturer)
	{
		/* Accept the Manufacturer 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
		 */
		addDataElement(0x0008,0x0070, DicomConstants.DCM_DT_LO,strManufacturer);
	}

	/**
	 * Return Manufacturer.
	 * @return String - value of Manufacturer
	 */
	public String getManufacturer()
	{
		Object objValue = getValue(0x0008,0x0070);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets InstitutionName
	 * @param strInstitutionName String value of InstitutionName
	 */
	public void setInstitutionName(String strInstitutionName)
	{
		/* Accept the Institution Name 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
		 */
		addDataElement(0x0008,0x0080, DicomConstants.DCM_DT_LO,strInstitutionName);
	}

	/**
	 * Return InstitutionName.
	 * @return String - value of InstitutionName
	 */
	public String getInstitutionName()
	{
		Object objValue = getValue(0x0008,0x0080);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
		
	/**
	 * Sets Mailing address of institution where the Display System is located.
	 * @param strInstitutionAddress 
	 */
	public void setInstitutionAddress(String strInstitutionAddress)
	{
		/*Accept the Coding Scheme Name 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
		 */
		addDataElement(0x0008,0x0081, DicomConstants.DCM_DT_ST,strInstitutionAddress);
	}

	/**
	 * Retrieves Mailing address of institution where the Display System is located.
	 * @return String value of InstitutionAddress
	 */
	public String getCommentsonRadiationDose()
	{
		Object objValue = getValue(0x0008,0x0081);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Manufacturer's serial number of the Display System.
	 * @param strDeviceSerialNumber String value of Manufacturer's serial number of the Display System.
	 */
	public void setDeviceSerialNumber(String strDeviceSerialNumber)
	{
		/* Accept the Institution Name 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
		 */
		addDataElement(0x0018,0x1000, DicomConstants.DCM_DT_LO,strDeviceSerialNumber);
	}

	/**
	 * Return Manufacturer's serial number of the Display System..
	 * @return String - value of Manufacturer's serial number of the Display System.
	 */
	public String getDeviceSerialNumber()
	{
		Object objValue = getValue(0x0018,0x1000);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets the User defined name identifying the Display System..
	 * @param strStationName
	 */
	public void setStationName(String strStationName)
	{
		/*Accept the StationName in String format of type SH.
		 * 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
		 */
		addDataElement(0x0008,0x1010, DicomConstants.DCM_DT_SH,strStationName);
	}

	/**
	 * Retrieves User defined name identifying the Display System.
	 * @return String - value of User defined name identifying the Display System.
	 */
	public String getStationName()
	{
		Object objValue = getValue(0x0008, 0x1010);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets Department name in the institution where the Display System is located
	 * @param strInstitutionalDepartmentName String value of Department name in the institution where the Display System is located
	 */
	public void setInstitutionalDepartmentName(String strInstitutionalDepartmentName)
	{
		/* Accept the InstitutionalDepartmentName 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
		 */
		addDataElement(0x0018,0x1040, DicomConstants.DCM_DT_LO,strInstitutionalDepartmentName);
	}

	/**
	 * Return Department name in the institution where the Display System is located
	 * @return String - value of Department name in the institution where the Display System is located
	 */
	public String getInstitutionalDepartmentName()
	{
		Object objValue = getValue(0x0018,0x1040);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets Manufacturer's model name of the Display System.
	 * @param strManufacturerModelName String value of Manufacturer's model name of the Display System.
	 */
	public void setManufacturerModelName(String strManufacturerModelName)
	{
		/* Accept the ManufacturerModelName 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
		 */
		addDataElement(0x0018,0x1090, DicomConstants.DCM_DT_LO,strManufacturerModelName);
	}

	/**
	 * Return Manufacturer's model name of the Display System.
	 * @return String - value of Manufacturer's model name of the Display System.
	 */
	public String getManufacturerModelName()
	{
		Object objValue = getValue(0x0018,0x1090);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Retrieves pre-initialized object of Equipment AdministratorS equence. If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence
	 * 
	 * @return EquipmentAdministratorSequence - instance of EquipmentAdministratorSequence.
	 */
	public EquipmentAdministratorSequence getEquipmentAdministratorSequence()
	{
		EquipmentAdministratorSequence objEquipmentAdministratorSequence = (EquipmentAdministratorSequence)getDicomValue(0x0028,0x7000);
		if(objEquipmentAdministratorSequence == 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();
			objEquipmentAdministratorSequence = (EquipmentAdministratorSequence)objDicomV3Factory.createSequence(0x0028,0x7000, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0028,0x7000, DicomConstants.DCM_DT_SQ, objEquipmentAdministratorSequence.getValue());
		}
		return objEquipmentAdministratorSequence;
	}
	
	/**
	 * Sets Number of Display Subsystems in the Display System.
	 * @param shNumberOfDisplaySubsystems short value of Number of Display Subsystems in the Display System.
	 */
	public void setNumberOfDisplaySubsystems(short shNumberOfDisplaySubsystems)
	{
		/* Accept the NumberOfDisplaySubsystems of type US.
		 * 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
		 */
		addDataElement(0x0028,0x7001, DicomConstants.DCM_DT_US,shNumberOfDisplaySubsystems);
	}

	/**
	 * Retrieves Number of Display Subsystems in the Display System.
	 * @return short - short value of Number of Display Subsystems in the Display System.
	 */
	public short getNumberOfDisplaySubsystems()
	{
		Object objValue = getValue(0x003A,0x021A);
		if(objValue != null)
			return Short.parseShort(objValue.toString());

		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	 * Retrieves pre-initialized object of Display Subsystem Sequence. If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence
	 * 
	 * @return DisplaySubsystemSequence - instance of DisplaySubsystemSequence.
	 */
	public DisplaySubsystemSequence getDisplaySubsystemSequence()
	{
		DisplaySubsystemSequence objDisplaySubsystemSequence= (DisplaySubsystemSequence)getDicomValue(0x0028, 0x7023);
		if(objDisplaySubsystemSequence == 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();
			objDisplaySubsystemSequence = (DisplaySubsystemSequence)objDicomV3Factory.createSequence(0x0028, 0x7023, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0028, 0x7023, DicomConstants.DCM_DT_SQ, objDisplaySubsystemSequence.getValue());
		}
		return objDisplaySubsystemSequence;
	}

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