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/library/LibraryRequestHandler.html | 88 ++++++++++++++-------- doc/uk/org/ury/library/LibraryUtils.html | 4 +- .../library/class-use/LibraryRequestHandler.html | 4 +- doc/uk/org/ury/library/class-use/LibraryUtils.html | 4 +- .../library/exceptions/EmptySearchException.html | 4 +- .../exceptions/class-use/EmptySearchException.html | 6 +- .../org/ury/library/exceptions/package-frame.html | 4 +- .../ury/library/exceptions/package-summary.html | 4 +- .../org/ury/library/exceptions/package-tree.html | 4 +- doc/uk/org/ury/library/exceptions/package-use.html | 4 +- doc/uk/org/ury/library/item/LibraryItem.html | 4 +- .../org/ury/library/item/LibraryItemProperty.html | 4 +- .../ury/library/item/class-use/LibraryItem.html | 4 +- .../item/class-use/LibraryItemProperty.html | 4 +- doc/uk/org/ury/library/item/package-frame.html | 4 +- doc/uk/org/ury/library/item/package-summary.html | 4 +- doc/uk/org/ury/library/item/package-tree.html | 4 +- doc/uk/org/ury/library/item/package-use.html | 4 +- doc/uk/org/ury/library/package-frame.html | 4 +- doc/uk/org/ury/library/package-summary.html | 4 +- doc/uk/org/ury/library/package-tree.html | 8 +- doc/uk/org/ury/library/package-use.html | 4 +- .../org/ury/library/viewer/LibraryTableModel.html | 4 +- doc/uk/org/ury/library/viewer/LibraryViewer.html | 24 ++++-- .../org/ury/library/viewer/LibraryViewerPanel.html | 4 +- .../viewer/class-use/LibraryTableModel.html | 4 +- .../library/viewer/class-use/LibraryViewer.html | 4 +- .../viewer/class-use/LibraryViewerPanel.html | 4 +- doc/uk/org/ury/library/viewer/package-frame.html | 4 +- doc/uk/org/ury/library/viewer/package-summary.html | 4 +- doc/uk/org/ury/library/viewer/package-tree.html | 4 +- doc/uk/org/ury/library/viewer/package-use.html | 4 +- 32 files changed, 136 insertions(+), 102 deletions(-) (limited to 'doc/uk/org/ury/library') diff --git a/doc/uk/org/ury/library/LibraryRequestHandler.html b/doc/uk/org/ury/library/LibraryRequestHandler.html index cf88582..6779f19 100644 --- a/doc/uk/org/ury/library/LibraryRequestHandler.html +++ b/doc/uk/org/ury/library/LibraryRequestHandler.html @@ -2,12 +2,12 @@ - + LibraryRequestHandler - + @@ -93,14 +93,15 @@ uk.org.ury.library Class LibraryRequestHandler 
 java.lang.Object
-  extended by uk.org.ury.library.LibraryRequestHandler
+  extended by uk.org.ury.server.AbstractRequestHandler
+      extended by uk.org.ury.library.LibraryRequestHandler
-
All Implemented Interfaces:
RequestHandler
+
All Implemented Interfaces:
org.apache.http.protocol.HttpRequestHandler
-
public class LibraryRequestHandler
extends java.lang.Object
implements RequestHandler
+
public class LibraryRequestHandler
extends AbstractRequestHandler

@@ -125,10 +126,11 @@ A request handler for library queries. Constructor Summary -LibraryRequestHandler() +LibraryRequestHandler(Server server, + java.lang.String mount)
-            +          Construct a new LibraryRequestHandler.   @@ -142,13 +144,22 @@ A request handler for library queries. - java.util.Map<java.lang.String,java.lang.Object> -handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, - Server server) + void +handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context)
-          Handle a server GET request (that is, a request for data - output). +          Handle a HTTP GET request. + + +  + + + + + +
Methods inherited from class uk.org.ury.server.AbstractRequestHandler
handle
  @@ -173,11 +184,16 @@ A request handler for library queries. -

+

LibraryRequestHandler

-public LibraryRequestHandler()
+public LibraryRequestHandler(Server server, + java.lang.String mount) +
+
Construct a new LibraryRequestHandler. +

+
Parameters:
server - The instance of the URY server responsible for the request.
mount - The directory to which this handler is to be mounted.
@@ -190,31 +206,39 @@ public LibraryRequestHandler() -

-handleGetRequest

+

+handleGet

