com.lf.commons.core

Class CommonsSettings

java.lang.Object

com.lf.commons.core.CommonsSettings

public class CommonsSettings
extends java.lang.Object

Global settings for the commons package.

Logging with log4j that comes with the great VFS library is disabled here since the Leisenfels modules uses java.util.logging.

Since:

1.5

Version:

$Revision: 1.58 $, $Date: 2016/01/01 15:43:03 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.JMenuItem[]	acceleratorItems The items holding the global accelerators like "F1" (help) also used for dialogs.
static java.lang.String	LOG_PREFIX Prefix used for the log messages created by this module.
static java.lang.String	MSG_PREFIX Prefix used for the log messages like "COMMONS-0001".
static java.lang.String	PACKAGE_PREFIX This base package.
protected static CommonsSettings	sharedInstance Shared CommonsSettings instance.
protected static com.lf.vfslib.net.VFSFileSystemManager	vfsManagerClasspath Shared FileSystemManager instance to load resources from the classpath.

Constructor Summary

Constructors

Constructor and Description
CommonsSettings() Constructor method.

Method Summary

Methods

Modifier and Type	Method and Description
void	check() Performs some simple tests for the caches and configurations and creates log messages.
static int	extractLocalization(java.lang.Object target) Searches for localization patterns and reads the object texts into the configuration.
DeployProps	getDeployProps() Gets the global version information.
static java.lang.String	getEnglishMessage(java.lang.String code) Convenience method to get a localized official message for the user.
static java.lang.String	getEnglishText(java.lang.Class clazz, java.lang.String variable) Convenience method to get the original (English) text.
static java.lang.String	getEnglishText(java.lang.Class clazz, java.lang.String variable, java.lang.String[] regex, java.lang.String[] replacement) Convenience method to get the original (English) text.
I18NConfiguration	getEnglishTexts() Provides the English texts for the GUI (labels, tooltips etc.).
HelpDelegate	getHelpDelegate() Gets the global help delegate (optional).
static java.lang.String	getHelpID(java.lang.String id) Convenience method for utilizing the help delegate.
java.lang.String	getI18NBase() Provides the global resource path for internationalization resources.
I18NConfiguration	getI18NTexts() Provides the global localized texts for the user.
java.util.logging.Logger	getLogger() Gets the global logging instance.
Locale	getLogLocale() Gets the global locale used for logging.
static com.lf.vfslib.net.VFSFileSystemManager	getManagerClasspath() Convenience method to get a shared instance of the Commons FileSystemManager.
MessageCodes	getMessageCodes() Provides the global message codes handlers.
ModelDelegate	getModelDelegate() Gets the global model delegate (optional).
static java.lang.Object	getObjectDelegated(java.lang.String id, java.lang.Object fallback) Convenience method to get an expected value from an application's model.
ReleaseNotes	getReleaseNotes() Provides the locale specific release notes (core package).
org.apache.commons.vfs2.FileObject	getReleaseNotesURL() Provides the locale specific release notes (core package).
static CommonsSettings	getSharedInstance() Convenience method to get a shared instance.
static java.lang.String	getSQLStatement(java.lang.Class clazz, java.lang.String id, DatabaseConnector connector) Convenience method to get an SQL statement from the 'resource/sql.conf' file.
static java.lang.String	getSQLStatement(java.lang.Class clazz, java.lang.String id, DatabaseConnector connector, boolean replace) Convenience method to get an SQL statement from the 'resource/sql.conf' file.
SQLConfiguration	getSQLStatements() Provides the locale specific texts for the GUI (labels, tooltips etc.).
java.util.Vector<Locale>	getSupportedLocales(boolean synonyms) Returns the locales currently supported by the package.
Locale	getUserLocale() Gets the global user locale.
static java.lang.String	getUserMessage(java.lang.String code) Convenience method to get a localized official message for the user.
static java.lang.String	getUserMessage(java.lang.String code, boolean prefix) Convenience method to get a localized official message for the user.
static java.lang.String	getUserMessage(java.lang.String code, java.lang.String[] regex, java.lang.String[] replacement, boolean prefix) Convenience method to log a localized official message.
static java.lang.String	getUserText(java.lang.Class clazz, java.lang.String variable) Convenience method to get a localized text for the user.
static java.lang.String	getUserText(java.lang.Class clazz, java.lang.String variable, java.lang.String[] regex, java.lang.String[] replacement) Convenience method to get a localized text for the user.
void	installGlobalAccelerators(javax.swing.JDialog dialog) Convenience to add the global accelerators like "F1" (help) for a specific dialog.
void	installGlobalAccelerators(javax.swing.JFrame frame) Convenience to add the global accelerators like "F1" (help) for a specific window.
static void	localize(java.lang.Object target, java.lang.Class targetclazz) Provides the info whether to enable object localization or not.
static void	log(java.util.logging.Level level, java.lang.String message) Convenience method to log a message.
static void	logMessage(java.util.logging.Level level, java.lang.String message) Convenience method to log a message.
static void	logMessage(java.lang.String code, java.util.logging.Level level) Convenience method to log a localized official message.
static void	logMessage(java.lang.String code, java.util.logging.Level level, java.lang.String[] regex, java.lang.String[] replacement) Convenience method to log a localized official message.
static void	logMessage(java.lang.String code, java.util.logging.Level level, java.lang.String regex, java.lang.String replacement) Convenience method to log a localized official message.
static void	registerConfigurableDelegated(java.lang.String id, ConfigurableUnit unit) Convenience method to allow for simple registration of a Commons configurable unit.
void	setGlobalAccelerators(javax.swing.JMenuItem[] accelitems) Provides the items holding the global accelerators like "F1" (help) also used for dialogs.
void	setHelpDelegate(HelpDelegate delegate) Sets the global help delegate (optional).
void	setLogger(java.util.logging.Logger logger) Sets the global logging instance.
void	setModelDelegate(ModelDelegate delegate) Sets the global model delegate (optional).
static void	setObjectDelegated(java.lang.String id, java.lang.Object value) Convenience method to set an expected value from an application's model.
void	setUserLocale(Locale locale) Sets the global user locale.
static void	showHelpDelegated(java.lang.String link) Calls the application specific help system for context sensitive help information.
static void	unregisterConfigurableDelegated(ConfigurableUnit unit) Convenience method to allow for simple unregistration of a Commons configurable unit.
static void	unregisterConfigurableDelegated(java.lang.String id) Convenience method to allow for simple unregistration of a Commons configurable unit.

