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/index-files/index-1.html | 15 ++++++++++----- doc/index-files/index-10.html | 10 +++++----- doc/index-files/index-11.html | 4 ++-- doc/index-files/index-12.html | 4 ++-- doc/index-files/index-13.html | 14 ++------------ doc/index-files/index-14.html | 4 ++-- doc/index-files/index-15.html | 15 ++++++++++----- doc/index-files/index-16.html | 14 +++++++------- doc/index-files/index-17.html | 6 +++--- doc/index-files/index-18.html | 10 +++++++--- doc/index-files/index-19.html | 4 ++-- doc/index-files/index-2.html | 7 ++----- doc/index-files/index-3.html | 8 ++++---- doc/index-files/index-4.html | 20 +++++++++----------- doc/index-files/index-5.html | 4 ++-- doc/index-files/index-6.html | 4 ++-- doc/index-files/index-7.html | 15 ++++++--------- doc/index-files/index-8.html | 31 +++++++++++++++++++++---------- doc/index-files/index-9.html | 7 +++++-- 19 files changed, 103 insertions(+), 93 deletions(-) (limited to 'doc/index-files') diff --git a/doc/index-files/index-1.html b/doc/index-files/index-1.html index 888aa74..eb48bf3 100644 --- a/doc/index-files/index-1.html +++ b/doc/index-files/index-1.html @@ -2,12 +2,12 @@ - + A-Index - + @@ -85,13 +85,18 @@ function windowTitle()
AbstractFrontendModule - Class in uk.org.ury.frontend
An abstract implementation of the FrontendModule interface.
AbstractFrontendModule() - Constructor for class uk.org.ury.frontend.AbstractFrontendModule
  +
AbstractRequestHandler - Class in uk.org.ury.server
An abstract request handler for HttpCore, providing basic functionality such + as uniform error response.
AbstractRequestHandler(Server, String) - +Constructor for class uk.org.ury.server.AbstractRequestHandler +
Constructs a new AbstractRequestHandler.
add(int, ShowItem) - Method in class uk.org.ury.show.ShowChannel -
Add a new item to the channel. +
Adds a new item to the channel.
add(ShowItem) - Method in class uk.org.ury.show.ShowChannel -
Add a new item to the end of the channel. -
ApplicationLauncher - Class in uk.org.ury.testrig
An application-based entry point into the frontend.
ApplicationLauncher() - +
Adds a new item to the end of the channel. +
ApiRequestHandler - Interface in uk.org.ury.server
Interface for classes that can handle requests addressed to their + class name from the main server.
ApplicationLauncher - Class in uk.org.ury.testrig
An application-based entry point into the frontend.
ApplicationLauncher() - Constructor for class uk.org.ury.testrig.ApplicationLauncher
 
asResponse() - diff --git a/doc/index-files/index-10.html b/doc/index-files/index-10.html index a8824ad..d093928 100644 --- a/doc/index-files/index-10.html +++ b/doc/index-files/index-10.html @@ -2,12 +2,12 @@ - + L-Index - + @@ -88,9 +88,9 @@ Constructor for class uk.org.ury.show.viewer.LibraryItem - Class in uk.org.ury.library.item
An item in the URY library.
LibraryItem(Map<LibraryItemProperty, String>) - Constructor for class uk.org.ury.library.item.LibraryItem
  -
LibraryItemProperty - Enum in uk.org.ury.library.item
The parameters that are stored in the LibraryItem.
LibraryRequestHandler - Class in uk.org.ury.library
A request handler for library queries.
LibraryRequestHandler() - +
LibraryItemProperty - Enum in uk.org.ury.library.item
The parameters that are stored in the LibraryItem.
LibraryRequestHandler - Class in uk.org.ury.library
A request handler for library queries.
LibraryRequestHandler(Server, String) - Constructor for class uk.org.ury.library.LibraryRequestHandler -
  +