-public java.util.Map<java.lang.String,java.lang.Object> handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters,
-                                                                         Server server)
-                                                                  throws HandleFailureException
+public void handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + throws HandlerNotFoundException, + HandlerSetupFailureException, + HandleFailureException, + BadRequestException, + NotAHandlerException, + UnknownFunctionException
-
Handle a server GET request (that is, a request for data - output). +
Handle a HTTP GET request.

-
Specified by:
handleGetRequest in interface RequestHandler
+
-
Parameters:
parameters - A key-value map of parameters supplied with - the server request. Typically, the function - parameter will detail the function that the - request handler is expected to perform.
server - The server from which the request originated. - This will be able to provide the handler with - pooled resources, for example the database. -
Returns:
A list of lines to return in the body of the - server's response to the client. +
Parameters:
request - The HTTP request.
response - The response that the handler will populate during the + handling of the request.
context - The HTTP context.
Throws: -
HandleFailureException - if the handler cannot - handle the request.
+
HandlerNotFoundException - if the client requested a request handler that could not be + found on the class path. +
HandlerSetupFailureException - if the handler was found but could not be set up (eg does not + implement appropriate interface or cannot be instantiated). +
HandleFailureException - if an appropriate handler was contacted, but it failed to + process the request. +
BadRequestException - if the request was malformed or invalid. +
NotAHandlerException - if the class requested to handle the request is not a + handler. +
UnknownFunctionException - if the request is for a path that does not correspond to one + of this handler's functions.
diff --git a/doc/uk/org/ury/library/LibraryUtils.html b/doc/uk/org/ury/library/LibraryUtils.html index 5d72605..1b35a2e 100644 --- a/doc/uk/org/ury/library/LibraryUtils.html +++ b/doc/uk/org/ury/library/LibraryUtils.html @@ -2,12 +2,12 @@ - + LibraryUtils - + diff --git a/doc/uk/org/ury/library/class-use/LibraryRequestHandler.html b/doc/uk/org/ury/library/class-use/LibraryRequestHandler.html index b7ad76f..eade63b 100644 --- a/doc/uk/org/ury/library/class-use/LibraryRequestHandler.html +++ b/doc/uk/org/ury/library/class-use/LibraryRequestHandler.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.LibraryRequestHandler - + diff --git a/doc/uk/org/ury/library/class-use/LibraryUtils.html b/doc/uk/org/ury/library/class-use/LibraryUtils.html index 7990e0e..aeb0c9f 100644 --- a/doc/uk/org/ury/library/class-use/LibraryUtils.html +++ b/doc/uk/org/ury/library/class-use/LibraryUtils.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.LibraryUtils - + diff --git a/doc/uk/org/ury/library/exceptions/EmptySearchException.html b/doc/uk/org/ury/library/exceptions/EmptySearchException.html index 6718556..44364b1 100644 --- a/doc/uk/org/ury/library/exceptions/EmptySearchException.html +++ b/doc/uk/org/ury/library/exceptions/EmptySearchException.html @@ -2,12 +2,12 @@ - + EmptySearchException - + diff --git a/doc/uk/org/ury/library/exceptions/class-use/EmptySearchException.html b/doc/uk/org/ury/library/exceptions/class-use/EmptySearchException.html index d10019e..300d6a3 100644 --- a/doc/uk/org/ury/library/exceptions/class-use/EmptySearchException.html +++ b/doc/uk/org/ury/library/exceptions/class-use/EmptySearchException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.exceptions.EmptySearchException - + @@ -146,7 +146,7 @@ Uses of doSearch(java.lang.String search)
-          Do a library search. +          Does a library search.   diff --git a/doc/uk/org/ury/library/exceptions/package-frame.html b/doc/uk/org/ury/library/exceptions/package-frame.html index 4d9997b..d8ca128 100644 --- a/doc/uk/org/ury/library/exceptions/package-frame.html +++ b/doc/uk/org/ury/library/exceptions/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.exceptions - + diff --git a/doc/uk/org/ury/library/exceptions/package-summary.html b/doc/uk/org/ury/library/exceptions/package-summary.html index 29f7dcc..4f89569 100644 --- a/doc/uk/org/ury/library/exceptions/package-summary.html +++ b/doc/uk/org/ury/library/exceptions/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.exceptions - + diff --git a/doc/uk/org/ury/library/exceptions/package-tree.html b/doc/uk/org/ury/library/exceptions/package-tree.html index d6803f6..4399d2b 100644 --- a/doc/uk/org/ury/library/exceptions/package-tree.html +++ b/doc/uk/org/ury/library/exceptions/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.exceptions Class Hierarchy - + diff --git a/doc/uk/org/ury/library/exceptions/package-use.html b/doc/uk/org/ury/library/exceptions/package-use.html index eef9aa1..1f41838 100644 --- a/doc/uk/org/ury/library/exceptions/package-use.html +++ b/doc/uk/org/ury/library/exceptions/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.library.exceptions - + diff --git a/doc/uk/org/ury/library/item/LibraryItem.html b/doc/uk/org/ury/library/item/LibraryItem.html index f112b8c..f6d9b0c 100644 --- a/doc/uk/org/ury/library/item/LibraryItem.html +++ b/doc/uk/org/ury/library/item/LibraryItem.html @@ -2,12 +2,12 @@ - + LibraryItem - + diff --git a/doc/uk/org/ury/library/item/LibraryItemProperty.html b/doc/uk/org/ury/library/item/LibraryItemProperty.html index 2356980..6b81af2 100644 --- a/doc/uk/org/ury/library/item/LibraryItemProperty.html +++ b/doc/uk/org/ury/library/item/LibraryItemProperty.html @@ -2,12 +2,12 @@ - + LibraryItemProperty - + diff --git a/doc/uk/org/ury/library/item/class-use/LibraryItem.html b/doc/uk/org/ury/library/item/class-use/LibraryItem.html index 8fbcc26..da696d2 100644 --- a/doc/uk/org/ury/library/item/class-use/LibraryItem.html +++ b/doc/uk/org/ury/library/item/class-use/LibraryItem.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.item.LibraryItem - + diff --git a/doc/uk/org/ury/library/item/class-use/LibraryItemProperty.html b/doc/uk/org/ury/library/item/class-use/LibraryItemProperty.html index 2d5c3a6..39d4d88 100644 --- a/doc/uk/org/ury/library/item/class-use/LibraryItemProperty.html +++ b/doc/uk/org/ury/library/item/class-use/LibraryItemProperty.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.item.LibraryItemProperty - + diff --git a/doc/uk/org/ury/library/item/package-frame.html b/doc/uk/org/ury/library/item/package-frame.html index d4f571c..774e04c 100644 --- a/doc/uk/org/ury/library/item/package-frame.html +++ b/doc/uk/org/ury/library/item/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.item - + diff --git a/doc/uk/org/ury/library/item/package-summary.html b/doc/uk/org/ury/library/item/package-summary.html index 6e2f33c..0dd3752 100644 --- a/doc/uk/org/ury/library/item/package-summary.html +++ b/doc/uk/org/ury/library/item/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.item - + diff --git a/doc/uk/org/ury/library/item/package-tree.html b/doc/uk/org/ury/library/item/package-tree.html index 25a19e3..3462b07 100644 --- a/doc/uk/org/ury/library/item/package-tree.html +++ b/doc/uk/org/ury/library/item/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.item Class Hierarchy - + diff --git a/doc/uk/org/ury/library/item/package-use.html b/doc/uk/org/ury/library/item/package-use.html index 98be535..f270bf3 100644 --- a/doc/uk/org/ury/library/item/package-use.html +++ b/doc/uk/org/ury/library/item/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.library.item - + diff --git a/doc/uk/org/ury/library/package-frame.html b/doc/uk/org/ury/library/package-frame.html index 1bc8298..890a6e0 100644 --- a/doc/uk/org/ury/library/package-frame.html +++ b/doc/uk/org/ury/library/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.library - + diff --git a/doc/uk/org/ury/library/package-summary.html b/doc/uk/org/ury/library/package-summary.html index 6ca2cbd..97cfa80 100644 --- a/doc/uk/org/ury/library/package-summary.html +++ b/doc/uk/org/ury/library/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.library - + diff --git a/doc/uk/org/ury/library/package-tree.html b/doc/uk/org/ury/library/package-tree.html index 52546f1..1aef993 100644 --- a/doc/uk/org/ury/library/package-tree.html +++ b/doc/uk/org/ury/library/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.library Class Hierarchy - + @@ -92,7 +92,9 @@ Class Hierarchy
diff --git a/doc/uk/org/ury/library/package-use.html b/doc/uk/org/ury/library/package-use.html index 57b1b08..c924530 100644 --- a/doc/uk/org/ury/library/package-use.html +++ b/doc/uk/org/ury/library/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.library - + diff --git a/doc/uk/org/ury/library/viewer/LibraryTableModel.html b/doc/uk/org/ury/library/viewer/LibraryTableModel.html index ca0bc2b..d6782c4 100644 --- a/doc/uk/org/ury/library/viewer/LibraryTableModel.html +++ b/doc/uk/org/ury/library/viewer/LibraryTableModel.html @@ -2,12 +2,12 @@ - + LibraryTableModel - + diff --git a/doc/uk/org/ury/library/viewer/LibraryViewer.html b/doc/uk/org/ury/library/viewer/LibraryViewer.html index e1f328e..a3a532b 100644 --- a/doc/uk/org/ury/library/viewer/LibraryViewer.html +++ b/doc/uk/org/ury/library/viewer/LibraryViewer.html @@ -2,12 +2,12 @@ - + LibraryViewer - + @@ -106,6 +106,14 @@ java.lang.Object

