com.ontimize.gui.i18n

Class DatabaseBundleManager

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

com.ontimize.util.remote.AbstractRemoteReference

com.ontimize.gui.i18n.DatabaseBundleManager

All Implemented Interfaces:

IDatabaseBundleManager, Serializable, Remote

public class DatabaseBundleManager
extends AbstractRemoteReference
implements IDatabaseBundleManager

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTOCONFIGURE_LOCALE_COLUMNS
protected boolean	autoconfigureLocaleColumns
static String	BUNDLE_CLASS_NAME_COLUMN
static String	BUNDLE_DESCRIPTION_COLUMN
static String	BUNDLE_ENTITY_NAME
static String	BUNDLE_KEY_COLUMN
static String	BUNDLE_TABLE_NAME
static String	BUNDLE_VALUES_ENTITY_NAME
static String	BUNDLE_VALUES_KEY_COLUMN
static String	BUNDLE_VALUES_TABLE_NAME
static String	BUNDLE_VALUES_TEXT_KEY_COLUMN
static String	bundleClassNameColumn
static String	bundleDescriptionColumn
static String	bundleEntityName
static String	bundleKeyColumn
static String	bundleTableName
static String	bundleValuesEntityName
static String	bundleValuesKeyColumn
static String	bundleValuesTableName
static String	bundleValuesTextKeyColumn
static String	DATABASE_CONNECTION_MANAGER_ID
protected Hashtable	localeColumnNames
static String	TO_LOWER_CASE
static Boolean	toLowerCase Boolean to know the names of the columns in the table Default value is null, to use directly the names in the configuration file or the default ones.

Fields inherited from class com.ontimize.util.remote.AbstractRemoteReference

dbConnectionManagerId, locator

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Constructor and Description
DatabaseBundleManager(int port, EntityReferenceLocator locator, Hashtable params)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	autoconfigureLocaleColumns()
EntityResult	executePreparedStatement(SQLStatementBuilder.SQLStatement sqlStatement, Connection con, int sessionId, List queryColumns)
protected EntityResult	executeQueryStatement(SQLStatementBuilder.SQLStatement sqlStatement, int sessionId, List queryColumns, Connection con)
protected void	executeUpdateStatement(SQLStatementBuilder.SQLStatement sqlStatement, int sessionId, Connection con)
Hashtable	getAllResourceBundles(Locale locale, int sessionId) Get a hashtable with all the available bundles in the database for the specified locale
DatabaseBundleDescriptor[]	getAvailableBundles(int sessionId) Get a list with all the available bundle classes
DatabaseBundleDescriptor[]	getAvailableBundles(int sessionId, Connection con) Get all the available bundles in the database.
String[]	getAvailableLocales(int sessionId) Get a list with the suffix of the available locales in the database
protected ResourceBundle	getBundle(DatabaseBundleDescriptor bundleDescriptor, Locale locale, int sessionId)
ResourceBundle	getBundle(String baseName, Locale locale, int sessionId) Get the resource bundle for the specified name and locale
protected DatabaseBundleDescriptor	getBundleDescriptor(String bundleClassName, int sessionId)
protected Object	getBundleId(String bundleClassName, List availablebundles, int sessionId, Connection con)
Hashtable	getBundles(List baseNames, Locale locale, int sessionId) Get all the resources for the specified locale and different names
protected Object	getBundleValueKey(Hashtable filter, int sessionId, Connection con)
protected String	getColumnName(Locale locale)
protected String	getLocaleString(String locale)
protected String	getTableNameFromMetadata(String tableName, Connection con)
protected void	init(Hashtable params) This method gets the Hashtable and initializes the properties
protected void	insertBundleValue(Hashtable values, int sessionId, Connection con)
protected EntityResult	insertNewBundle(String bundleClassName, int sessionId, Connection con)
protected EntityResult	queryBundleValues(Object bundleId, String languageColumn, int sessionId)
void	resultSetToEntityResult(ResultSet resultSet, EntityResult entityResult, List columnNames)
protected void	updateBundleValue(Hashtable filter, Hashtable values, int sessionId, Connection con)
void	updateBundleValues(DatabaseBundleValues dbvalues, int sessionId) Update the specified values in the database bundle
void	updateBundleValues(DatabaseBundleValues dbvalues, int sessionId, Connection con)

Methods inherited from class com.ontimize.util.remote.AbstractRemoteReference

connect, connect, disconnect, getDatabaseConnectionManager, getEntityReference, hasSession

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

BUNDLE_TABLE_NAME

public static final String BUNDLE_TABLE_NAME

See Also:

Constant Field Values

BUNDLE_VALUES_TABLE_NAME

public static final String BUNDLE_VALUES_TABLE_NAME

See Also:

Constant Field Values

BUNDLE_VALUES_ENTITY_NAME