Construct a new LibraryRequestHandler.
LibraryTableModel - Class in uk.org.ury.library.viewer
A table model for the library viewer.
LibraryTableModel(List<LibraryItem>) - Constructor for class uk.org.ury.library.viewer.LibraryTableModel
Construct a new table model. @@ -100,7 +100,7 @@ Constructor for class uk.org.ury.library.LibraryViewer - Class in uk.org.ury.library.viewer
Module for investigating the track library.
LibraryViewer() - Constructor for class uk.org.ury.library.viewer.LibraryViewer -
Construct a new LibraryViewer as a frontend object. +
Constructs a new LibraryViewer as a frontend object.
LibraryViewerPanel - Class in uk.org.ury.library.viewer
Frontend panel providing access to an underlying library viewer.
LibraryViewerPanel(LibraryViewer, FrontendMaster) - Constructor for class uk.org.ury.library.viewer.LibraryViewerPanel
Construct a new LibraryViewerPanel. diff --git a/doc/index-files/index-11.html b/doc/index-files/index-11.html index 6cae7cd..b738199 100644 --- a/doc/index-files/index-11.html +++ b/doc/index-files/index-11.html @@ -2,12 +2,12 @@ - + M-Index - + diff --git a/doc/index-files/index-12.html b/doc/index-files/index-12.html index 98ffbc9..b877693 100644 --- a/doc/index-files/index-12.html +++ b/doc/index-files/index-12.html @@ -2,12 +2,12 @@ - + N-Index - + diff --git a/doc/index-files/index-13.html b/doc/index-files/index-13.html index 0d582d8..49ff9e4 100644 --- a/doc/index-files/index-13.html +++ b/doc/index-files/index-13.html @@ -2,12 +2,12 @@ - + P-Index - + @@ -82,16 +82,6 @@ function windowTitle()

P

-
parseQueryString(String) - -Method in class uk.org.ury.server.Server -
Parse a query string, populating a key-value map of the - URL-unescaped results. -
processBuffer(List<String>, PrintWriter) - -Method in class uk.org.ury.server.Server -
  -
processInput(String) - -Method in class uk.org.ury.server.ServerProtocol -
 
ProtocolUtils - Class in uk.org.ury.protocol
Utilities for converting between strings encoded in the response protocol and collections of items, as well as validating and unpicking protocol messages.
ProtocolUtils() - Constructor for class uk.org.ury.protocol.ProtocolUtils diff --git a/doc/index-files/index-14.html b/doc/index-files/index-14.html index 6811312..a57941e 100644 --- a/doc/index-files/index-14.html +++ b/doc/index-files/index-14.html @@ -2,12 +2,12 @@ - + Q-Index - + diff --git a/doc/index-files/index-15.html b/doc/index-files/index-15.html index 933479c..66f3b7a 100644 --- a/doc/index-files/index-15.html +++ b/doc/index-files/index-15.html @@ -2,12 +2,12 @@ - + R-Index - + @@ -88,8 +88,7 @@ Static method in class uk.org.ury.frontend.reportFatal(String, FrontendApplet) - Static method in class uk.org.ury.frontend.FrontendError
  -