Methods inherited from class java.lang.Object

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

Field Detail

sharedInstance

protected static CommonsSettings sharedInstance

Shared CommonsSettings instance.

MSG_PREFIX

public static final java.lang.String MSG_PREFIX

Prefix used for the log messages like "COMMONS-0001".

See Also:

Constant Field Values

LOG_PREFIX

public static final java.lang.String LOG_PREFIX

Prefix used for the log messages created by this module.

See Also:

Constant Field Values

PACKAGE_PREFIX

public static final java.lang.String PACKAGE_PREFIX

This base package.

See Also:

Constant Field Values

acceleratorItems

protected javax.swing.JMenuItem[] acceleratorItems

The items holding the global accelerators like "F1" (help) also used for dialogs.

vfsManagerClasspath

protected static com.lf.vfslib.net.VFSFileSystemManager vfsManagerClasspath

Shared FileSystemManager instance to load resources from the classpath.

Constructor Detail

CommonsSettings

public CommonsSettings()

Constructor method.

Since:

1.5

Method Detail

getManagerClasspath

public static com.lf.vfslib.net.VFSFileSystemManager getManagerClasspath()

Convenience method to get a shared instance of the Commons FileSystemManager.

Remember that this instance is global, the network connections provided by the VFSSessionWindow are managed by the manager which can be accessed using VFSSettings.getManagerNetwork(). Use this instance for internal resource loading from the classpath.

Returns:

Shared instance

Since:

1.6

check

public void check()

Performs some simple tests for the caches and configurations and creates log messages.

If either the configurations, or the message codes, or the build properties are absent, then the application should be interrupted since this is fatal.

