com.dpslink.base.jdbc

Class JDBCUtil

java.lang.Object

com.dpslink.base.jdbc.JDBCUtil

All Implemented Interfaces:

java.io.Serializable

public class JDBCUtil
extends java.lang.Object
implements java.io.Serializable

A utility class that contains miscellaneous JDBC helper methods.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static java.text.DateFormat	FMT_DATE The formatter used to convert date strings (JDBCUtil.format.date).
private static java.text.DateFormat	FMT_TIME The formatter used to convert time strings (JDBCUtil.format.time).
private static java.text.DateFormat	FMT_TS The formatter used to convert timestamp strings (JDBCUtil.format.timestamp).
private static java.lang.String[]	RESERVED The configured set of SQL reserved words (JDBCUtil.reserved.words).
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
JDBCUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	copyTable(JDBCConnectionInfo cninf, java.lang.String source, java.lang.String target) Copies data from a source table to a target table.
static int	countIndexes(JDBCConnectionInfo cninf, java.lang.String tblname) Returns the number of existing indexes in the database for a table.
static int	countTableColumns(JDBCConnectionInfo cninf, java.lang.String tblname) Returns the number of existing columns in the database for a table.
static int	countTables(JDBCConnectionInfo cninf) Returns the number of existing tables in the database.
static int	countViews(JDBCConnectionInfo cninf) Returns the number of existing views in the database.
static boolean	createIndex(JDBCConnectionInfo cninf, java.lang.String tblname) Creates a database table's indexes using definitions in the application's resource file.
static boolean	createTable(JDBCConnectionInfo cninf, java.lang.String tblname) Creates a database table using definitions in the application's resource file.
static boolean	createTable(JDBCConnectionInfo cninf, java.lang.String source, java.lang.String target) Creates a database table that mirrors the definition of an existing table.
static boolean	createView(JDBCConnectionInfo cninf, java.lang.String viewname) Creates a database view using definitions in the application's resource file.
static java.lang.String	dateToString(java.sql.Date date) Returns a date string for the given date using the FMT_DATE formatter to format the date.
static java.lang.String	dateToString(java.util.Date date) Returns a date string for the given date using the FMT_DATE formatter to format the date.
static boolean	deleteIndex(JDBCConnectionInfo cninf, java.lang.String tblname) Deletes a database table's existing indexes.
static boolean	deleteTable(JDBCConnectionInfo cninf, java.lang.String tblname) Deletes an existing database table.
static boolean	deleteView(JDBCConnectionInfo cninf, java.lang.String viewname) Deletes an existing database view.
static void	dumpFieldNames(java.sql.ResultSet rs) Dumps the given result set's field names to System.out.
static void	dumpFieldValues(java.sql.ResultSet rs) Dumps the given result set's field value to System.out.
static java.lang.String	getMetaSchema(JDBCConnectionInfo cninf) Returns the schema name required when obtaining various types of database metadata from a JDBC connection; such as tables, columns, keys, and views.
static java.sql.ResultSet	getRSColumn(JDBCConnectionInfo cninf, java.lang.String tblname, java.lang.String colname) Returns a result set of the columns in the given table.
static java.sql.ResultSet	getRSColumns(JDBCConnectionInfo cninf, java.lang.String tblname) Returns a result set of the columns in the given table.
static java.sql.ResultSet	getRSIndexes(JDBCConnectionInfo cninf, java.lang.String tblname) Returns a result set of all indexes in the database for the given table.
static java.sql.ResultSet	getRSPrimary(JDBCConnectionInfo cninf, java.lang.String tblname) Returns a result set of the primary keys in the given table.
static java.sql.ResultSet	getRSTable(JDBCConnectionInfo cninf, java.lang.String tableName) Returns a result set of the given table in the database.
static java.sql.ResultSet	getRSTables(JDBCConnectionInfo cninf) Returns a result set of the tables in the database.
static java.sql.ResultSet	getRSTypes(JDBCConnectionInfo cninf) Returns a result set of the supported sql types in the database.
static java.sql.ResultSet	getRSViews(JDBCConnectionInfo cninf) Returns a result set of the views in the database.
static java.util.ArrayList<java.lang.String>	getTableNames(JDBCConnectionInfo cninf) Returns the names of the tables in the database in table name sequence.
static java.lang.String	getTablePrimary(JDBCConnectionInfo cninf, java.lang.String tblname) Returns a comma delimited string of a table's primary key field names.
static java.sql.ResultSet	getTableRecords(JDBCConnectionInfo cninf, java.lang.String tblname) Returns a result set of the records in a database table.
static java.util.ArrayList<java.lang.String>	getViewNames(JDBCConnectionInfo cninf) Returns the names of the views in the database in view name sequence.
static java.lang.String	quoteUnsafeWord(java.lang.String word) Returns a quoted upper case word for a given word.
static java.lang.String	quoteUnsafeWords(java.lang.String words) Returns quoted upper case words for a given set of comma delimited words.
static java.lang.String[]	quoteUnsafeWords(java.lang.String[] words) Returns quoted upper case words for a given array of words.
static boolean	reorgTable(JDBCConnectionInfo cninf, java.lang.String tblname) Reorganizes the table with the given name.
static java.lang.String	statusToString(java.lang.String code) Returns a formatted string for the given object status code.
static java.sql.Date	stringToDate(java.lang.String date) Returns a date object for the given date string using the FMT_DATE formatter to parse the given string.
static java.sql.Timestamp	stringToTimestamp(java.lang.String ts) Returns a timestamp object for the given timestamp string using the FMT_TS formatter to parse the given string.
static java.lang.String	timestampToString(java.sql.Timestamp ts) Returns a timestamp string for the given time using the FMT_TS formatter to format the timestamp.
static java.lang.String	timeToString(java.sql.Date date) Returns a time string for the given date using the FMT_TIME formatter to format the date.
static java.lang.String	timeToString(java.util.Date date) Returns a time string for the given date using the FMT_TIME formatter to format the date.
static java.lang.String	unquoteWord(java.lang.String word) Removes beginning and ending double quotes from a word.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