RequestHandler - Interface in uk.org.ury.server
Interface for classes that can handle requests addressed to their - class name from the main server.
responseIsOK(Map<?, ?>) - +
responseIsOK(Map<?, ?>) - Static method in class uk.org.ury.protocol.ProtocolUtils
Check if a response is flagged as having OK status.
restoreModule(FrontendModulePanel, FrontendControlPanel) - @@ -103,6 +102,12 @@ Method in class uk.org.ury.frontend.FrontendMaster
Restore an existing module and control panel into the frontend master. +
run() - +Method in class uk.org.ury.server.HttpListenerThread +
Thread execution body. +
run() - +Method in class uk.org.ury.server.HttpWorkerThread +
Thread execution body.
run() - Method in class uk.org.ury.testrig.DemoMenu
Run the demo menu, creating a user interface. @@ -111,7 +116,7 @@ Method in interface uk.org.ury.frontend.runFrontend(FrontendMaster) - Method in class uk.org.ury.library.viewer.LibraryViewer -
Run the library viewer frontend. +
Runs the library viewer frontend.
runFrontend(FrontendMaster) - Method in class uk.org.ury.show.viewer.ShowViewer
Run the library viewer frontend. diff --git a/doc/index-files/index-16.html b/doc/index-files/index-16.html index 3eab2a9..2f1a287 100644 --- a/doc/index-files/index-16.html +++ b/doc/index-files/index-16.html @@ -2,12 +2,12 @@ - + S-Index - + @@ -96,8 +96,8 @@ Method in class uk.org.ury.show.viewer.Server - Class in uk.org.ury.server
The unified URY server, accepting requests over HTTP.
Server() - Constructor for class uk.org.ury.server.Server
  -
ServerProtocol - Class in uk.org.ury.server
The BAPS server protocol (a minimal implementation of HTTP 1.1) handler.
ServerProtocol() - -Constructor for class uk.org.ury.server.ServerProtocol +
SERVER_VERSION - +Static variable in class uk.org.ury.server.Server
 
ServerRequestHandler - Class in uk.org.ury.server
A request handler for server queries.
ServerRequestHandler() - Constructor for class uk.org.ury.server.ServerRequestHandler @@ -134,12 +134,12 @@ Method in interface uk.org.ury.frontend.ShowChannel - Class in uk.org.ury.show
A channel of ShowItems in a show.
ShowChannel() - Constructor for class uk.org.ury.show.ShowChannel -
Construct a new, empty channel. +
Constructs a new, empty channel.
ShowItem - Class in uk.org.ury.show.item
An item in the show database.
ShowItem(Map<ShowItemProperty, String>) - Constructor for class uk.org.ury.show.item.ShowItem
Construct a new ShowItem. -
ShowItemProperty - Enum in uk.org.ury.show.item
Enumeration of the parameters that are stored in a ShowItem.
ShowUtils - Class in uk.org.ury.show
A set of common utility routines to facilitate the extraction of - show items from the show storage areas of the URY database.
ShowUtils() - +
ShowItemProperty - Enum in uk.org.ury.show.item
Enumeration of the parameters that are stored in a ShowItem.
ShowUtils - Class in uk.org.ury.show
A set of common utility routines to facilitate the extraction of show items + from the show storage areas of the URY database.
ShowUtils() - Constructor for class uk.org.ury.show.ShowUtils
 
ShowViewer - Class in uk.org.ury.show.viewer
Frontend module for viewing show details.
ShowViewer() - diff --git a/doc/index-files/index-17.html b/doc/index-files/index-17.html index 2e809b2..e288e13 100644 --- a/doc/index-files/index-17.html +++ b/doc/index-files/index-17.html @@ -2,12 +2,12 @@ - + T-Index - + @@ -87,7 +87,7 @@ Method in class uk.org.ury.client.test.testGet() - Method in class uk.org.ury.client.test.ClientTest -
Test method for Client.get(java.lang.String). +
Test method for Client.get(java.lang.String).
toString() - Method in class uk.org.ury.show.item.ShowItem
  diff --git a/doc/index-files/index-18.html b/doc/index-files/index-18.html index 47e99d5..4fe25ef 100644 --- a/doc/index-files/index-18.html +++ b/doc/index-files/index-18.html @@ -2,12 +2,12 @@ - + U-Index - + @@ -89,7 +89,11 @@ Constructor for exception uk.org.ury.frontend.exceptions.UICreationFailureException(String) - Constructor for exception uk.org.ury.frontend.exceptions.UICreationFailureException
Construct a new UICreationFailureException. -
uk.org.ury.client - package uk.org.ury.client
 
uk.org.ury.client.test - package uk.org.ury.client.test
 
uk.org.ury.config - package uk.org.ury.config
 
