From 2d073129857a42ab4195cd433c8be152e357033f Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 20:40:57 +0000 Subject: Documentation refresh; ResourceBundle in ShowUtils; probably some format pokery. --- doc/uk/org/ury/database/DatabaseDriver.html | 31 ++++++++----------- doc/uk/org/ury/database/DatabaseItem.html | 15 ++++------ doc/uk/org/ury/database/UserClass.html | 20 ++++++------- .../org/ury/database/class-use/DatabaseDriver.html | 12 ++++---- .../org/ury/database/class-use/DatabaseItem.html | 6 ++-- doc/uk/org/ury/database/class-use/UserClass.html | 10 +++---- .../exceptions/ConnectionFailureException.html | 4 +-- .../exceptions/MissingCredentialsException.html | 4 +-- .../exceptions/MissingPropertyException.html | 4 +-- .../database/exceptions/QueryFailureException.html | 4 +-- .../class-use/ConnectionFailureException.html | 10 +++---- .../class-use/MissingCredentialsException.html | 10 +++---- .../class-use/MissingPropertyException.html | 6 ++-- .../class-use/QueryFailureException.html | 8 ++--- .../org/ury/database/exceptions/package-frame.html | 4 +-- .../ury/database/exceptions/package-summary.html | 19 ++++++++++-- .../org/ury/database/exceptions/package-tree.html | 4 +-- .../org/ury/database/exceptions/package-use.html | 8 ++--- doc/uk/org/ury/database/package-frame.html | 4 +-- doc/uk/org/ury/database/package-summary.html | 33 +++++++++++++++----- doc/uk/org/ury/database/package-tree.html | 4 +-- doc/uk/org/ury/database/package-use.html | 35 ++++++++++------------ 22 files changed, 137 insertions(+), 118 deletions(-) (limited to 'doc/uk/org/ury/database') diff --git a/doc/uk/org/ury/database/DatabaseDriver.html b/doc/uk/org/ury/database/DatabaseDriver.html index 7bd5c25..e308ac0 100644 --- a/doc/uk/org/ury/database/DatabaseDriver.html +++ b/doc/uk/org/ury/database/DatabaseDriver.html @@ -2,12 +2,12 @@ - + DatabaseDriver - + @@ -101,9 +101,8 @@ java.lang.Object

-A database connection manager that connects to the URY databases - using suitably privileged accounts, and handles the processing - of SQL queries. +A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.