FMT_DATE

private static final java.text.DateFormat FMT_DATE

The formatter used to convert date strings (JDBCUtil.format.date).

FMT_TIME

private static final java.text.DateFormat FMT_TIME

The formatter used to convert time strings (JDBCUtil.format.time).

FMT_TS

private static final java.text.DateFormat FMT_TS

The formatter used to convert timestamp strings (JDBCUtil.format.timestamp).

RESERVED

private static final java.lang.String[] RESERVED

The configured set of SQL reserved words (JDBCUtil.reserved.words).

Constructor Detail

JDBCUtil

public JDBCUtil()

Method Detail

copyTable

public static boolean copyTable(JDBCConnectionInfo cninf,
                                java.lang.String source,
                                java.lang.String target)

Copies data from a source table to a target table. Any existing data in in the target table is deleted before the copying is performed.

NOTE: The target table need not be an exact mirror of the source table; however, fields in the two tables having the same name must be the same data type.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

source - (String) The name of the database table that contains the data to copy.

target - (String) The name of the database table where the data is to be copied.

Returns:

boolean - true if the copying is successful, otherwise false.

countIndexes

public static int countIndexes(JDBCConnectionInfo cninf,
                               java.lang.String tblname)

Returns the number of existing indexes in the database for a table.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of a table.

Returns:

int - The number of existing indexes.

countTables

public static int countTables(JDBCConnectionInfo cninf)

Returns the number of existing tables in the database.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

int - The number of existing tables.

countTableColumns

public static int countTableColumns(JDBCConnectionInfo cninf,
                                    java.lang.String tblname)

Returns the number of existing columns in the database for a table.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of a database table.

Returns:

int - The number of existing columns for the table.

countViews

public static int countViews(JDBCConnectionInfo cninf)

Returns the number of existing views in the database.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

int - The number of existing views.

createIndex

public static boolean createIndex(JDBCConnectionInfo cninf,
                                  java.lang.String tblname)

Creates a database table's indexes using definitions in the application's resource file.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of a database table.

Returns:

boolean - true if the database index create is successful, otherwise false.

createTable

public static boolean createTable(JDBCConnectionInfo cninf,
                                  java.lang.String tblname)

Creates a database table using definitions in the application's resource file.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of a database table.

Returns:

boolean - true if the database table create is successful, otherwise false.

createTable

public static boolean createTable(JDBCConnectionInfo cninf,
                                  java.lang.String source,
                                  java.lang.String target)

Creates a database table that mirrors the definition of an existing table.

NOTE: This method only creates the new table and its primary key. This method does not copy any data from the existing table.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

source - (String) The name of an existing database table.

target - (String) The name of the database table to create.

Returns:

boolean - true if the database table create is successful, otherwise false.

createView

public static boolean createView(JDBCConnectionInfo cninf,
                                 java.lang.String viewname)

Creates a database view using definitions in the application's resource file.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

viewname - (String) The name of a database view.

Returns:

boolean - true if the database view create is successful, otherwise false.

deleteIndex

