From df7d7981b56a4560c95ea7e9b194080e93398ecf Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 21:54:31 +0000 Subject: GREAT PACKAGE RESHUFFLE: Everything is now organised into frontend, backend and common (to frontend and backend) packages. Things may have been broken. Doc refresh. --- .../org/ury/backend/database/DatabaseDriver.html | 317 +++++++++++++++++ doc/uk/org/ury/backend/database/DatabaseItem.html | 320 ++++++++++++++++++ doc/uk/org/ury/backend/database/UserClass.html | 376 +++++++++++++++++++++ .../backend/database/class-use/DatabaseDriver.html | 250 ++++++++++++++ .../backend/database/class-use/DatabaseItem.html | 209 ++++++++++++ .../ury/backend/database/class-use/UserClass.html | 233 +++++++++++++ .../exceptions/ConnectionFailureException.html | 269 +++++++++++++++ .../exceptions/MissingCredentialsException.html | 275 +++++++++++++++ .../exceptions/MissingPropertyException.html | 271 +++++++++++++++ .../database/exceptions/QueryFailureException.html | 269 +++++++++++++++ .../class-use/ConnectionFailureException.html | 208 ++++++++++++ .../class-use/MissingCredentialsException.html | 235 +++++++++++++ .../class-use/MissingPropertyException.html | 180 ++++++++++ .../class-use/QueryFailureException.html | 250 ++++++++++++++ .../backend/database/exceptions/package-frame.html | 38 +++ .../database/exceptions/package-summary.html | 189 +++++++++++ .../backend/database/exceptions/package-tree.html | 158 +++++++++ .../backend/database/exceptions/package-use.html | 295 ++++++++++++++++ doc/uk/org/ury/backend/database/package-frame.html | 45 +++ .../org/ury/backend/database/package-summary.html | 196 +++++++++++ doc/uk/org/ury/backend/database/package-tree.html | 163 +++++++++ doc/uk/org/ury/backend/database/package-use.html | 276 +++++++++++++++ 22 files changed, 5022 insertions(+) create mode 100644 doc/uk/org/ury/backend/database/DatabaseDriver.html create mode 100644 doc/uk/org/ury/backend/database/DatabaseItem.html create mode 100644 doc/uk/org/ury/backend/database/UserClass.html create mode 100644 doc/uk/org/ury/backend/database/class-use/DatabaseDriver.html create mode 100644 doc/uk/org/ury/backend/database/class-use/DatabaseItem.html create mode 100644 doc/uk/org/ury/backend/database/class-use/UserClass.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/ConnectionFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/MissingCredentialsException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/MissingPropertyException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/QueryFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/ConnectionFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/MissingCredentialsException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/MissingPropertyException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/QueryFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-use.html create mode 100644 doc/uk/org/ury/backend/database/package-frame.html create mode 100644 doc/uk/org/ury/backend/database/package-summary.html create mode 100644 doc/uk/org/ury/backend/database/package-tree.html create mode 100644 doc/uk/org/ury/backend/database/package-use.html (limited to 'doc/uk/org/ury/backend/database') diff --git a/doc/uk/org/ury/backend/database/DatabaseDriver.html b/doc/uk/org/ury/backend/database/DatabaseDriver.html new file mode 100644 index 0000000..54611d0 --- /dev/null +++ b/doc/uk/org/ury/backend/database/DatabaseDriver.html @@ -0,0 +1,317 @@ + + + + + + +DatabaseDriver + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.backend.database +
+Class DatabaseDriver

+
+java.lang.Object
+  extended by uk.org.ury.backend.database.DatabaseDriver
+
+
+
+
public class DatabaseDriver
extends java.lang.Object
+ + +

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

+ +

+

+
Author:
+
Matt Windsor, Nathan Lasseter
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
DatabaseDriver(ConfigReader config, + UserClass type) + +
+          Construct a new DatabaseDriver with the given user class.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ java.sql.ResultSetexecuteQuery(java.lang.String sql, + int fetchSize) + +
+          Execute an unprepared SQL statement with no arguments.
+ java.sql.ResultSetexecuteQuery(java.lang.String sql, + java.lang.Object[] params, + int fetchSize) + +
+          Perform a SQL statement with arguments.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DatabaseDriver