Since:

1.5

getI18NBase

public java.lang.String getI18NBase()

Provides the global resource path for internationalization resources.

Returns:

The i18n path for use with separate localization JARs

Since:

1.5

getI18NTexts

public I18NConfiguration getI18NTexts()

Provides the global localized texts for the user.

Returns:

The localized texts

Since:

1.5

getEnglishTexts

public I18NConfiguration getEnglishTexts()

Provides the English texts for the GUI (labels, tooltips etc.).

Returns:

The English texts

localize

public static void localize(java.lang.Object target,
            java.lang.Class targetclazz)

Provides the info whether to enable object localization or not.

Parameters:

target - The target object to be localized

targetclazz - The target clazz, maybe a superclass

Since:

1.5

extractLocalization

public static int extractLocalization(java.lang.Object target)

Searches for localization patterns and reads the object texts into the configuration.

Parameters:

target - The target object to be localized

Returns:

Number of successfully retrieved fields

Since:

1.5

getMessageCodes

public MessageCodes getMessageCodes()

Provides the global message codes handlers.

Returns:

The message codes handlers

Since:

1.5

getLogger

public java.util.logging.Logger getLogger()

Gets the global logging instance.

Returns:

Logging instance

setLogger

public void setLogger(java.util.logging.Logger logger)

Sets the global logging instance.

Parameters:

logger - Logging instance

Throws:

java.lang.NullPointerException - Error indication

getUserLocale

public Locale getUserLocale()

Gets the global user locale.

Returns:

Current user locale

setUserLocale

public void setUserLocale(Locale locale)
                   throws java.lang.IllegalArgumentException

Sets the global user locale.

Make sure that the given new locale is supported by the settings class.

Parameters:

locale - Locale instance

Throws:

java.lang.IllegalArgumentException - Error indication

getSupportedLocales

public java.util.Vector<Locale> getSupportedLocales(boolean synonyms)

Returns the locales currently supported by the package.

Parameters:

synonyms - Also add the ISO 639-1/2 synonyms like "deu_DE" for "ger_DE"?

Returns:

The supported locales, maybe empty

Since:

1.5

getLogLocale

public Locale getLogLocale()

Gets the global locale used for logging.

At the moment this is static since exceptions and most System.outs are in English.

Returns:

Current logging locale

getDeployProps

public DeployProps getDeployProps()

Gets the global version information.

Returns:

Current version information

getSharedInstance

public static CommonsSettings getSharedInstance()

Convenience method to get a shared instance.

Returns:

Shared instance

log

public static void log(java.util.logging.Level level,
       java.lang.String message)

Convenience method to log a message.

Make sure that the message applies to the current log locale (normally "eng_US"). The log prefix like "[commons]" is prepended.

Parameters:

level - The log level

message - The log message

logMessage

public static void logMessage(java.util.logging.Level level,
              java.lang.String message)

Convenience method to log a message.

Make sure that the message applies to the current log locale (normally "eng_US"). The log prefix like "[commons]" is prepended.

Parameters:

level - The log level

message - The log message

logMessage

public static void logMessage(java.lang.String code,
              java.util.logging.Level level)

Convenience method to log a localized official message.

The message is logged using the current log locale (normally "eng_US"). The domain identifier is printed (e.g. "COMMONS-0006") while the package log prefix is omitted (e.g. "[commons]").

Parameters:

code - The log message id like "COMMONS-0006"

level - The log level

logMessage

public static void logMessage(java.lang.String code,
              java.util.logging.Level level,
              java.lang.String regex,
              java.lang.String replacement)

Convenience method to log a localized official message.

The message is logged using the current log locale (normally "eng_US"). The domain identifier is printed (e.g. "COMMONS-0006") while the package log prefix is omitted (e.g. "[commons]").

Parameters:

code - The log message id like "COMMONS-0006"

level - The log level

regex - The regular expression

replacement - The replacement string

logMessage

public static void logMessage(java.lang.String code,
              java.util.logging.Level level,
              java.lang.String[] regex,
              java.lang.String[] replacement)