uk.org.ury.database - package uk.org.ury.database
 
uk.org.ury.database.exceptions - package uk.org.ury.database.exceptions
 
uk.org.ury.frontend - package uk.org.ury.frontend
 
uk.org.ury.frontend.exceptions - package uk.org.ury.frontend.exceptions
 
uk.org.ury.library - package uk.org.ury.library
 
uk.org.ury.library.exceptions - package uk.org.ury.library.exceptions
 
uk.org.ury.library.item - package uk.org.ury.library.item
 
uk.org.ury.library.viewer - package uk.org.ury.library.viewer
 
uk.org.ury.protocol - package uk.org.ury.protocol
 
uk.org.ury.protocol.exceptions - package uk.org.ury.protocol.exceptions
 
uk.org.ury.server - package uk.org.ury.server
 
uk.org.ury.server.exceptions - package uk.org.ury.server.exceptions
 
uk.org.ury.show - package uk.org.ury.show
 
uk.org.ury.show.item - package uk.org.ury.show.item
 
uk.org.ury.show.viewer - package uk.org.ury.show.viewer
 
uk.org.ury.testrig - package uk.org.ury.testrig
 
UserClass - Enum in uk.org.ury.database
The various user classes of the database driver.
+
uk.org.ury.client - package uk.org.ury.client
 
uk.org.ury.client.test - package uk.org.ury.client.test
 
uk.org.ury.config - package uk.org.ury.config
 
uk.org.ury.database - package uk.org.ury.database
Database services for the URY Presenter Suite.
uk.org.ury.database.exceptions - package uk.org.ury.database.exceptions
Exceptions thrown by the database services classes.
uk.org.ury.frontend - package uk.org.ury.frontend
 
uk.org.ury.frontend.exceptions - package uk.org.ury.frontend.exceptions
 
uk.org.ury.library - package uk.org.ury.library
 
uk.org.ury.library.exceptions - package uk.org.ury.library.exceptions
 
uk.org.ury.library.item - package uk.org.ury.library.item
 
uk.org.ury.library.viewer - package uk.org.ury.library.viewer
 
uk.org.ury.protocol - package uk.org.ury.protocol
 
uk.org.ury.protocol.exceptions - package uk.org.ury.protocol.exceptions
 
uk.org.ury.server - package uk.org.ury.server
The URY Server kernel.
uk.org.ury.server.exceptions - package uk.org.ury.server.exceptions
 
uk.org.ury.show - package uk.org.ury.show
 
uk.org.ury.show.item - package uk.org.ury.show.item
The show item class and related properties.
uk.org.ury.show.viewer - package uk.org.ury.show.viewer
 
uk.org.ury.testrig - package uk.org.ury.testrig
 
UnknownFunctionException - Exception in uk.org.ury.server.exceptions
Exception thrown when a handler receives a request for a path that does not + correspond to one of its functions.
UnknownFunctionException(String) - +Constructor for exception uk.org.ury.server.exceptions.UnknownFunctionException +
Construct a new UnknownFunctionException. +
UserClass - Enum in uk.org.ury.database
The various user classes of the database driver.
diff --git a/doc/index-files/index-19.html b/doc/index-files/index-19.html index 64fc42e..9a8c337 100644 --- a/doc/index-files/index-19.html +++ b/doc/index-files/index-19.html @@ -2,12 +2,12 @@ - + V-Index - + diff --git a/doc/index-files/index-2.html b/doc/index-files/index-2.html index 9e90266..dd331cb 100644 --- a/doc/index-files/index-2.html +++ b/doc/index-files/index-2.html @@ -2,12 +2,12 @@ - + B-Index - + @@ -96,9 +96,6 @@ Constructor for exception uk.org.ury.server.exceptions.BadRequestException
Construct a new HandlerNotFoundException with a chained exception. -
buffer - -Variable in class uk.org.ury.server.ServerProtocol -
 
