oracle.javatools.db
Class GlobalSettings

java.lang.Object
  oracle.javatools.data.HashStructureAdapter
      oracle.javatools.db.GlobalSettings

public class GlobalSettings
extends HashStructureAdapter

Class for api settings that govern the behaviour of the api at a global level.

For internal use only. Application developers should not use this

Field Summary

static java.lang.String

PREFS_KEY Key used to locate the GlobalSettings in a given PropertyStorage.

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Method Summary

static GlobalSettings	createGlobalSettings(PropertyStorage props) Creates a copy of global settings using the given hash.
static GlobalSettings	getInstance() Gets the GlobalSettings instance for the API.
PlSqlCompilerOptions	getPlSqlCompilerOptions() Retuns the PL/SQL compiler options from the global settings.
java.lang.Integer	getStatementTimeout() Gets the timeout setting for all Statement execution in the API in seconds.
static void	initialiseInstance(PropertyStorage props) Initialises the global settings with the given HashStructure for storage.
boolean	isNewPlSqlLowerCase() gets whether the keywords in new PL/SQL are in lower or upper case
boolean	isValidateDateTime() Gets whether the api validation layer is validating date/time datatype default values.
void	setNewPlSqlLowerCase(boolean newPlSqlLowerCase) Sets whether the keywords in new PL/SQL are in lower or upper case
void	setStatementTimeout(java.lang.Integer timeout) Sets or removes the statement timeout setting.
void	setValidateDateTime(boolean boo) Sets whether the api validation layer is validating date/time datatype default values.

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFS_KEY

public static final java.lang.String PREFS_KEY

Key used to locate the GlobalSettings in a given PropertyStorage.

See Also:

Constant Field Values

Method Detail

getInstance

public static final GlobalSettings getInstance()

Gets the GlobalSettings instance for the API. This is a singleton that needs to be initialised because the api itself can run standalone and in that case will not have any GlobalSettings. When running within the IDE the initialiseInstance() method must be called to initialise the central (singleton) instance.

Returns:

the singleton setting instance if initialised, else null.

initialiseInstance

public static final void initialiseInstance(PropertyStorage props)

Initialises the global settings with the given HashStructure for storage. This method cannot be called more than once.

See Also:

getInstance()

createGlobalSettings

public static final GlobalSettings createGlobalSettings(PropertyStorage props)

Creates a copy of global settings using the given hash. To get the GlobalSettings that the API is using call getInstance().

See Also:

getInstance()

isValidateDateTime

public boolean isValidateDateTime()

Gets whether the api validation layer is validating date/time datatype default values.

setValidateDateTime

public void setValidateDateTime(boolean boo)

Sets whether the api validation layer is validating date/time datatype default values.

isNewPlSqlLowerCase

public boolean isNewPlSqlLowerCase()

gets whether the keywords in new PL/SQL are in lower or upper case

setNewPlSqlLowerCase

public void setNewPlSqlLowerCase(boolean newPlSqlLowerCase)

Sets whether the keywords in new PL/SQL are in lower or upper case

getPlSqlCompilerOptions

public PlSqlCompilerOptions getPlSqlCompilerOptions()

Retuns the PL/SQL compiler options from the global settings. These govern the warning levels for the compiler to return.

getStatementTimeout

public java.lang.Integer getStatementTimeout()

Gets the timeout setting for all Statement execution in the API in seconds.

Returns:

a timeout in seconds, or null if no timeout is set.

setStatementTimeout

public void setStatementTimeout(java.lang.Integer timeout)

Sets or removes the statement timeout setting. The timeout is used when executing any Statement in the API by using the setQueryTimeout method on java.sql.Statement.

Parameters:

timeout - the timeout in seconds, or null to remove the setting.