public static final String BUNDLE_VALUES_ENTITY_NAME

See Also:

Constant Field Values

BUNDLE_ENTITY_NAME

public static final String BUNDLE_ENTITY_NAME

See Also:

Constant Field Values

BUNDLE_CLASS_NAME_COLUMN

public static final String BUNDLE_CLASS_NAME_COLUMN

See Also:

Constant Field Values

BUNDLE_DESCRIPTION_COLUMN

public static final String BUNDLE_DESCRIPTION_COLUMN

See Also:

Constant Field Values

BUNDLE_KEY_COLUMN

public static final String BUNDLE_KEY_COLUMN

See Also:

Constant Field Values

BUNDLE_VALUES_KEY_COLUMN

public static final String BUNDLE_VALUES_KEY_COLUMN

See Also:

Constant Field Values

BUNDLE_VALUES_TEXT_KEY_COLUMN

public static final String BUNDLE_VALUES_TEXT_KEY_COLUMN

See Also:

Constant Field Values

DATABASE_CONNECTION_MANAGER_ID

public static final String DATABASE_CONNECTION_MANAGER_ID

See Also:

Constant Field Values

TO_LOWER_CASE

public static final String TO_LOWER_CASE

See Also:

Constant Field Values

AUTOCONFIGURE_LOCALE_COLUMNS

public static final String AUTOCONFIGURE_LOCALE_COLUMNS

See Also:

Constant Field Values

bundleTableName

public static String bundleTableName

bundleValuesTableName

public static String bundleValuesTableName

bundleEntityName

public static String bundleEntityName

bundleValuesEntityName

public static String bundleValuesEntityName

bundleClassNameColumn

public static String bundleClassNameColumn

bundleDescriptionColumn

public static String bundleDescriptionColumn

bundleKeyColumn

public static String bundleKeyColumn

bundleValuesKeyColumn

public static String bundleValuesKeyColumn

bundleValuesTextKeyColumn

public static String bundleValuesTextKeyColumn

toLowerCase

public static Boolean toLowerCase

Boolean to know the names of the columns in the table
Default value is null, to use directly the names in the configuration file or the default ones.
If it is true then use the values but in lower case. If it is false then use the configuration or default values but in upper case

localeColumnNames

protected Hashtable localeColumnNames

autoconfigureLocaleColumns

protected boolean autoconfigureLocaleColumns

Constructor Detail

DatabaseBundleManager

public DatabaseBundleManager(int port,
                     EntityReferenceLocator locator,
                     Hashtable params)
                      throws Exception

Throws:

Exception

Method Detail

init

protected void init(Hashtable params)

This method gets the Hashtable and initializes the properties

Overrides:

init in class AbstractRemoteReference

Parameters:

parameters - the Hashtable with parameters

attribute	values	default	required	meaning
ToLowerCase	yes/no		no	Indicates if the parameter names must be the default ones but in lower or upper case.
BundleTableName		BUNDLES	no	Name of the database table that stores the available bundles. You can use only one bundle in all the application or maybe a different one in a specific form or form manager
BundleEntityName			no	Name of the ontimize entity to manage the table with all the available database bundles.
BundleValuesTableName		BUNDLEVALUES	no	Name of the database table that stores the bundle values. This table must contains a column for each available language.
BundleValuesEntityName			no	Name of the ontimize entity to manage the database bundle values table.
BundleClassNameColumn		BUNDLECLASSNAME	no	Name of the column that stores the bundle class name. This column is in the bundles table.
BundleDescriptionColumn		DESCRIPTION	no	Name of the column that stores the bundle description. This column is in the bundles table.
BundleKeyColumn		IDBUNDLE	no	Name of the column that stores the bundle key. This column is the key in the bundles table.
BundleValuesKeyColumn		IDBUNDLEVALUE	no	Name of the column that stores the bundle values key. This column is the key in the bundles values table.
BundleValuesTextKeyColumn		TEXTKEY	no	Name of the column that stores the text key in the bundle values table.
DBConnectionManagerId			no	Name of the database connection manager that contains the bundle tables. This parameter should be use only when the entities are configured and the application is using more than one connection managers
AutoconfigureLocaleColumns	yes/no	no	no	If this parameter is true then the available languages are the columns in the bundle values table. If this is false then you have to configure a new parameter for each available language

autoconfigureLocaleColumns

protected void autoconfigureLocaleColumns()

getTableNameFromMetadata

protected String getTableNameFromMetadata(String tableName,
                              Connection con)
                                   throws SQLException

Throws:

SQLException

getLocaleString

protected String getLocaleString(String locale)

getAllResourceBundles

public Hashtable getAllResourceBundles(Locale locale,
                              int sessionId)
                                throws Exception

Description copied from interface: IDatabaseBundleManager

Get a hashtable with all the available bundles in the database for the specified locale

Specified by:

