com.goldencode.p2j.ui.client

Class ClientBrowseConfigManager

java.lang.Object

com.goldencode.p2j.ui.client.ClientBrowseConfigManager

public class ClientBrowseConfigManager
extends java.lang.Object

Client-side manager for enhanced browse configurations. Loads configurations from the client storage, caches them and saves new and updated configurations back to the client storage.

Field Summary

Fields

Modifier and Type	Field and Description
private static ContextLocal<ClientBrowseConfigManager>	instance Singleton instance.
private static CentralLogger	LOG Logger.
private java.lang.String	rootNode String which serves as the "root node" for the client storage.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ClientBrowseConfigManager() Private constructor.

Method Summary

Modifier and Type	Method and Description
EnhancedBrowseConfig[]	getClientEnhancedConfigs(EhBrowseConfigKey[] keys) Get enhanced browse configurations stored on the client side.
private java.lang.String	getColumnSavePath(java.lang.String browseSavePath, java.lang.String columnKey) Get save path for the configuration of the browse column.
private EnhancedBrowseConfig	getEnhancedConfig(EhBrowseConfigKey key) Get enhanced browse configuration stored on the client side.
static ClientBrowseConfigManager	getInstance() Get the manager instance.
private java.lang.String	getSavePath(EhBrowseConfigKey key) Get save path for the configuration.
boolean	resetEnhancedConfig(EhBrowseConfigKey key) Reset (delete) the specified enhanced browse configuration in the client storage.
boolean	saveEnhancedConfig(EnhancedBrowseConfig config) Save the specified enhanced browse configuration in the client storage.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger.

instance

private static final ContextLocal<ClientBrowseConfigManager> instance

Singleton instance.

rootNode

private final java.lang.String rootNode

String which serves as the "root node" for the client storage.

Constructor Detail

ClientBrowseConfigManager

private ClientBrowseConfigManager()

Private constructor.

Method Detail

getInstance

public static ClientBrowseConfigManager getInstance()

Get the manager instance.

Returns:

manager instance.

saveEnhancedConfig

public boolean saveEnhancedConfig(EnhancedBrowseConfig config)

Save the specified enhanced browse configuration in the client storage.

Parameters:

config - Enhanced browse configuration to save.

Returns:

true on success.

resetEnhancedConfig

public boolean resetEnhancedConfig(EhBrowseConfigKey key)

Reset (delete) the specified enhanced browse configuration in the client storage.

Parameters:

key - Key which specifies the enhanced browse configuration to be deleted.

Returns:

true on success.

getClientEnhancedConfigs

public EnhancedBrowseConfig[] getClientEnhancedConfigs(EhBrowseConfigKey[] keys)

Get enhanced browse configurations stored on the client side.

Parameters:

keys - Array of the keys of the target configurations to get.

Returns:

array containing the target configurations. It has the same size as the array of keys. If there is no configuration found for a key, the corresponding array element is null.

getEnhancedConfig

private EnhancedBrowseConfig getEnhancedConfig(EhBrowseConfigKey key)

Get enhanced browse configuration stored on the client side.

Parameters:

key - Key of the target configurations to get.

Returns:

the target configuration or null if there is no configuration found for the key.

getSavePath

private java.lang.String getSavePath(EhBrowseConfigKey key)

Get save path for the configuration. It has the following format: enhancedBrowse/{embedded|desktop}/user_name/procedure_name/browse_name/column_keys. null elements are allowed in path.

Parameters:

key - Key which specifies the configuration.

Returns:

save path for the configuration.

getColumnSavePath

private java.lang.String getColumnSavePath(java.lang.String browseSavePath,
                                           java.lang.String columnKey)

Get save path for the configuration of the browse column. It has the following format: browseSavePath/columnKey.

Parameters:

browseSavePath - Path of the parent browse configuration.

columnKey - Column key.

Returns:

save path for the column configuration.