public static boolean deleteIndex(JDBCConnectionInfo cninf,
                                  java.lang.String tblname)

Deletes a database table's existing indexes.

NOTE: This method assumes a database table will not have more than 10 indexes.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of a database table.

Returns:

boolean - true if the database index delete is successful, otherwise false.

deleteTable

public static boolean deleteTable(JDBCConnectionInfo cninf,
                                  java.lang.String tblname)

Deletes an existing database table.

NOTE: This method assumes all indexes for the table have already been deleted as well as any views that are based on the table.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of a database table.

Returns:

boolean - true if the database table delete is successful, otherwise false.

deleteView

public static boolean deleteView(JDBCConnectionInfo cninf,
                                 java.lang.String viewname)

Deletes an existing database view.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

viewname - (String) The name of a database view.

Returns:

boolean - true if the database table delete is successful, otherwise false.

dumpFieldNames

public static void dumpFieldNames(java.sql.ResultSet rs)
                           throws java.lang.Exception

Dumps the given result set's field names to System.out.

Parameters:

rs - (ResultSet) A result set.

Throws:

java.lang.Exception - - if an error occurs while processing the result set.

dumpFieldValues

public static void dumpFieldValues(java.sql.ResultSet rs)
                            throws java.lang.Exception

Dumps the given result set's field value to System.out.

Parameters:

rs - (ResultSet) A result set.

Throws:

java.lang.Exception - - if an error occurs while processing the result set.

getMetaSchema

public static java.lang.String getMetaSchema(JDBCConnectionInfo cninf)

Returns the schema name required when obtaining various types of database metadata from a JDBC connection; such as tables, columns, keys, and views. Returns null if a schema name is not needed when obtaining a connection's database metadata information.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

String - The connection's metadata schema name.

getRSColumn

public static java.sql.ResultSet getRSColumn(JDBCConnectionInfo cninf,
                                             java.lang.String tblname,
                                             java.lang.String colname)
                                      throws java.lang.Exception

Returns a result set of the columns in the given table. The result set is in sequence according to ordinal_position.

The invoker of this method is responsible for closing the result set.

In JDK 1.3.1 javadocs, Sun documents the result set column names as follows; however, not all databases use these column names. For this reason, values should be retrieved from the result set using the column indexes.

• 1. table_cat
• 2. table_schem
• 3. table_name
• 4. column_name
• 5. data_type
• 6. type_name
• 7. column_size
• 8. buffer_length
• 9. decimal_digits
• 10. num_prec_radix
• 11. nullable
• 12. remarks
• 13. column_def
• 14. sql_data_type
• 15. sql_datetime_sub
• 16. char_octet_length
• 17. ordinal_position
• 18. is_nullable

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of a table in the database.

colname - (String) The name of a column in the table.

Returns:

ResultSet - The column in the table.

Throws:

java.lang.Exception - - if an error occurs when obtaining the result set.

getRSColumns

public static java.sql.ResultSet getRSColumns(JDBCConnectionInfo cninf,
                                              java.lang.String tblname)
                                       throws java.lang.Exception

Returns a result set of the columns in the given table. The result set is in sequence according to ordinal_position.

The invoker of this method is responsible for closing the result set.

In JDK 1.3.1 javadocs, Sun documents the result set column names as follows; however, not all databases use these column names. For this reason, values should be retrieved from the result set using the column indexes.

• 1. table_cat
• 2. table_schem
• 3. table_name
• 4. column_name
• 5. data_type
• 6. type_name
• 7. column_size
• 8. buffer_length
• 9. decimal_digits
• 10. num_prec_radix
• 11. nullable
• 12. remarks
• 13. column_def
• 14. sql_data_type
• 15. sql_datetime_sub
• 16. char_octet_length
• 17. ordinal_position
• 18. is_nullable

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of a table in the database.

Returns:

ResultSet - The columns in the table.

Throws:

java.lang.Exception - - if an error occurs when obtaining the result set.

getRSIndexes

public static java.sql.ResultSet getRSIndexes(JDBCConnectionInfo cninf,
                                              java.lang.String tblname)
                                       throws java.lang.Exception

Returns a result set of all indexes in the database for the given table. The result set is in sequence according to non_unique, type, index_name and ordinal_position.

The invoker of this method is responsible for closing the result set.

In JDK 1.3.1 javadocs, Sun documents the result set column names as follows; however, not all databases use these column names. For this reason, values should be retrieved from the result set using the column indexes.