Convenience method to log a localized official message.

The message is logged using the current log locale (normally "eng_US"). The domain identifier is printed (e.g. "COMMONS-0006") while the package log prefix is omitted (e.g. "[commons]").

Parameters:

code - The log message id like "COMMONS-0006"

level - The log level

regex - The regular expressions

replacement - The replacement strings

getUserMessage

public static java.lang.String getUserMessage(java.lang.String code)

Convenience method to get a localized official message for the user.

The message is returned using the current user locale (e.g. "eng_US"). The domain identifier is prepended (e.g. "DIGEST-0006").

Parameters:

code - The message code of interest, don't pass null values

Returns:

The message text, null if code does not exist

getEnglishMessage

public static java.lang.String getEnglishMessage(java.lang.String code)

Convenience method to get a localized official message for the user.

The message is returned using the "eng_US" locale. The domain identifier is prepended (e.g. "LIMA-0006").

Parameters:

code - The message code of interest, don't pass null values

Returns:

The message text, null if code does not exist

getUserMessage

public static java.lang.String getUserMessage(java.lang.String code,
                              boolean prefix)

Convenience method to get a localized official message for the user.

The message is returned using the current user locale (e.g. "eng_US"). The domain identifier is prepended (e.g. "DIGEST-0006").

Parameters:

code - The message code of interest, don't pass null values

prefix - Prepend the prefix?

Returns:

The message text, null if code does not exist

getUserMessage

public static java.lang.String getUserMessage(java.lang.String code,
                              java.lang.String[] regex,
                              java.lang.String[] replacement,
                              boolean prefix)

Convenience method to log a localized official message.

The message is logged using the current log locale (normally "eng_US"). The domain identifier is printed (e.g. "COMMONS-0006") while the package log prefix is omitted (e.g. "[commons]").

Parameters:

code - The log message id like "COMMONS-0006"

regex - The regular expression

replacement - The replacement string

prefix - Prepend the prefix?

Returns:

The message text, null if code does not exist

getUserText

public static java.lang.String getUserText(java.lang.Class clazz,
                           java.lang.String variable)

Convenience method to get a localized text for the user.

The message is returned using the current user locale (e.g. "eng_US").

Parameters:

clazz - The class for getting the class prefix

variable - The variable without class prefix, don't pass null values

Returns:

The localized text or the variable

getEnglishText

public static java.lang.String getEnglishText(java.lang.Class clazz,
                              java.lang.String variable)

Convenience method to get the original (English) text.

The message is returned using the locale "eng_US". These texts are useful for the support.

Parameters:

clazz - The class for getting the class prefix

variable - The variable without class prefix, don't pass null values

Returns:

The localized text, null if variable does not exist

Since:

1.6

getEnglishText

public static java.lang.String getEnglishText(java.lang.Class clazz,
                              java.lang.String variable,
                              java.lang.String[] regex,
                              java.lang.String[] replacement)

Convenience method to get the original (English) text.

The message is returned using the current user locale (e.g. "eng_US").

Parameters:

clazz - The class for getting the class prefix

variable - The variable without class prefix, don't pass null values

regex - The regular expression

replacement - The replacement string

Returns:

The localized text or the variable

getUserText

public static java.lang.String getUserText(java.lang.Class clazz,
                           java.lang.String variable,
                           java.lang.String[] regex,
                           java.lang.String[] replacement)

Convenience method to get a localized text for the user.

The message is returned using the current user locale (e.g. "eng_US").

Parameters:

clazz - The class for getting the class prefix

variable - The variable without class prefix, don't pass null values

regex - The regular expression

replacement - The replacement string

Returns:

The localized text or the variable

getModelDelegate

public ModelDelegate getModelDelegate()

Gets the global model delegate (optional).

Returns:

Delegate, maybe null

setModelDelegate

public void setModelDelegate(ModelDelegate delegate)

Sets the global model delegate (optional).

Parameters:

delegate - Delegate, maybe null

registerConfigurableDelegated

public static void registerConfigurableDelegated(java.lang.String id,
                                 ConfigurableUnit unit)