diff --git a/doc/index-files/index-3.html b/doc/index-files/index-3.html index 87e13f7..73b5ed5 100644 --- a/doc/index-files/index-3.html +++ b/doc/index-files/index-3.html @@ -2,12 +2,12 @@ - + C-Index - + @@ -93,8 +93,8 @@ Constructor for class uk.org.ury.client.test.configName - Variable in enum uk.org.ury.database.UserClass -
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.
ConfigReader - Class in uk.org.ury.config
Reads in an XML config file and creates config objects
ConfigReader(String) - Constructor for class uk.org.ury.config.ConfigReader
Read in the config file and create the Database and Auth configuration objects. diff --git a/doc/index-files/index-4.html b/doc/index-files/index-4.html index 0b2e075..bee8054 100644 --- a/doc/index-files/index-4.html +++ b/doc/index-files/index-4.html @@ -2,12 +2,12 @@ - + D-Index - + @@ -85,14 +85,12 @@ function windowTitle()
Database - Class in uk.org.ury.config
A Database Server configuration
Database(String, int, String) - Constructor for class uk.org.ury.config.Database
Create a database object -
DatabaseDriver - Class in uk.org.ury.database
A database connection manager that connects to the URY databases - using suitably privileged accounts, and handles the processing - of SQL queries.
DatabaseDriver(ConfigReader, UserClass) - +
DatabaseDriver - Class in uk.org.ury.database
A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.
DatabaseDriver(ConfigReader, UserClass) - Constructor for class uk.org.ury.database.DatabaseDriver
Construct a new DatabaseDriver with the given user class. -
DatabaseItem<E,T> - Class in uk.org.ury.database
An abstract class presenting a template for objects serving as - a data structure for collections of properties retrieved from - a SQL database.
DatabaseItem(Map<E, T>) - +
DatabaseItem<E,T> - Class in uk.org.ury.database
An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.
DatabaseItem(Map<E, T>) - Constructor for class uk.org.ury.database.DatabaseItem
Construct a new item from an existing list of properties.
decode(String) - @@ -113,12 +111,12 @@ Constructor for class uk.org.ury.testrig.DemoMenuPanel - Class in uk.org.ury.testrig
 
DemoMenuPanel(FrontendMaster) - Constructor for class uk.org.ury.testrig.DemoMenuPanel
Construct a new DemoMenuPanel. -
Directive - Enum in uk.org.ury.protocol
Directives supported by the protocol.
doConnection(Socket) - -Method in class uk.org.ury.server.Server +
Directive - Enum in uk.org.ury.protocol
Directives supported by the protocol.
DOCTYPE - +Static variable in class uk.org.ury.server.Server
 
doSearch(String) - Method in class uk.org.ury.library.viewer.LibraryViewer -
Do a library search. +
Does a library search.
diff --git a/doc/index-files/index-5.html b/doc/index-files/index-5.html index 563446c..fb8364f 100644 --- a/doc/index-files/index-5.html +++ b/doc/index-files/index-5.html @@ -2,12 +2,12 @@ - + E-Index - + diff --git a/doc/index-files/index-6.html b/doc/index-files/index-6.html index ae3effa..706c871 100644 --- a/doc/index-files/index-6.html +++ b/doc/index-files/index-6.html @@ -2,12 +2,12 @@ - + F-Index - + diff --git a/doc/index-files/index-7.html b/doc/index-files/index-7.html index 6fac977..46b54f2 100644 --- a/doc/index-files/index-7.html +++ b/doc/index-files/index-7.html @@ -2,12 +2,12 @@ - + G-Index - + @@ -90,17 +90,14 @@ Method in class uk.org.ury.database.get(int) - Method in class uk.org.ury.show.ShowChannel -
Retrieve an item from the channel. -
GET_HEADER - -Static variable in class uk.org.ury.server.ServerProtocol -
  +
Retrieves an item from the channel.
getBins() - Method in class uk.org.ury.show.viewer.ShowViewer
 