getAllResourceBundles in interface IDatabaseBundleManager

Parameters:

locale - Locale

Returns:

The keys of the object are Strings with the bundle class name (for example com.ontimize.gui.i18m.bundle) and each value is the ResourceBundle object

Throws:

Exception

getBundles

public Hashtable getBundles(List baseNames,
                   Locale locale,
                   int sessionId)
                     throws Exception

Description copied from interface: IDatabaseBundleManager

Get all the resources for the specified locale and different names

Specified by:

getBundles in interface IDatabaseBundleManager

Parameters:

baseNames - A list of String objects with the names of the resources to query

locale - Locale

Returns:

Throws:

Exception

getBundle

public ResourceBundle getBundle(String baseName,
                       Locale locale,
                       int sessionId)
                         throws Exception

Description copied from interface: IDatabaseBundleManager

Get the resource bundle for the specified name and locale

Specified by:

getBundle in interface IDatabaseBundleManager

Returns:

Throws:

Exception

getBundle

protected ResourceBundle getBundle(DatabaseBundleDescriptor bundleDescriptor,
                       Locale locale,
                       int sessionId)
                            throws Exception

Throws:

Exception

queryBundleValues

protected EntityResult queryBundleValues(Object bundleId,
                             String languageColumn,
                             int sessionId)
                                  throws Exception

Throws:

Exception

getColumnName

protected String getColumnName(Locale locale)

getBundleDescriptor

protected DatabaseBundleDescriptor getBundleDescriptor(String bundleClassName,
                                           int sessionId)
                                                throws Exception

Throws:

Exception

getAvailableBundles

public DatabaseBundleDescriptor[] getAvailableBundles(int sessionId,
                                             Connection con)
                                               throws Exception

Get all the available bundles in the database.
If (DatabaseBundleManager.bundleValuesEntityName is not null and a entity with this name exists then use this entity to query the available bundles.
If (DatabaseBundleManager.bundleValuesEntityName is null and bundleTableName is not null then query the table directly. In other case return null

Returns:

Throws:

Exception

getAvailableBundles

public DatabaseBundleDescriptor[] getAvailableBundles(int sessionId)
                                               throws Exception

Description copied from interface: IDatabaseBundleManager

Get a list with all the available bundle classes

Specified by:

getAvailableBundles in interface IDatabaseBundleManager

Returns:

Throws:

Exception

getAvailableLocales

public String[] getAvailableLocales(int sessionId)
                             throws Exception

Description copied from interface: IDatabaseBundleManager

Get a list with the suffix of the available locales in the database

Specified by:

getAvailableLocales in interface IDatabaseBundleManager

Returns:

Throws:

Exception

updateBundleValues

public void updateBundleValues(DatabaseBundleValues dbvalues,
                      int sessionId)
                        throws Exception

Description copied from interface: IDatabaseBundleManager

Update the specified values in the database bundle

Specified by:

updateBundleValues in interface IDatabaseBundleManager

Throws:

Exception

updateBundleValues

public void updateBundleValues(DatabaseBundleValues dbvalues,
                      int sessionId,
                      Connection con)
                        throws Exception

Throws:

Exception

updateBundleValue

protected void updateBundleValue(Hashtable filter,
                     Hashtable values,
                     int sessionId,
                     Connection con)
                          throws Exception

Throws:

Exception

insertBundleValue

protected void insertBundleValue(Hashtable values,
                     int sessionId,
                     Connection con)
                          throws Exception

Throws:

Exception

getBundleValueKey

protected Object getBundleValueKey(Hashtable filter,
                       int sessionId,
                       Connection con)
                            throws Exception

Throws:

Exception

getBundleId

protected Object getBundleId(String bundleClassName,
                 List availablebundles,
                 int sessionId,
                 Connection con)
                      throws Exception

Throws:

Exception

insertNewBundle

protected EntityResult insertNewBundle(String bundleClassName,
                           int sessionId,
                           Connection con)
                                throws Exception

Throws:

Exception

executeUpdateStatement

protected void executeUpdateStatement(SQLStatementBuilder.SQLStatement sqlStatement,
                          int sessionId,
                          Connection con)
                               throws Exception

Throws:

Exception

executeQueryStatement

protected EntityResult executeQueryStatement(SQLStatementBuilder.SQLStatement sqlStatement,
                                 int sessionId,
                                 List queryColumns,
                                 Connection con)
                                      throws Exception

Throws:

Exception

executePreparedStatement

public EntityResult executePreparedStatement(SQLStatementBuilder.SQLStatement sqlStatement,
                                    Connection con,
                                    int sessionId,
                                    List queryColumns)
                                      throws Exception

Throws:

Exception

resultSetToEntityResult

public void resultSetToEntityResult(ResultSet resultSet,
                           EntityResult entityResult,
                           List columnNames)
                             throws Exception

Throws:

Exception