Convenience method to allow for simple registration of a Commons configurable unit.

Parameters:

id - The unique id defined by

unit - The configurable unit to be added

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

unregisterConfigurableDelegated

public static void unregisterConfigurableDelegated(ConfigurableUnit unit)

Convenience method to allow for simple unregistration of a Commons configurable unit.

Parameters:

unit - The unit to be removed

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

unregisterConfigurableDelegated

public static void unregisterConfigurableDelegated(java.lang.String id)

Convenience method to allow for simple unregistration of a Commons configurable unit.

Parameters:

id - The unique identifier

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

getObjectDelegated

public static java.lang.Object getObjectDelegated(java.lang.String id,
                                  java.lang.Object fallback)

Convenience method to get an expected value from an application's model.

Parameters:

id - The unique identifier (ModelDelegate.ID_PGP_HEADER_VERSION|...)

fallback - The default value

Returns:

The desired object, may be null

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

setObjectDelegated

public static void setObjectDelegated(java.lang.String id,
                      java.lang.Object value)

Convenience method to set an expected value from an application's model.

Parameters:

id - The unique identifier (ModelDelegate.ID_PGP_HEADER_VERSION|...)

value - The value to set

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

getHelpDelegate

public HelpDelegate getHelpDelegate()

Gets the global help delegate (optional).

Returns:

Delegate, maybe null

setHelpDelegate

public void setHelpDelegate(HelpDelegate delegate)

Sets the global help delegate (optional).

Parameters:

delegate - Delegate, maybe null

showHelpDelegated

public static void showHelpDelegated(java.lang.String link)

Calls the application specific help system for context sensitive help information.

Parameters:

link - The help system link

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

getHelpID

public static java.lang.String getHelpID(java.lang.String id)

Convenience method for utilizing the help delegate.

Parameters:

id - One of the declared static fields of HelpDelegate

Returns:

The help system link, may be null

getSQLStatements

public SQLConfiguration getSQLStatements()

Provides the locale specific texts for the GUI (labels, tooltips etc.).

Returns:

The locale specific texts

getSQLStatement

public static java.lang.String getSQLStatement(java.lang.Class clazz,
                               java.lang.String id,
                               DatabaseConnector connector)

Convenience method to get an SQL statement from the 'resource/sql.conf' file.

Parameters:

clazz - The class for getting the class prefix

id - The statement ID without class prefix, don't pass null values

connector - The connector for the target database

Returns:

The SQL statement, null if ID does not exist

getSQLStatement

public static java.lang.String getSQLStatement(java.lang.Class clazz,
                               java.lang.String id,
                               DatabaseConnector connector,
                               boolean replace)

Convenience method to get an SQL statement from the 'resource/sql.conf' file.

This variant let's the connector do some replacement (e.g. schema names).

Parameters:

clazz - The class for getting the class prefix

id - The statement ID without class prefix, don't pass null values

connector - The connector for the target database

replace - Apply connector replacements?

Returns:

The SQL statement, null if ID does not exist

setGlobalAccelerators

public void setGlobalAccelerators(javax.swing.JMenuItem[] accelitems)

Provides the items holding the global accelerators like "F1" (help) also used for dialogs.

Parameters:

accelitems - The accelerators

Since:

1.6

installGlobalAccelerators

public void installGlobalAccelerators(javax.swing.JDialog dialog)

Convenience to add the global accelerators like "F1" (help) for a specific dialog.

Parameters:

dialog - The dialog

Since:

1.6

installGlobalAccelerators

public void installGlobalAccelerators(javax.swing.JFrame frame)

Convenience to add the global accelerators like "F1" (help) for a specific window.

Parameters:

frame - The window

Since:

1.6

getReleaseNotesURL

public org.apache.commons.vfs2.FileObject getReleaseNotesURL()

Provides the locale specific release notes (core package).

Returns:

The release notes URL

Since:

1.6

getReleaseNotes

public ReleaseNotes getReleaseNotes()

Provides the locale specific release notes (core package).

Returns:

The release notes

Since:

1.6