com.sptci.echo2
Class Configuration

java.lang.Object
  com.sptci.echo2.Configuration

public class Configuration
extends Object

A utility class that is used to load and retrieve the localised configurable properties for UI components. This class needs an active ApplicationInstance to be properly initialised.

Copyright 2006 Sans Pareil Technologies, Inc.

Version:

$Id: Configuration.java 3026 2007-03-02 14:02:28Z rakesh $

Author:

Rakesh Vidyadharan 2006-03-01

Field Summary

private static String	BUNDLE_NAME The name of the resource bundle to load.
private static Logger	logger The logger used to log errors.
private static HashMap<Locale,ResourceBundle>	resource The resource bundle that represents the appropriate properties file.

Constructor Summary

private

Configuration() Cannot be instantiated.

Method Summary

private static ResourceBundle	fetchResourceBundle() Fetch the appropriate ResourceBundle based upon the Locale from resource.
static int	getInt(Object source, String key) Returns configured integer value for the key for the specified source object.
static int	getInt(String key) Returns configured integer value for the key.
static String	getString(Object source, String key) Returns localised configured text for the key for the specified source object.
static String	getString(String key) Returns localised configured text for the key.

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLE_NAME

private static final String BUNDLE_NAME

The name of the resource bundle to load. "META-INF.resource.localisation.Configuration"

See Also:

Constant Field Values

logger

private static final Logger logger

The logger used to log errors.

resource

private static HashMap<Locale,ResourceBundle> resource

The resource bundle that represents the appropriate properties file.

Constructor Detail

Configuration

private Configuration()

Cannot be instantiated.

Method Detail

getString

public static final String getString(Object source,
                                     String key)

Returns localised configured text for the key for the specified source object. Look for a key that is named after the fully qualified class name of the source object.

Parameters:

source - The object for which the localised text is to be retrieved.

key - The key of the text to be returned

Returns:

The appropriate localised text (if the key is not defined, the string "!key!" is returned)

See Also:

getString( String )

getString

public static final String getString(String key)

Returns localised configured text for the key.

Parameters:

key - The key of the text to be returned

Returns:

The appropriate localised text (if the key is not defined, the string "!key!" is returned)

getInt

public static final int getInt(Object source,
                               String key)

Returns configured integer value for the key for the specified source object. Look for a key that is named after the fully qualified class name of the source object.

Parameters:

source - The object whose configured localised value is to be retrieved.

key - The key of the integer value to be returned

Returns:

The appropriate value (if the key is not defined, the value 0 is returned)

See Also:

getInt( String )

getInt

public static final int getInt(String key)

Returns configured integer value for the key.

Parameters:

key - The key of the integer value to be returned

Returns:

The appropriate value (if the key is not defined, the value 0 is returned)

fetchResourceBundle

private static final ResourceBundle fetchResourceBundle()

Fetch the appropriate ResourceBundle based upon the Locale from resource.

Returns:

ResourceBundle The appropriate resource bundle for the locale.