Module for investigating the track library. + + The LibraryViewer and its corresponding user + interface, LibraryViewerPanel, provide a + user interface for querying the server's library services + for track information. + + Subclasses of this module provide editing features for + the track library.

@@ -129,7 +137,7 @@ Module for investigating the track library. LibraryViewer()
-          Construct a new LibraryViewer as a frontend object. +          Constructs a new LibraryViewer as a frontend object.   @@ -147,7 +155,7 @@ Module for investigating the track library. doSearch(java.lang.String search)
-          Do a library search. +          Does a library search. @@ -163,7 +171,7 @@ Module for investigating the track library. runFrontend(FrontendMaster master)
-          Run the library viewer frontend. +          Runs the library viewer frontend.   @@ -193,7 +201,7 @@ LibraryViewer 

 public LibraryViewer()
-
Construct a new LibraryViewer as a frontend object. +
Constructs a new LibraryViewer as a frontend object.

@@ -212,7 +220,7 @@ runFrontend 
 public FrontendModulePanel runFrontend(FrontendMaster master)
-
Run the library viewer frontend. +
Runs the library viewer frontend.

Parameters:
master - The FrontendMaster driving the frontend. @@ -229,7 +237,7 @@ public void doSearch(java.lang.String search) throws EmptySearchException, InvalidMessageException
-
Do a library search. +
Does a library search. This will update the library list to reflect the results of the search.