• 1. table_cat
• 2. table_schem
• 3. table_name
• 4. non_unique
• 5. index_qualifier
• 6. index_name
• 7. type
• 8. ordinal_position
• 9. column_name
• 10. asc_or_desc
• 11. cardinality
• 12. pages
• 13. filter_condition

NOTE: When this method is invoked against an IBM DB2 System i (AS/400) native database, the above column information is imitated, as much as is possible, by the SQL.@base.getIndexes SQL statement.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of a table in the database.

Returns:

ResultSet - All indexes in the database for the given table.

Throws:

java.lang.Exception - - if an error occurs while obtaining the result set.

getRSPrimary

public static java.sql.ResultSet getRSPrimary(JDBCConnectionInfo cninf,
                                              java.lang.String tblname)
                                       throws java.lang.Exception

Returns a result set of the primary keys in the given table. The result set is in sequence according to key_seq.

The invoker of this method is responsible for closing the result set.

In JDK 1.3.1 javadocs, Sun documents the result set column names as follows; however, not all databases use these column names. For this reason, values should be retrieved from the result set using the column indexes.

• 1. table_cat
• 2. table_schem
• 3. table_name
• 4. column_name
• 5. key_seq
• 6. pk_name

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

ResultSet - The primary keys in the table.

Throws:

java.lang.Exception - - if an error occurs when obtaining the result set.

getRSTables

public static java.sql.ResultSet getRSTables(JDBCConnectionInfo cninf)
                                      throws java.lang.Exception

Returns a result set of the tables in the database. The result set is in sequence according to table_name.

The invoker of this method is responsible for closing the result set.

In JDK 1.3.1 javadocs, Sun documents the result set column names as follows; however, not all databases use these column names. For this reason, values should be retrieved from the result set using the column indexes.

• 1. table_cat
• 2. table_schem
• 3. table_name
• 4. table_type
• 5. remarks

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

ResultSet - The tables in the database.

Throws:

java.lang.Exception - - if an error occurs when obtaining the result set.

getRSTable

public static java.sql.ResultSet getRSTable(JDBCConnectionInfo cninf,
                                            java.lang.String tableName)
                                     throws java.lang.Exception

Returns a result set of the given table in the database.

The invoker of this method is responsible for closing the result set.

In JDK 1.3.1 javadocs, Sun documents the result set column names as follows; however, not all databases use these column names. For this reason, values should be retrieved from the result set using the column indexes.

• 1. table_cat
• 2. table_schem
• 3. table_name
• 4. table_type
• 5. remarks

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tableName - (String) Table name to retrieve meta data.

Returns:

ResultSet - The table in the database.

Throws:

java.lang.Exception - - if an error occurs when obtaining the result set.

getRSTypes

public static java.sql.ResultSet getRSTypes(JDBCConnectionInfo cninf)
                                     throws java.lang.Exception

Returns a result set of the supported sql types in the database.

The invoker of this method is responsible for closing the result set.

In JDK 1.3.1 javadocs, Sun documents the result set column names as follows; however, not all databases use these column names. For this reason, values should be retrieved from the result set using the column indexes.

• 1. type_name
• 2. data_type
• 3. precision
• 4. literal_prefix
• 5. literal_suffix
• 6. create_params
• 7. nullable
• 8. case_sensitive
• 9. searchable
• 10. unsigned_attribute
• 11. fixed_prec_scale
• 12. auto_increment
• 13. local_type_name
• 14. minimum_scale
• 15. maximum_scale
• 16. sql_data_type
• 17. sql_datetime_sub
• 18. num_prec_radix

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

ResultSet - The supported sql types.

Throws:

java.lang.Exception - - if an error occurs when obtaining the result set.

getRSViews

public static java.sql.ResultSet getRSViews(JDBCConnectionInfo cninf)
                                     throws java.lang.Exception

Returns a result set of the views in the database. The result set is in sequence according to view name.

The invoker of this method is responsible for closing the result set.

In JDK 1.3.1 javadocs, Sun documents the result set column names as follows; however, not all databases use these column names. For this reason, values should be retrieved from the result set using the column indexes.

• 1. table_cat
• 2. table_schem
• 3. table_name
• 4. table_type
• 5. remarks

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

ResultSet - The views in the database.

Throws:

java.lang.Exception - - if an error occurs when obtaining the result set.

getTableNames

public static java.util.ArrayList<java.lang.String> getTableNames(JDBCConnectionInfo cninf)

Returns the names of the tables in the database in table name sequence.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

ArrayList - The database table names.

getTablePrimary

public static java.lang.String getTablePrimary(JDBCConnectionInfo cninf,
                                               java.lang.String tblname)