+
+public DatabaseDriver(ConfigReader config,
+                      UserClass type)
+               throws MissingCredentialsException,
+                      ConnectionFailureException
+
+
Construct a new DatabaseDriver with the given user class. +

+

+
Parameters:
config - The config with login details.
type - The user class to log in to the database with. +
Throws: +
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.
+
+ + + + + + + + +
+Method Detail
+ +

+executeQuery

+
+public java.sql.ResultSet executeQuery(java.lang.String sql,
+                                       int fetchSize)
+                                throws java.sql.SQLException
+
+
Execute an unprepared SQL statement with no arguments. +

+

+
Parameters:
sql - The SQL statement to execute.
fetchSize - The maximum number of query rows to return. +
Returns:
the JDBC results set. +
Throws: +
java.sql.SQLException - if a SQL error occurs.
+
+
+
+ +

+executeQuery

+
+public java.sql.ResultSet executeQuery(java.lang.String sql,
+                                       java.lang.Object[] params,
+                                       int fetchSize)
+                                throws java.sql.SQLException
+
+
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. +

+

+
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.sql.SQLException - if a SQL error occurs.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/DatabaseItem.html b/doc/uk/org/ury/backend/database/DatabaseItem.html new file mode 100644 index 0000000..1d98e28 --- /dev/null +++ b/doc/uk/org/ury/backend/database/DatabaseItem.html @@ -0,0 +1,320 @@ + + + + + + +DatabaseItem + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.backend.database +
+Class DatabaseItem<E,T>

+
+java.lang.Object
+  extended by uk.org.ury.backend.database.DatabaseItem<E,T>
+
+
+
Direct Known Subclasses:
LibraryItem, ShowItem
+
+
+
+
public abstract class DatabaseItem<E,T>
extends 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. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
DatabaseItem(java.util.Map<E,T> properties) + +
+          Construct a new item from an existing list of properties.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.util.Map<java.lang.String,java.lang.String>asResponse() + +
+          Retrieve a map of string representations of the properties.
+ Tget(E property) + +
+          Query this item for a property.
+ booleanhas(E property) + +
+          Check whether a property has been set in the item.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DatabaseItem

+
+public DatabaseItem(java.util.Map<E,T> properties)
+
+
Construct a new item from an existing list of properties. +

+

+
Parameters:
properties - The map of properties that the new item will inherit.
+
+ + + + + + + + +
+Method Detail
+ +

+has

+
+public boolean has(E property)
+
+
Check whether a property has been set in the item. +

+

+ +
Returns:
true if the property has been set; false otherwise.
+
+
+
+ +

+get

+
+public T get(E property)
+      throws MissingPropertyException
+
+
Query this item for a property. +

+

+
Parameters:
property - The property to query. +
Returns:
The property, if it exists. +
Throws: +
MissingPropertyException - if the property does not exist.
+
+
+
+ +

+asResponse

+
+public java.util.Map<java.lang.String,java.lang.String> asResponse()
+
+
Retrieve a map of string representations of the properties. + + This relies on E and T having meaningful toString methods. +

+

+ +
Returns:
a list of lines representing the response.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/UserClass.html b/doc/uk/org/ury/backend/database/UserClass.html new file mode 100644 index 0000000..f403954 --- /dev/null +++ b/doc/uk/org/ury/backend/database/UserClass.html @@ -0,0 +1,376 @@ + + + + + + +UserClass + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +uk.org.ury.backend.database +
+Enum UserClass

+
+java.lang.Object
+  extended by java.lang.Enum<UserClass>
+      extended by uk.org.ury.backend.database.UserClass
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<UserClass>
+
+
+
+
public enum UserClass
extends java.lang.Enum<UserClass>
+ + +