@@ -195,13 +194,10 @@ public DatabaseDriver(MissingCredentialsException - if the user class - login credentials could not be loaded. -

ConnectionFailureException - if the database - backend failed to connect to the database - server. +
java.lang.IllegalArgumentException - if the user class is not supported (this should not happen). +
MissingCredentialsException - if the user class login credentials could not be loaded. +
ConnectionFailureException - if the database backend failed to connect to the database + server. @@ -242,17 +238,16 @@ public java.sql.ResultSet executeQuery(java.lang.String sql,
Perform a SQL statement with arguments. - This accepts an array of parameter objects, which must each - either be String or Integer objects. The objects will be used - sequentially to fill in '?' placeholders in the query text. + This accepts an array of parameter objects, which must each either be + String or Integer objects. The objects will be used sequentially to fill + in '?' placeholders in the query text.

Parameters:
sql - The SQL statement to execute.
params - A list of parameter objects.
fetchSize - The maximum number of query rows to return.
Returns:
the set of results from the query.
Throws: -
java.lang.IllegalArgumentException - if any of the - parameters is unsupported by the database as - a statement parameter. +
java.lang.IllegalArgumentException - if any of the parameters is unsupported by the database as a + statement parameter.
java.sql.SQLException - if a SQL error occurs.
diff --git a/doc/uk/org/ury/database/DatabaseItem.html b/doc/uk/org/ury/database/DatabaseItem.html index 1f2da1b..434c9f9 100644 --- a/doc/uk/org/ury/database/DatabaseItem.html +++ b/doc/uk/org/ury/database/DatabaseItem.html @@ -2,12 +2,12 @@ - + DatabaseItem - + @@ -104,9 +104,8 @@ java.lang.Object

-An abstract class presenting a template for objects serving as - a data structure for collections of properties retrieved from - a SQL database. +An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.

@@ -197,8 +196,7 @@ public DatabaseItem(java.util.Map<MissingPropertyException - if the property does - not exist. +

MissingPropertyException - if the property does not exist.
diff --git a/doc/uk/org/ury/database/UserClass.html b/doc/uk/org/ury/database/UserClass.html index d9231d8..4fcd92e 100644 --- a/doc/uk/org/ury/database/UserClass.html +++ b/doc/uk/org/ury/database/UserClass.html @@ -2,12 +2,12 @@ - + UserClass - + @@ -107,11 +107,11 @@ java.lang.Object

The various user classes of the database driver. - These refer to various users in the database proper, and thus - grant various levels of permission to the program. + These refer to various users in the database proper, and thus grant various + levels of permission to the program. - Please use the least privileged user class that works. For most - cases, READ_ONLY should work perfectly. + Please use the least privileged user class that works. For most cases, + READ_ONLY should work perfectly.

@@ -157,8 +157,8 @@ The various user classes of the database driver. configName
-          The name of the tag in the configuration file that contains - the credentials for this user class. +          The name of the tag in the configuration file that contains the + credentials for this user class.   @@ -253,8 +253,8 @@ configName 

 public java.lang.String configName
-
The name of the tag in the configuration file that contains - the credentials for this user class. +
The name of the tag in the configuration file that contains the + credentials for this user class.

diff --git a/doc/uk/org/ury/database/class-use/DatabaseDriver.html b/doc/uk/org/ury/database/class-use/DatabaseDriver.html index ac09e36..96209b1 100644 --- a/doc/uk/org/ury/database/class-use/DatabaseDriver.html +++ b/doc/uk/org/ury/database/class-use/DatabaseDriver.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.DatabaseDriver - + @@ -95,7 +95,7 @@ Packages that use uk.org.ury.server -   +The URY Server kernel.  uk.org.ury.show @@ -150,7 +150,7 @@ Uses of getDatabaseConnection(UserClass userClass)
-          Get a database connection using the given user class. +          Gets a database connection using the given user class.   @@ -177,8 +177,8 @@ Uses of diff --git a/doc/uk/org/ury/database/class-use/DatabaseItem.html b/doc/uk/org/ury/database/class-use/DatabaseItem.html index e0d5953..b326c06 100644 --- a/doc/uk/org/ury/database/class-use/DatabaseItem.html +++ b/doc/uk/org/ury/database/class-use/DatabaseItem.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.DatabaseItem - + @@ -95,7 +95,7 @@ Packages that use uk.org.ury.show.item -   +The show item class and related properties.    diff --git a/doc/uk/org/ury/database/class-use/UserClass.html b/doc/uk/org/ury/database/class-use/UserClass.html index 8859b2c..9737548 100644 --- a/doc/uk/org/ury/database/class-use/UserClass.html +++ b/doc/uk/org/ury/database/class-use/UserClass.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.UserClass - + @@ -91,11 +91,11 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.  uk.org.ury.server -   +The URY Server kernel.    @@ -169,7 +169,7 @@ Uses of getDatabaseConnection(UserClass userClass)
-          Get a database connection using the given user class. +          Gets a database connection using the given user class.   diff --git a/doc/uk/org/ury/database/exceptions/ConnectionFailureException.html b/doc/uk/org/ury/database/exceptions/ConnectionFailureException.html index 66133bf..1c903a2 100644 --- a/doc/uk/org/ury/database/exceptions/ConnectionFailureException.html +++ b/doc/uk/org/ury/database/exceptions/ConnectionFailureException.html @@ -2,12 +2,12 @@ - + ConnectionFailureException - + diff --git a/doc/uk/org/ury/database/exceptions/MissingCredentialsException.html b/doc/uk/org/ury/database/exceptions/MissingCredentialsException.html index 9c54154..a0be23f 100644 --- a/doc/uk/org/ury/database/exceptions/MissingCredentialsException.html +++ b/doc/uk/org/ury/database/exceptions/MissingCredentialsException.html @@ -2,12 +2,12 @@ - + MissingCredentialsException - + diff --git a/doc/uk/org/ury/database/exceptions/MissingPropertyException.html b/doc/uk/org/ury/database/exceptions/MissingPropertyException.html index b31fb44..90079f5 100644 --- a/doc/uk/org/ury/database/exceptions/MissingPropertyException.html +++ b/doc/uk/org/ury/database/exceptions/MissingPropertyException.html @@ -2,12 +2,12 @@ - + MissingPropertyException - + diff --git a/doc/uk/org/ury/database/exceptions/QueryFailureException.html b/doc/uk/org/ury/database/exceptions/QueryFailureException.html index ecb2a3b..f6c3ffc 100644 --- a/doc/uk/org/ury/database/exceptions/QueryFailureException.html +++ b/doc/uk/org/ury/database/exceptions/QueryFailureException.html @@ -2,12 +2,12 @@ - + QueryFailureException - + diff --git a/doc/uk/org/ury/database/exceptions/class-use/ConnectionFailureException.html b/doc/uk/org/ury/database/exceptions/class-use/ConnectionFailureException.html index ea4b6e8..538b71f 100644 --- a/doc/uk/org/ury/database/exceptions/class-use/ConnectionFailureException.html +++ b/doc/uk/org/ury/database/exceptions/class-use/ConnectionFailureException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.exceptions.ConnectionFailureException - + @@ -91,11 +91,11 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.  uk.org.ury.server -   +The URY Server kernel.    @@ -144,7 +144,7 @@ Uses of getDatabaseConnection(UserClass userClass)
-          Get a database connection using the given user class. +          Gets a database connection using the given user class.   diff --git a/doc/uk/org/ury/database/exceptions/class-use/MissingCredentialsException.html b/doc/uk/org/ury/database/exceptions/class-use/MissingCredentialsException.html index c622c6e..9bf9fa0 100644 --- a/doc/uk/org/ury/database/exceptions/class-use/MissingCredentialsException.html +++ b/doc/uk/org/ury/database/exceptions/class-use/MissingCredentialsException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.exceptions.MissingCredentialsException - + @@ -95,11 +95,11 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.  uk.org.ury.server -   +The URY Server kernel.    @@ -171,7 +171,7 @@ Uses of getDatabaseConnection(UserClass userClass)
-          Get a database connection using the given user class. +          Gets a database connection using the given user class.   diff --git a/doc/uk/org/ury/database/exceptions/class-use/MissingPropertyException.html b/doc/uk/org/ury/database/exceptions/class-use/MissingPropertyException.html index 98d49a6..01efe6a 100644 --- a/doc/uk/org/ury/database/exceptions/class-use/MissingPropertyException.html +++ b/doc/uk/org/ury/database/exceptions/class-use/MissingPropertyException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.exceptions.MissingPropertyException - + @@ -91,7 +91,7 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.    diff --git a/doc/uk/org/ury/database/exceptions/class-use/QueryFailureException.html b/doc/uk/org/ury/database/exceptions/class-use/QueryFailureException.html index 80e07cc..7a1cb2d 100644 --- a/doc/uk/org/ury/database/exceptions/class-use/QueryFailureException.html +++ b/doc/uk/org/ury/database/exceptions/class-use/QueryFailureException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.exceptions.QueryFailureException - + @@ -152,8 +152,8 @@ Uses of diff --git a/doc/uk/org/ury/database/exceptions/package-frame.html b/doc/uk/org/ury/database/exceptions/package-frame.html index e04436e..ee2ee10 100644 --- a/doc/uk/org/ury/database/exceptions/package-frame.html +++ b/doc/uk/org/ury/database/exceptions/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.database.exceptions - + diff --git a/doc/uk/org/ury/database/exceptions/package-summary.html b/doc/uk/org/ury/database/exceptions/package-summary.html index cf790ff..2742df1 100644 --- a/doc/uk/org/ury/database/exceptions/package-summary.html +++ b/doc/uk/org/ury/database/exceptions/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.database.exceptions - + @@ -82,6 +82,12 @@ function windowTitle()

Package uk.org.ury.database.exceptions

+Exceptions thrown by the database services classes. +

+See: +
+          Description +

@@ -112,6 +118,15 @@ Package uk.org.ury.database.exceptions
  +

+

+Package uk.org.ury.database.exceptions Description +

+ +

+

Exceptions thrown by the database services classes.

+

+

diff --git a/doc/uk/org/ury/database/exceptions/package-tree.html b/doc/uk/org/ury/database/exceptions/package-tree.html index 6db51a7..4cb2755 100644 --- a/doc/uk/org/ury/database/exceptions/package-tree.html +++ b/doc/uk/org/ury/database/exceptions/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.database.exceptions Class Hierarchy - + diff --git a/doc/uk/org/ury/database/exceptions/package-use.html b/doc/uk/org/ury/database/exceptions/package-use.html index 881f707..857af19 100644 --- a/doc/uk/org/ury/database/exceptions/package-use.html +++ b/doc/uk/org/ury/database/exceptions/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.database.exceptions - + @@ -95,7 +95,7 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.  uk.org.ury.library @@ -103,7 +103,7 @@ Packages that use uk.org.ury.server -   +The URY Server kernel.  uk.org.ury.show diff --git a/doc/uk/org/ury/database/package-frame.html b/doc/uk/org/ury/database/package-frame.html index 80be895..3f3d02c 100644 --- a/doc/uk/org/ury/database/package-frame.html +++ b/doc/uk/org/ury/database/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.database - + diff --git a/doc/uk/org/ury/database/package-summary.html b/doc/uk/org/ury/database/package-summary.html index 1f8e620..bbb8812 100644 --- a/doc/uk/org/ury/database/package-summary.html +++ b/doc/uk/org/ury/database/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.database - + @@ -82,6 +82,12 @@ function windowTitle()

Package uk.org.ury.database

+Database services for the URY Presenter Suite. +

+See: +
+          Description +

@@ -90,15 +96,13 @@ Package uk.org.ury.database - + - +
DatabaseDriverA database connection manager that connects to the URY databases - using suitably privileged accounts, and handles the processing - of SQL queries.A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.
DatabaseItem<E,T>An abstract class presenting a template for objects serving as - a data structure for collections of properties retrieved from - a SQL database.An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.
  @@ -117,6 +121,19 @@ Package uk.org.ury.database   +

+

+Package uk.org.ury.database Description +

+ +

+

Database services for the URY Presenter Suite.

+

The classes provided within this package are expected to be + used by the back-end through utility classes, and not + by the frontend, which should use the server API to indirectly + query the database.

+

+

diff --git a/doc/uk/org/ury/database/package-tree.html b/doc/uk/org/ury/database/package-tree.html index b2ff806..fa6cbdf 100644 --- a/doc/uk/org/ury/database/package-tree.html +++ b/doc/uk/org/ury/database/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.database Class Hierarchy - + diff --git a/doc/uk/org/ury/database/package-use.html b/doc/uk/org/ury/database/package-use.html index 9a72514..25e0a60 100644 --- a/doc/uk/org/ury/database/package-use.html +++ b/doc/uk/org/ury/database/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.database - + @@ -91,7 +91,7 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.  uk.org.ury.library @@ -103,7 +103,7 @@ Packages that use uk.org.ury.server -   +The URY Server kernel.  uk.org.ury.show @@ -111,7 +111,7 @@ Packages that use uk.org.ury.show.item -   +The show item class and related properties.    @@ -141,9 +141,8 @@ Classes in uk.org DatabaseDriver
-          A database connection manager that connects to the URY databases - using suitably privileged accounts, and handles the processing - of SQL queries. +          A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.   @@ -158,9 +157,8 @@ Classes in uk.org DatabaseItem
-          An abstract class presenting a template for objects serving as - a data structure for collections of properties retrieved from - a SQL database. +          An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.   @@ -175,9 +173,8 @@ Classes in uk.org DatabaseDriver
-          A database connection manager that connects to the URY databases - using suitably privileged accounts, and handles the processing - of SQL queries. +          A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries. UserClass @@ -198,9 +195,8 @@ Classes in uk.org DatabaseDriver
-          A database connection manager that connects to the URY databases - using suitably privileged accounts, and handles the processing - of SQL queries. +          A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.   @@ -215,9 +211,8 @@ Classes in uk.org DatabaseItem
-          An abstract class presenting a template for objects serving as - a data structure for collections of properties retrieved from - a SQL database. +          An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.   -- cgit v1.2.3