com.google.enterprise.connector.util.database

Class DatabasePropertyResourceBundle

java.lang.Object

com.google.enterprise.connector.util.database.DatabasePropertyResourceBundle

All Implemented Interfaces:

DatabaseResourceBundle

public class DatabasePropertyResourceBundle
extends java.lang.Object
implements DatabaseResourceBundle

Supplies SQL language syntax variations for the various database implementations. This mirrors PropertyResourceBundle in form and function, but is designed to supply SQL language translations rather than spoken language translations.

DatabasePropertyResourceBundles are typically loaded using a DatabaseResourceBundleManager.

Like java.util.PropertyResourceBundle, DatabaseResourceBundle resources are specified in Properties files. Unlike PropertyResourceBundle, DatabaseResourceBundle uses the EProperties enhanced Properties package, which extends the standard java.util.Properties and syntax to include things like: variable substitution, nesting, inclusion and lists. For instance:

• Variable substitution syntax that mirrors the syntax used in shell scripts, ant, etc.:

   table.name = connector_instances
   getvalue.query = "SELECT ${column.connector.name} FROM ${table.name} ..."
   

  Variables may be defined in the DatabaseResourceBundle in which they are used, or any of the ancestor DatabaseResourceBundles (see below). Variable substitution is done at the time of the call to getString(String) or getStringArray(String), so the returned string(s) have all known substitutions resolved.
• Lists that may be fetched as an array of Strings - great for potentially multi-statement DDL. For instance, this table creation DDL resource definition consists of three distinct SQL statements:

   create.table.ddl = ( "CREATE TABLE ...", "CREATE TRIGGER ...", "CREATE INDEX ..." )
   

  which can be retrieved using getStringArray(String):

   String[] ddlStatements = bundle.getStringArray("create.table.ddl");
   

Since:

2.8

Constructor Summary

Constructors

Constructor and Description
DatabasePropertyResourceBundle(java.net.URL resourceUrl, DatabasePropertyResourceBundle parent) Creates a DatabaseResourceBundle backed by the properties loaded from the resourceUrl and the given parent.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getString(java.lang.String key) Gets a string for the given key from this resource bundle or one of its parents.
java.lang.String[]	getStringArray(java.lang.String key) Gets an array of Strings for the given key from this resource bundle or one of its parents.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabasePropertyResourceBundle

public DatabasePropertyResourceBundle(java.net.URL resourceUrl,
                                      DatabasePropertyResourceBundle parent)
                               throws java.io.IOException

Creates a DatabaseResourceBundle backed by the properties loaded from the resourceUrl and the given parent.

Parameters:

resourceUrl - the resource URL from which to read Properties

parent - parent the DatabasePropertyResourceBundle to assign as parent - may be null

Throws:

java.lang.NullPointerException - if resourceUrl is null

java.io.IOException - if there is an error reading the resource file

Method Detail

getString

public java.lang.String getString(java.lang.String key)

Gets a string for the given key from this resource bundle or one of its parents.

Specified by:

getString in interface DatabaseResourceBundle

Parameters:

key - the key for the desired string

Returns:

the String for the given key, or null if no resource was found for this key

Throws:

java.lang.NullPointerException - if key is null

getStringArray

public java.lang.String[] getStringArray(java.lang.String key)

Gets an array of Strings for the given key from this resource bundle or one of its parents.

Specified by:

getStringArray in interface DatabaseResourceBundle

Parameters:

key - the key for the desired string array

Returns:

a String[] for the given key, or null if no resource was found for this key

Throws:

java.lang.NullPointerException - if key is null