Returns a comma delimited string of a table's primary key field names. The fields appear in the order specified when the primary key was created.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of a database table.

Returns:

String - The table's primary key field names.

getTableRecords

public static java.sql.ResultSet getTableRecords(JDBCConnectionInfo cninf,
                                                 java.lang.String tblname)

Returns a result set of the records in a database table. The result set is in sequence according to the table's primary key fields.

NOTE: The invoker of this method is responsible for closing the result set as well as the SQL statement used to create the result set.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of a database table.

Returns:

ResultSet - The records in the table.

getViewNames

public static java.util.ArrayList<java.lang.String> getViewNames(JDBCConnectionInfo cninf)

Returns the names of the views in the database in view name sequence.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

Returns:

ArrayList - The database view names.

quoteUnsafeWord

public static java.lang.String quoteUnsafeWord(java.lang.String word)

Returns a quoted upper case word for a given word. The given word is only quoted and upper cased if it contains characters that would cause an SQL statement to fail (such as "@", "#" or "$") or if the word is a reserved word per the RESERVED constant.

Parameters:

word - (String) The word to process.

Returns:

String - The processed word.

quoteUnsafeWords

public static java.lang.String quoteUnsafeWords(java.lang.String words)

Returns quoted upper case words for a given set of comma delimited words. The words in the given set are only quoted and upper cased if they contain characters that would cause an SQL statement to fail (such as "@", "#", "$") or if a word is a reserved word per the RESERVED constant.

Parameters:

words - (String) A set of comma delimited words.

Returns:

String - The processed set of words.

quoteUnsafeWords

public static java.lang.String[] quoteUnsafeWords(java.lang.String[] words)

Returns quoted upper case words for a given array of words. The words in the given array are only quoted and upper cased if they contain characters that would cause an SQL statement to fail (such as "@", "#", "$") or if a word is a reserved word per the RESERVED constant.

Parameters:

words - (String[]) An array of words.

Returns:

String[] - The processed array of words.

reorgTable

public static boolean reorgTable(JDBCConnectionInfo cninf,
                                 java.lang.String tblname)

Reorganizes the table with the given name. The table's indexes are also reorganized.

Parameters:

cninf - (JDBCConnectionInfo) The JDBC connection to use.

tblname - (String) The name of the table to reorganize.

Returns:

boolean - true if the reorganization completes successfully, otherwise false.

dateToString

public static java.lang.String dateToString(java.sql.Date date)

Returns a date string for the given date using the FMT_DATE formatter to format the date.

Parameters:

date - (java.sql.Date) A date object.

Returns:

String - The date converted to a string.

dateToString

public static java.lang.String dateToString(java.util.Date date)

Returns a date string for the given date using the FMT_DATE formatter to format the date.

Parameters:

date - (java.util.Date) A date object.

Returns:

String - The date converted to a string.

timeToString

public static java.lang.String timeToString(java.sql.Date date)

Returns a time string for the given date using the FMT_TIME formatter to format the date.

Parameters:

date - (java.sql.Date) A date object.

Returns:

String - The date converted to a string.

timeToString

public static java.lang.String timeToString(java.util.Date date)

Returns a time string for the given date using the FMT_TIME formatter to format the date.

Parameters:

date - (java.util.Date) A date object.

Returns:

String - The date converted to a string.

timestampToString

public static java.lang.String timestampToString(java.sql.Timestamp ts)

Returns a timestamp string for the given time using the FMT_TS formatter to format the timestamp.

Parameters:

ts - (java.sql.Timestamp) A timestamp object.

Returns:

String - The timestamp converted to a string.

stringToDate

public static java.sql.Date stringToDate(java.lang.String date)

Returns a date object for the given date string using the FMT_DATE formatter to parse the given string.

Parameters:

date - (String) A date formatted string.

Returns:

java.sql.Date - The string converted to a date.

stringToTimestamp

public static java.sql.Timestamp stringToTimestamp(java.lang.String ts)

Returns a timestamp object for the given timestamp string using the FMT_TS formatter to parse the given string.

Parameters:

ts - (String) A timestamp formatted string.

Returns:

java.sql.Timestamp - The string converted to a timestamp.

statusToString

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

Returns a formatted string for the given object status code. The returned string is based on the "JDBCUtil.format.status" definitions in properties.

Parameters:

code - (String) The status code to format.

Returns:

String - The code's formatted string.

unquoteWord

public static java.lang.String unquoteWord(java.lang.String word)

Removes beginning and ending double quotes from a word.

Parameters:

word - (String) The word to process.

Returns:

String - The processed word.