getChannelList(DatabaseDriver, int, int) - Static method in class uk.org.ury.show.ShowUtils -
Given a show and a channel, retrieve a list of all show items - bound to that channel for the show. +
Given a show and a channel, retrieve a list of all show items bound to + that channel for the show.
getChannels() - Method in class uk.org.ury.show.viewer.ShowViewer
  @@ -118,7 +115,7 @@ Method in class uk.org.ury.config.getDatabaseConnection(UserClass) - Method in class uk.org.ury.server.Server -
Get a database connection using the given user class. +
Gets a database connection using the given user class.
getDb() - Method in class uk.org.ury.config.Database
Get the name of the database diff --git a/doc/index-files/index-8.html b/doc/index-files/index-8.html index 86db5a8..2af44bd 100644 --- a/doc/index-files/index-8.html +++ b/doc/index-files/index-8.html @@ -2,12 +2,12 @@ - + H-Index - + @@ -82,6 +82,9 @@ function windowTitle()

H

+
handle(HttpRequest, HttpResponse, HttpContext) - +Method in class uk.org.ury.server.AbstractRequestHandler +
Begins handling of a HTTP request.
HandleFailureException - Exception in uk.org.ury.server.exceptions
Generic exception thrown when a server request handler fails to handle a request.
HandleFailureException() - Constructor for exception uk.org.ury.server.exceptions.HandleFailureException @@ -90,15 +93,14 @@ Constructor for exception uk.org.ury.server.exceptions.HandleFailureException(String) - Constructor for exception uk.org.ury.server.exceptions.HandleFailureException
Construct a new HandleFailureException. -
handleGet(List<String>) - -Method in class uk.org.ury.server.Server -
Handle a HTTP GET request. -
handleGetRequest(Map<String, String>, Server) - +
handleGet(HttpRequest, HttpResponse, HttpContext) - Method in class uk.org.ury.library.LibraryRequestHandler -
Handle a server GET request (that is, a request for data - output). -
handleGetRequest(Map<String, String>, Server) - -Method in interface uk.org.ury.server.RequestHandler +
Handle a HTTP GET request. +
handleGet(HttpRequest, HttpResponse, HttpContext) - +Method in class uk.org.ury.server.HttpHandler +
Handle a HTTP GET request. +
handleGetRequest(Map<String, String>, Server) - +Method in interface uk.org.ury.server.ApiRequestHandler
Handle a server GET request (that is, a request for data output).
handleGetRequest(Map<String, String>, Server) - @@ -140,6 +142,15 @@ Constructor for class uk.org.ury.frontend.HintField(String) - Constructor for class uk.org.ury.frontend.HintField
Construct a new HintField. +
HttpHandler - Class in uk.org.ury.server
 
HttpHandler(Server, String) - +Constructor for class uk.org.ury.server.HttpHandler +
Construct a new HttpHandler. +
HttpListenerThread - Class in uk.org.ury.server
Listener thread for the URY server HTTP interface.
HttpListenerThread(int, Server) - +Constructor for class uk.org.ury.server.HttpListenerThread +
  +
HttpWorkerThread - Class in uk.org.ury.server
A worker thread in the server HTTP interface.
HttpWorkerThread(HttpService, HttpServerConnection) - +Constructor for class uk.org.ury.server.HttpWorkerThread +
Construct a new HttpWorkerThread.
diff --git a/doc/index-files/index-9.html b/doc/index-files/index-9.html index 1abc931..78d445b 100644 --- a/doc/index-files/index-9.html +++ b/doc/index-files/index-9.html @@ -2,12 +2,12 @@ - + I-Index - + @@ -82,6 +82,9 @@ function windowTitle()

I

+
INDEX_HTML - +Static variable in class uk.org.ury.server.Server +
 
init() - Method in class uk.org.ury.frontend.FrontendApplet
Main method. -- cgit v1.2.3