diff --git a/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html b/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html index da89669..7cc7e7c 100644 --- a/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html +++ b/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html @@ -2,12 +2,12 @@ - + LibraryViewerPanel - + diff --git a/doc/uk/org/ury/library/viewer/class-use/LibraryTableModel.html b/doc/uk/org/ury/library/viewer/class-use/LibraryTableModel.html index 51f7375..9c6faf9 100644 --- a/doc/uk/org/ury/library/viewer/class-use/LibraryTableModel.html +++ b/doc/uk/org/ury/library/viewer/class-use/LibraryTableModel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.viewer.LibraryTableModel - + diff --git a/doc/uk/org/ury/library/viewer/class-use/LibraryViewer.html b/doc/uk/org/ury/library/viewer/class-use/LibraryViewer.html index 1888cf8..2697f24 100644 --- a/doc/uk/org/ury/library/viewer/class-use/LibraryViewer.html +++ b/doc/uk/org/ury/library/viewer/class-use/LibraryViewer.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.viewer.LibraryViewer - + diff --git a/doc/uk/org/ury/library/viewer/class-use/LibraryViewerPanel.html b/doc/uk/org/ury/library/viewer/class-use/LibraryViewerPanel.html index 3097d7f..95ccb6a 100644 --- a/doc/uk/org/ury/library/viewer/class-use/LibraryViewerPanel.html +++ b/doc/uk/org/ury/library/viewer/class-use/LibraryViewerPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.viewer.LibraryViewerPanel - + diff --git a/doc/uk/org/ury/library/viewer/package-frame.html b/doc/uk/org/ury/library/viewer/package-frame.html index 546a460..5ef64da 100644 --- a/doc/uk/org/ury/library/viewer/package-frame.html +++ b/doc/uk/org/ury/library/viewer/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.viewer - + diff --git a/doc/uk/org/ury/library/viewer/package-summary.html b/doc/uk/org/ury/library/viewer/package-summary.html index 28b86ee..ab6428e 100644 --- a/doc/uk/org/ury/library/viewer/package-summary.html +++ b/doc/uk/org/ury/library/viewer/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.viewer - + diff --git a/doc/uk/org/ury/library/viewer/package-tree.html b/doc/uk/org/ury/library/viewer/package-tree.html index 43aaab4..a50282f 100644 --- a/doc/uk/org/ury/library/viewer/package-tree.html +++ b/doc/uk/org/ury/library/viewer/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.viewer Class Hierarchy - + diff --git a/doc/uk/org/ury/library/viewer/package-use.html b/doc/uk/org/ury/library/viewer/package-use.html index 8023f8c..35b65aa 100644 --- a/doc/uk/org/ury/library/viewer/package-use.html +++ b/doc/uk/org/ury/library/viewer/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.library.viewer - + -- cgit v1.2.3