cdac.medinfo.sdk.dcm30_04.utils

Class DicomConfig

java.lang.Object

cdac.medinfo.sdk.dcm30_04.utils.DicomConfig

public class DicomConfig
extends java.lang.Object

This class sets the Configuration of Dicom Library.

Method Summary

Methods

Modifier and Type	Method and Description
static DicomConfig	createInstance() Constructs instance of DicomConfig.
static DicomConfig	createInstance(EnumLogMode enumLogMode, EnumLocale enumLocale) Constructs instance of DicomConfig for specified logmode and locale.
void	disAbleLogging() This function sets logging mode as OFF.
void	enableLogging(EnumLoggingLevel enumLoggingLevel) This function sets logging mode as ON.
void	enableLogging(EnumLoggingLevel enumLoggingLevel, java.lang.String strLogLocation) This function sets logging mode as ON.
java.lang.String	getLocale() Retrieves Locale property.
EnumLoggingLevel	getLoggingLevel() This function retrieves the logging level of DICOM Library.
java.lang.String	getTempStorageFilePath() This function Retrieves the temporary storage file path where the temporary file is stored.
boolean	isLoggingOn() This function retrieves the status of logging mode whether it is on.
boolean	isTempStorageInUse() This function indicates whether temporary storage is in use or not.
void	setLocale(EnumLocale enumLocale) Sets Locale property.
void	useTempStorage(boolean isTempStorageInUSe) This function is used to configure use of temporary storage.
void	useTempStorage(java.lang.String strTempStorageFilePath) This function is used to configure use of temporary storage.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createInstance

public static DicomConfig createInstance()

Constructs instance of DicomConfig.

Returns:

instance of DicomConfig class.

createInstance

public static DicomConfig createInstance(EnumLogMode enumLogMode,
                         EnumLocale enumLocale)

Constructs instance of DicomConfig for specified logmode and locale.

Parameters:

enumLogMode - enum represents logging mode.

enumLocale - enum specify locale specific information.

Returns:

instance of DicomConfig class for specified logmode and locale.

isLoggingOn

public boolean isLoggingOn()

This function retrieves the status of logging mode whether it is on.

Returns:

boolean - boolean value indicating whether logging mode is on.

enableLogging

public void enableLogging(EnumLoggingLevel enumLoggingLevel)

This function sets logging mode as ON. If the user enables logging then data is logged into log file.

Parameters:

enumLoggingLevel - enum represents logging Level as SEVERE - Logs fatal exceptions. INFO - Logs fatal exceptions, state of the object at the time of error.

enableLogging

public void enableLogging(EnumLoggingLevel enumLoggingLevel,
                 java.lang.String strLogLocation)

This function sets logging mode as ON. If the user enables logging then data is logged into log file.

Parameters:

enumLoggingLevel - enum represents logging Level as SEVERE - Logs fatal exceptions. INFO - Logs fatal exceptions, state of the object at the time of error.

strLogLocation - Path of directory in which logging is done.

disAbleLogging

public void disAbleLogging()

This function sets logging mode as OFF. If the user dissables logging mode then data is not logged into log file.

getLocale

public java.lang.String getLocale()

Retrieves Locale property.

Returns:

- Locale used in string

setLocale

public void setLocale(EnumLocale enumLocale)

Sets Locale property.

Parameters:

enumLocale - the enum locale.

getLoggingLevel

public EnumLoggingLevel getLoggingLevel()

This function retrieves the logging level of DICOM Library.

Returns:

enumLoggingLevel enum represents logging Level as SEVERE - Logs fatal exceptions. INFO - Logs fatal exceptions, state of the object at the time of error.

useTempStorage

public void useTempStorage(java.lang.String strTempStorageFilePath)

This function is used to configure use of temporary storage. It sets the Temporay Storage file path as provided by the user. This function sets the strTempStorageFilePath as the file path where temporary file should be stored .

Parameters:

strTempStorageFilePath - File path where the temporary file should be stored.

useTempStorage

public void useTempStorage(boolean isTempStorageInUSe)

This function is used to configure use of temporary storage. If the boolean variable provided the user is false then temporary storage file path is not in use and whole data is in memory. If the boolean variable provided by user is true then user's temporary directory is used as default temporary storage file path.

Parameters:

isTempStorageInUSe - boolean variable indicating whether temporary storage is in use or not. true if temporary Storage is in use. false if temporary Storage is not in use.

getTempStorageFilePath

public java.lang.String getTempStorageFilePath()

This function Retrieves the temporary storage file path where the temporary file is stored.

Returns:

String - File path where the temporary file should be stored.

isTempStorageInUse

public boolean isTempStorageInUse()

This function indicates whether temporary storage is in use or not.

Returns:

boolean - true if temporary storage is in use. false if temporary storage is not in use.