+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. + + Please use the least privileged user class that works. For most cases, + READ_ONLY should work perfectly. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + + + +
+Enum Constant Summary
READ_ONLY + +
+           
READ_WRITE + +
+           
+  + + + + + + + + + + +
+Field Summary
+ java.lang.StringconfigName + +
+          The name of the tag in the configuration file that contains the + credentials for this user class.
+  + + + + + + + + + + + + + + + +
+Method Summary
+static UserClassvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static UserClass[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+READ_ONLY

+
+public static final UserClass READ_ONLY
+
+
+
+
+
+ +

+READ_WRITE

+
+public static final UserClass READ_WRITE
+
+
+
+
+ + + + + + + + +
+Field Detail
+ +

+configName

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

+

+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static UserClass[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (UserClass c : UserClass.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static UserClass valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/class-use/DatabaseDriver.html b/doc/uk/org/ury/backend/database/class-use/DatabaseDriver.html new file mode 100644 index 0000000..f086e8c --- /dev/null +++ b/doc/uk/org/ury/backend/database/class-use/DatabaseDriver.html @@ -0,0 +1,250 @@ + + + + + + +Uses of Class uk.org.ury.backend.database.DatabaseDriver + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.database.DatabaseDriver

+
+ + + + + + + + + + + + + + + + + +
+Packages that use DatabaseDriver
uk.org.ury.backend.serverThe URY Server kernel. 
uk.org.ury.common.library  
uk.org.ury.common.show  
+  +

+ + + + + +
+Uses of DatabaseDriver in uk.org.ury.backend.server
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.server that return DatabaseDriver
+ DatabaseDriverServer.getDatabaseConnection(UserClass userClass) + +
+          Gets a database connection using the given user class.
+  +

+ + + + + +
+Uses of DatabaseDriver in uk.org.ury.common.library
+  +

+ + + + + + + + + +
Methods in uk.org.ury.common.library with parameters of type DatabaseDriver
+static java.util.List<LibraryItem>LibraryUtils.search(DatabaseDriver db, + java.lang.String search) + +
+          Perform a library search.
+  +

+ + + + + +
+Uses of DatabaseDriver in uk.org.ury.common.show
+  +

+ + + + + + + + + + + + + +
Methods in uk.org.ury.common.show with parameters of type DatabaseDriver
+static java.util.List<ShowItem>ShowUtils.getChannelList(DatabaseDriver db, + int showID, + int channel) + +
+          Given a show and a channel, retrieve a list of all show items bound to + that channel for the show.
+static java.util.List<java.lang.String>ShowUtils.getPublicFolders(DatabaseDriver db) + +
+          Return the names of the public track folders, or "bins".
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/class-use/DatabaseItem.html b/doc/uk/org/ury/backend/database/class-use/DatabaseItem.html new file mode 100644 index 0000000..dc1287a --- /dev/null +++ b/doc/uk/org/ury/backend/database/class-use/DatabaseItem.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Class uk.org.ury.backend.database.DatabaseItem + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.database.DatabaseItem

+
+ + + + + + + + + + + + + +
+Packages that use DatabaseItem
uk.org.ury.common.library.item  
uk.org.ury.common.show.itemThe show item class and related properties. 
+  +

+ + + + + +
+Uses of DatabaseItem in uk.org.ury.common.library.item
+  +

+ + + + + + + + + +
Subclasses of DatabaseItem in uk.org.ury.common.library.item
+ classLibraryItem + +
+          An item in the URY library.
+  +

+ + + + + +
+Uses of DatabaseItem in uk.org.ury.common.show.item
+  +

+ + + + + + + + + +
Subclasses of DatabaseItem in uk.org.ury.common.show.item
+ classShowItem + +
+          An item in the show database.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/class-use/UserClass.html b/doc/uk/org/ury/backend/database/class-use/UserClass.html new file mode 100644 index 0000000..a8af4d5 --- /dev/null +++ b/doc/uk/org/ury/backend/database/class-use/UserClass.html @@ -0,0 +1,233 @@ + + + + + + +Uses of Class uk.org.ury.backend.database.UserClass + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.database.UserClass

+
+ + + + + + + + + + + + + +
+Packages that use UserClass
uk.org.ury.backend.databaseDatabase services for the URY Presenter Suite. 
uk.org.ury.backend.serverThe URY Server kernel. 
+  +

+ + + + + +
+Uses of UserClass in uk.org.ury.backend.database
+  +

+ + + + + + + + + + + + + +
Methods in uk.org.ury.backend.database that return UserClass
+static UserClassUserClass.valueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static UserClass[]UserClass.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + +
Constructors in uk.org.ury.backend.database with parameters of type UserClass
DatabaseDriver(ConfigReader config, + UserClass type) + +
+          Construct a new DatabaseDriver with the given user class.
+  +

+ + + + + +
+Uses of UserClass in uk.org.ury.backend.server
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.server with parameters of type UserClass
+ DatabaseDriverServer.getDatabaseConnection(UserClass userClass) + +
+          Gets a database connection using the given user class.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/ConnectionFailureException.html b/doc/uk/org/ury/backend/database/exceptions/ConnectionFailureException.html new file mode 100644 index 0000000..0315bcd --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/ConnectionFailureException.html @@ -0,0 +1,269 @@ + + + + + + +ConnectionFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.backend.database.exceptions +
+Class ConnectionFailureException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.backend.database.exceptions.ConnectionFailureException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class ConnectionFailureException
extends java.lang.Exception
+ + +

+Exception thrown when the database backend fails to connect to + the database server, in absence of a more specific exception. +

+ +

+

+
Author:
+
Matt Windsor
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
ConnectionFailureException() + +
+          Construct a new ConnectionFailureException with a + default reason.
ConnectionFailureException(java.lang.String reason) + +
+          Construct a new ConnectionFailureException.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ConnectionFailureException

+
+public ConnectionFailureException()
+
+
Construct a new ConnectionFailureException with a + default reason. +

+

+
+ +

+ConnectionFailureException

+
+public ConnectionFailureException(java.lang.String reason)
+
+
Construct a new ConnectionFailureException. +

+

+
Parameters:
reason - The explanation for the exception.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/MissingCredentialsException.html b/doc/uk/org/ury/backend/database/exceptions/MissingCredentialsException.html new file mode 100644 index 0000000..0be114f --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/MissingCredentialsException.html @@ -0,0 +1,275 @@ + + + + + + +MissingCredentialsException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.backend.database.exceptions +
+Class MissingCredentialsException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.backend.database.exceptions.MissingCredentialsException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class MissingCredentialsException
extends java.lang.Exception
+ + +

+Exception thrown when the database credentials required to + log into the URY database under a user class are missing, + and thus the log-in cannot continue. + + The best practice for handling a MissingCredentialsException + is to attempt to log into the database with a less privileged + user class or, if the credentials for read-only access are + missing, give up. +

+ +

+

+
Author:
+
Matt Windsor
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
MissingCredentialsException() + +
+          Construct a new MissingCredentialsException with a + default reason.
MissingCredentialsException(java.lang.String reason) + +
+          Construct a new MissingCredentialsException.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MissingCredentialsException

+
+public MissingCredentialsException()
+
+
Construct a new MissingCredentialsException with a + default reason. +

+

+
+ +

+MissingCredentialsException

+
+public MissingCredentialsException(java.lang.String reason)
+
+
Construct a new MissingCredentialsException. +

+

+
Parameters:
reason - The explanation for the exception.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/MissingPropertyException.html b/doc/uk/org/ury/backend/database/exceptions/MissingPropertyException.html new file mode 100644 index 0000000..aa2d24e --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/MissingPropertyException.html @@ -0,0 +1,271 @@ + + + + + + +MissingPropertyException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.backend.database.exceptions +
+Class MissingPropertyException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.backend.database.exceptions.MissingPropertyException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class MissingPropertyException
extends java.lang.Exception
+ + +

+Exception thrown when a DatabaseItem is queried for a property + that does not exist. + + This is (usually) not a fatal error. +

+ +

+

+
Author:
+
Matt Windsor
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
MissingPropertyException() + +
+          Construct a new MissingPropertyException with a + default reason.
MissingPropertyException(java.lang.String reason) + +
+          Construct a new MissingPropertyException.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+MissingPropertyException

+
+public MissingPropertyException()
+
+
Construct a new MissingPropertyException with a + default reason. +

+

+
+ +

+MissingPropertyException

+
+public MissingPropertyException(java.lang.String reason)
+
+
Construct a new MissingPropertyException. +

+

+
Parameters:
reason - The explanation for the exception.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/QueryFailureException.html b/doc/uk/org/ury/backend/database/exceptions/QueryFailureException.html new file mode 100644 index 0000000..2b65c39 --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/QueryFailureException.html @@ -0,0 +1,269 @@ + + + + + + +QueryFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.backend.database.exceptions +
+Class QueryFailureException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.backend.database.exceptions.QueryFailureException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class QueryFailureException
extends java.lang.Exception
+ + +

+Exception thrown when the database backend fails to execute + a query. +

+ +

+

+
Author:
+
Matt Windsor
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
QueryFailureException() + +
+          Construct a new QueryFailureException with a + default reason.
QueryFailureException(java.lang.String reason) + +
+          Construct a new QueryFailureException.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+QueryFailureException

+
+public QueryFailureException()
+
+
Construct a new QueryFailureException with a + default reason. +

+

+
+ +

+QueryFailureException

+
+public QueryFailureException(java.lang.String reason)
+
+
Construct a new QueryFailureException. +

+

+
Parameters:
reason - The explanation for the exception.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/class-use/ConnectionFailureException.html b/doc/uk/org/ury/backend/database/exceptions/class-use/ConnectionFailureException.html new file mode 100644 index 0000000..f12e2aa --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/class-use/ConnectionFailureException.html @@ -0,0 +1,208 @@ + + + + + + +Uses of Class uk.org.ury.backend.database.exceptions.ConnectionFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.database.exceptions.ConnectionFailureException

+
+ + + + + + + + + + + + + +
+Packages that use ConnectionFailureException
uk.org.ury.backend.databaseDatabase services for the URY Presenter Suite. 
uk.org.ury.backend.serverThe URY Server kernel. 
+  +

+ + + + + +
+Uses of ConnectionFailureException in uk.org.ury.backend.database
+  +

+ + + + + + + + +
Constructors in uk.org.ury.backend.database that throw ConnectionFailureException
DatabaseDriver(ConfigReader config, + UserClass type) + +
+          Construct a new DatabaseDriver with the given user class.
+  +

+ + + + + +
+Uses of ConnectionFailureException in uk.org.ury.backend.server
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.server that throw ConnectionFailureException
+ DatabaseDriverServer.getDatabaseConnection(UserClass userClass) + +
+          Gets a database connection using the given user class.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/class-use/MissingCredentialsException.html b/doc/uk/org/ury/backend/database/exceptions/class-use/MissingCredentialsException.html new file mode 100644 index 0000000..b24cb60 --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/class-use/MissingCredentialsException.html @@ -0,0 +1,235 @@ + + + + + + +Uses of Class uk.org.ury.backend.database.exceptions.MissingCredentialsException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.database.exceptions.MissingCredentialsException

+
+ + + + + + + + + + + + + + + + + +
+Packages that use MissingCredentialsException
uk.org.ury.backend.config  
uk.org.ury.backend.databaseDatabase services for the URY Presenter Suite. 
uk.org.ury.backend.serverThe URY Server kernel. 
+  +

+ + + + + +
+Uses of MissingCredentialsException in uk.org.ury.backend.config
+  +

+ + + + + + + + +
Constructors in uk.org.ury.backend.config that throw MissingCredentialsException
ConfigReader(java.lang.String configFile) + +
+          Read in the config file and create the Database and Auth configuration objects.
+  +

+ + + + + +
+Uses of MissingCredentialsException in uk.org.ury.backend.database
+  +

+ + + + + + + + +
Constructors in uk.org.ury.backend.database that throw MissingCredentialsException
DatabaseDriver(ConfigReader config, + UserClass type) + +
+          Construct a new DatabaseDriver with the given user class.
+  +

+ + + + + +
+Uses of MissingCredentialsException in uk.org.ury.backend.server
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.server that throw MissingCredentialsException
+ DatabaseDriverServer.getDatabaseConnection(UserClass userClass) + +
+          Gets a database connection using the given user class.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/class-use/MissingPropertyException.html b/doc/uk/org/ury/backend/database/exceptions/class-use/MissingPropertyException.html new file mode 100644 index 0000000..eaf9af0 --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/class-use/MissingPropertyException.html @@ -0,0 +1,180 @@ + + + + + + +Uses of Class uk.org.ury.backend.database.exceptions.MissingPropertyException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.database.exceptions.MissingPropertyException

+
+ + + + + + + + + +
+Packages that use MissingPropertyException
uk.org.ury.backend.databaseDatabase services for the URY Presenter Suite. 
+  +

+ + + + + +
+Uses of MissingPropertyException in uk.org.ury.backend.database
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.database that throw MissingPropertyException
+ TDatabaseItem.get(E property) + +
+          Query this item for a property.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/class-use/QueryFailureException.html b/doc/uk/org/ury/backend/database/exceptions/class-use/QueryFailureException.html new file mode 100644 index 0000000..4efbbd2 --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/class-use/QueryFailureException.html @@ -0,0 +1,250 @@ + + + + + + +Uses of Class uk.org.ury.backend.database.exceptions.QueryFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.database.exceptions.QueryFailureException

+
+ + + + + + + + + + + + + + + + + +
+Packages that use QueryFailureException
uk.org.ury.common.library  
uk.org.ury.common.show  
uk.org.ury.frontend.modules.show  
+  +

+ + + + + +
+Uses of QueryFailureException in uk.org.ury.common.library
+  +

+ + + + + + + + + +
Methods in uk.org.ury.common.library that throw QueryFailureException
+static java.util.List<LibraryItem>LibraryUtils.search(DatabaseDriver db, + java.lang.String search) + +
+          Perform a library search.
+  +

+ + + + + +
+Uses of QueryFailureException in uk.org.ury.common.show
+  +

+ + + + + + + + + + + + + +
Methods in uk.org.ury.common.show that throw QueryFailureException
+static java.util.List<ShowItem>ShowUtils.getChannelList(DatabaseDriver db, + int showID, + int channel) + +
+          Given a show and a channel, retrieve a list of all show items bound to + that channel for the show.
+static java.util.List<java.lang.String>ShowUtils.getPublicFolders(DatabaseDriver db) + +
+          Return the names of the public track folders, or "bins".
+  +

+ + + + + +
+Uses of QueryFailureException in uk.org.ury.frontend.modules.show
+  +

+ + + + + + + + + +
Methods in uk.org.ury.frontend.modules.show that throw QueryFailureException
+ java.util.List<java.lang.String>ShowViewer.getBins() + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/package-frame.html b/doc/uk/org/ury/backend/database/exceptions/package-frame.html new file mode 100644 index 0000000..f55b853 --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/package-frame.html @@ -0,0 +1,38 @@ + + + + + + +uk.org.ury.backend.database.exceptions + + + + + + + + + + + +uk.org.ury.backend.database.exceptions + + + + +
+Exceptions  + +
+ConnectionFailureException +
+MissingCredentialsException +
+MissingPropertyException +
+QueryFailureException
+ + + + diff --git a/doc/uk/org/ury/backend/database/exceptions/package-summary.html b/doc/uk/org/ury/backend/database/exceptions/package-summary.html new file mode 100644 index 0000000..f1673c6 --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/package-summary.html @@ -0,0 +1,189 @@ + + + + + + +uk.org.ury.backend.database.exceptions + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

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

+Exceptions thrown by the database services classes. +

+See: +
+          Description +

+ + + + + + + + + + + + + + + + + + + + + +
+Exception Summary
ConnectionFailureExceptionException thrown when the database backend fails to connect to + the database server, in absence of a more specific exception.
MissingCredentialsExceptionException thrown when the database credentials required to + log into the URY database under a user class are missing, + and thus the log-in cannot continue.
MissingPropertyExceptionException thrown when a DatabaseItem is queried for a property + that does not exist.
QueryFailureExceptionException thrown when the database backend fails to execute + a query.
+  + +

+

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

+ +

+

Exceptions thrown by the database services classes.

+

+ +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/package-tree.html b/doc/uk/org/ury/backend/database/exceptions/package-tree.html new file mode 100644 index 0000000..3bc67be --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/package-tree.html @@ -0,0 +1,158 @@ + + + + + + +uk.org.ury.backend.database.exceptions Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package uk.org.ury.backend.database.exceptions +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/package-use.html b/doc/uk/org/ury/backend/database/exceptions/package-use.html new file mode 100644 index 0000000..605325a --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/package-use.html @@ -0,0 +1,295 @@ + + + + + + +Uses of Package uk.org.ury.backend.database.exceptions + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
uk.org.ury.backend.database.exceptions

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use uk.org.ury.backend.database.exceptions
uk.org.ury.backend.config  
uk.org.ury.backend.databaseDatabase services for the URY Presenter Suite. 
uk.org.ury.backend.serverThe URY Server kernel. 
uk.org.ury.common.library  
uk.org.ury.common.show  
uk.org.ury.frontend.modules.show  
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database.exceptions used by uk.org.ury.backend.config
MissingCredentialsException + +
+          Exception thrown when the database credentials required to + log into the URY database under a user class are missing, + and thus the log-in cannot continue.
+  +

+ + + + + + + + + + + + + + +
+Classes in uk.org.ury.backend.database.exceptions used by uk.org.ury.backend.database
ConnectionFailureException + +
+          Exception thrown when the database backend fails to connect to + the database server, in absence of a more specific exception.
MissingCredentialsException + +
+          Exception thrown when the database credentials required to + log into the URY database under a user class are missing, + and thus the log-in cannot continue.
MissingPropertyException + +
+          Exception thrown when a DatabaseItem is queried for a property + that does not exist.
+  +

+ + + + + + + + + + + +
+Classes in uk.org.ury.backend.database.exceptions used by uk.org.ury.backend.server
ConnectionFailureException + +
+          Exception thrown when the database backend fails to connect to + the database server, in absence of a more specific exception.
MissingCredentialsException + +
+          Exception thrown when the database credentials required to + log into the URY database under a user class are missing, + and thus the log-in cannot continue.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database.exceptions used by uk.org.ury.common.library
QueryFailureException + +
+          Exception thrown when the database backend fails to execute + a query.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database.exceptions used by uk.org.ury.common.show
QueryFailureException + +
+          Exception thrown when the database backend fails to execute + a query.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database.exceptions used by uk.org.ury.frontend.modules.show
QueryFailureException + +
+          Exception thrown when the database backend fails to execute + a query.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/package-frame.html b/doc/uk/org/ury/backend/database/package-frame.html new file mode 100644 index 0000000..566370e --- /dev/null +++ b/doc/uk/org/ury/backend/database/package-frame.html @@ -0,0 +1,45 @@ + + + + + + +uk.org.ury.backend.database + + + + + + + + + + + +uk.org.ury.backend.database + + + + +
+Classes  + +
+DatabaseDriver +
+DatabaseItem
+ + + + + + +
+Enums  + +
+UserClass
+ + + + diff --git a/doc/uk/org/ury/backend/database/package-summary.html b/doc/uk/org/ury/backend/database/package-summary.html new file mode 100644 index 0000000..e1ceab2 --- /dev/null +++ b/doc/uk/org/ury/backend/database/package-summary.html @@ -0,0 +1,196 @@ + + + + + + +uk.org.ury.backend.database + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.backend.database +

+Database services for the URY Presenter Suite. +

+See: +
+          Description +

+ + + + + + + + + + + + + +
+Class Summary
DatabaseDriverA 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.
+  + +

+ + + + + + + + + +
+Enum Summary
UserClassThe various user classes of the database driver.
+  + +

+

+Package uk.org.ury.backend.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.

+

+ +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/package-tree.html b/doc/uk/org/ury/backend/database/package-tree.html new file mode 100644 index 0000000..48ecb78 --- /dev/null +++ b/doc/uk/org/ury/backend/database/package-tree.html @@ -0,0 +1,163 @@ + + + + + + +uk.org.ury.backend.database Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package uk.org.ury.backend.database +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/package-use.html b/doc/uk/org/ury/backend/database/package-use.html new file mode 100644 index 0000000..0faa175 --- /dev/null +++ b/doc/uk/org/ury/backend/database/package-use.html @@ -0,0 +1,276 @@ + + + + + + +Uses of Package uk.org.ury.backend.database + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
uk.org.ury.backend.database

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use uk.org.ury.backend.database
uk.org.ury.backend.databaseDatabase services for the URY Presenter Suite. 
uk.org.ury.backend.serverThe URY Server kernel. 
uk.org.ury.common.library  
uk.org.ury.common.library.item  
uk.org.ury.common.show  
uk.org.ury.common.show.itemThe show item class and related properties. 
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database used by uk.org.ury.backend.database
UserClass + +
+          The various user classes of the database driver.
+  +

+ + + + + + + + + + + +
+Classes in uk.org.ury.backend.database used by uk.org.ury.backend.server
DatabaseDriver + +
+          A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.
UserClass + +
+          The various user classes of the database driver.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database used by uk.org.ury.common.library
DatabaseDriver + +
+          A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database used by uk.org.ury.common.library.item
DatabaseItem + +
+          An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database used by uk.org.ury.common.show
DatabaseDriver + +
+          A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database used by uk.org.ury.common.show.item
DatabaseItem + +
+          An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + -- cgit v1.2.3