From cee53b021632c95f1b4882664a31ca639a9b0700 Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Sun, 20 Mar 2011 16:38:51 +0000 Subject: Rewrite of server to use HttpCore example code; beginning of code reformat from GNU style to Java conventions. Code now includes Apache license code. --- doc/allclasses-frame.html | 58 +- doc/allclasses-noframe.html | 58 +- doc/constant-values.html | 40 +- doc/deprecated-list.html | 4 +- doc/help-doc.html | 4 +- doc/index-files/index-1.html | 18 +- doc/index-files/index-10.html | 42 +- doc/index-files/index-11.html | 15 +- doc/index-files/index-12.html | 13 +- doc/index-files/index-13.html | 38 +- doc/index-files/index-14.html | 54 +- doc/index-files/index-15.html | 103 ++-- doc/index-files/index-16.html | 94 +++- doc/index-files/index-17.html | 37 +- doc/index-files/index-18.html | 50 +- doc/index-files/index-19.html | 177 ++++++ doc/index-files/index-2.html | 19 +- doc/index-files/index-3.html | 16 +- doc/index-files/index-4.html | 20 +- doc/index-files/index-5.html | 11 +- doc/index-files/index-6.html | 22 +- doc/index-files/index-7.html | 60 ++- doc/index-files/index-8.html | 56 +- doc/index-files/index-9.html | 27 +- doc/index.html | 2 +- doc/overview-frame.html | 20 +- doc/overview-summary.html | 36 +- doc/overview-tree.html | 41 +- doc/package-list | 8 + doc/serialized-form.html | 357 ++++++------ doc/uk/org/ury/client/Client.html | 259 +++++++++ doc/uk/org/ury/client/class-use/Client.html | 144 +++++ doc/uk/org/ury/client/package-frame.html | 32 ++ doc/uk/org/ury/client/package-summary.html | 157 ++++++ doc/uk/org/ury/client/package-tree.html | 153 ++++++ doc/uk/org/ury/client/package-use.html | 144 +++++ doc/uk/org/ury/client/test/ClientTest.html | 306 +++++++++++ .../org/ury/client/test/class-use/ClientTest.html | 144 +++++ doc/uk/org/ury/client/test/package-frame.html | 32 ++ doc/uk/org/ury/client/test/package-summary.html | 157 ++++++ doc/uk/org/ury/client/test/package-tree.html | 153 ++++++ doc/uk/org/ury/client/test/package-use.html | 144 +++++ doc/uk/org/ury/config/Auth.html | 4 +- doc/uk/org/ury/config/ConfigReader.html | 4 +- doc/uk/org/ury/config/Database.html | 4 +- doc/uk/org/ury/config/class-use/Auth.html | 4 +- doc/uk/org/ury/config/class-use/ConfigReader.html | 4 +- doc/uk/org/ury/config/class-use/Database.html | 4 +- doc/uk/org/ury/config/package-frame.html | 4 +- doc/uk/org/ury/config/package-summary.html | 8 +- doc/uk/org/ury/config/package-tree.html | 8 +- doc/uk/org/ury/config/package-use.html | 4 +- doc/uk/org/ury/database/DatabaseDriver.html | 4 +- doc/uk/org/ury/database/DatabaseItem.html | 30 +- doc/uk/org/ury/database/UserClass.html | 4 +- .../org/ury/database/class-use/DatabaseDriver.html | 37 +- .../org/ury/database/class-use/DatabaseItem.html | 24 +- doc/uk/org/ury/database/class-use/UserClass.html | 33 +- .../exceptions/ConnectionFailureException.html | 4 +- .../exceptions/MissingCredentialsException.html | 4 +- .../exceptions/MissingPropertyException.html | 4 +- .../database/exceptions/QueryFailureException.html | 4 +- .../class-use/ConnectionFailureException.html | 33 +- .../class-use/MissingCredentialsException.html | 33 +- .../class-use/MissingPropertyException.html | 4 +- .../class-use/QueryFailureException.html | 37 +- .../org/ury/database/exceptions/package-frame.html | 4 +- .../ury/database/exceptions/package-summary.html | 4 +- .../org/ury/database/exceptions/package-tree.html | 4 +- .../org/ury/database/exceptions/package-use.html | 24 +- doc/uk/org/ury/database/package-frame.html | 4 +- doc/uk/org/ury/database/package-summary.html | 4 +- doc/uk/org/ury/database/package-tree.html | 4 +- doc/uk/org/ury/database/package-use.html | 61 ++- .../org/ury/frontend/AbstractFrontendModule.html | 157 +----- doc/uk/org/ury/frontend/FrontendApplet.html | 543 +++++++++++++++++++ doc/uk/org/ury/frontend/FrontendBanner.html | 8 +- doc/uk/org/ury/frontend/FrontendControlPanel.html | 4 +- doc/uk/org/ury/frontend/FrontendError.html | 12 +- doc/uk/org/ury/frontend/FrontendFrame.html | 85 ++- doc/uk/org/ury/frontend/FrontendMaster.html | 65 ++- doc/uk/org/ury/frontend/FrontendModule.html | 6 +- doc/uk/org/ury/frontend/FrontendModulePanel.html | 17 +- doc/uk/org/ury/frontend/FrontendPanel.html | 21 +- doc/uk/org/ury/frontend/FrontendSubBanner.html | 4 +- doc/uk/org/ury/frontend/HintField.html | 4 +- .../frontend/class-use/AbstractFrontendModule.html | 35 +- .../org/ury/frontend/class-use/FrontendApplet.html | 181 +++++++ .../org/ury/frontend/class-use/FrontendBanner.html | 4 +- .../frontend/class-use/FrontendControlPanel.html | 17 +- .../org/ury/frontend/class-use/FrontendError.html | 4 +- .../org/ury/frontend/class-use/FrontendFrame.html | 4 +- .../org/ury/frontend/class-use/FrontendMaster.html | 26 +- .../org/ury/frontend/class-use/FrontendModule.html | 35 +- .../frontend/class-use/FrontendModulePanel.html | 55 +- .../org/ury/frontend/class-use/FrontendPanel.html | 22 +- .../ury/frontend/class-use/FrontendSubBanner.html | 4 +- doc/uk/org/ury/frontend/class-use/HintField.html | 4 +- .../frontend/exceptions/LoadFailureException.html | 268 +++++++++ .../exceptions/UICreationFailureException.html | 8 +- .../exceptions/class-use/LoadFailureException.html | 226 ++++++++ .../class-use/UICreationFailureException.html | 4 +- .../org/ury/frontend/exceptions/package-frame.html | 6 +- .../ury/frontend/exceptions/package-summary.html | 8 +- .../org/ury/frontend/exceptions/package-tree.html | 6 +- .../org/ury/frontend/exceptions/package-use.html | 10 +- doc/uk/org/ury/frontend/package-frame.html | 6 +- doc/uk/org/ury/frontend/package-summary.html | 10 +- doc/uk/org/ury/frontend/package-tree.html | 8 +- doc/uk/org/ury/frontend/package-use.html | 23 +- doc/uk/org/ury/library/LibraryRequestHandler.html | 283 ++++++++++ doc/uk/org/ury/library/LibraryUtils.html | 12 +- .../library/class-use/LibraryRequestHandler.html | 144 +++++ 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 | 8 +- .../org/ury/library/exceptions/package-tree.html | 8 +- doc/uk/org/ury/library/exceptions/package-use.html | 4 +- doc/uk/org/ury/library/item/LibraryItem.html | 242 +++++++++ .../org/ury/library/item/LibraryItemProperty.html | 599 +++++++++++++++++++++ .../ury/library/item/class-use/LibraryItem.html | 224 ++++++++ .../item/class-use/LibraryItemProperty.html | 211 ++++++++ doc/uk/org/ury/library/item/package-frame.html | 43 ++ doc/uk/org/ury/library/item/package-summary.html | 171 ++++++ doc/uk/org/ury/library/item/package-tree.html | 165 ++++++ doc/uk/org/ury/library/item/package-use.html | 208 +++++++ doc/uk/org/ury/library/package-frame.html | 19 +- doc/uk/org/ury/library/package-summary.html | 26 +- doc/uk/org/ury/library/package-tree.html | 20 +- doc/uk/org/ury/library/package-use.html | 57 +- .../org/ury/library/viewer/LibraryTableModel.html | 362 +++++++++++++ doc/uk/org/ury/library/viewer/LibraryViewer.html | 192 +------ .../org/ury/library/viewer/LibraryViewerPanel.html | 26 +- .../viewer/class-use/LibraryTableModel.html | 144 +++++ .../library/viewer/class-use/LibraryViewer.html | 4 +- .../viewer/class-use/LibraryViewerPanel.html | 4 +- doc/uk/org/ury/library/viewer/package-frame.html | 6 +- doc/uk/org/ury/library/viewer/package-summary.html | 18 +- doc/uk/org/ury/library/viewer/package-tree.html | 29 +- doc/uk/org/ury/library/viewer/package-use.html | 6 +- doc/uk/org/ury/protocol/Directive.html | 362 +++++++++++++ doc/uk/org/ury/protocol/ProtocolUtils.html | 322 +++++++++++ doc/uk/org/ury/protocol/Status.html | 330 ++++++++++++ doc/uk/org/ury/protocol/class-use/Directive.html | 189 +++++++ .../org/ury/protocol/class-use/ProtocolUtils.html | 144 +++++ doc/uk/org/ury/protocol/class-use/Status.html | 189 +++++++ .../exceptions/DecodeFailureException.html | 250 +++++++++ .../exceptions/InvalidMessageException.html | 251 +++++++++ .../class-use/DecodeFailureException.html | 209 +++++++ .../class-use/InvalidMessageException.html | 209 +++++++ .../org/ury/protocol/exceptions/package-frame.html | 34 ++ .../ury/protocol/exceptions/package-summary.html | 162 ++++++ .../org/ury/protocol/exceptions/package-tree.html | 158 ++++++ .../org/ury/protocol/exceptions/package-use.html | 216 ++++++++ doc/uk/org/ury/protocol/package-frame.html | 45 ++ doc/uk/org/ury/protocol/package-summary.html | 176 ++++++ doc/uk/org/ury/protocol/package-tree.html | 163 ++++++ doc/uk/org/ury/protocol/package-use.html | 176 ++++++ doc/uk/org/ury/server/RequestHandler.html | 238 ++++++++ doc/uk/org/ury/server/Server.html | 425 +++++++++++++++ doc/uk/org/ury/server/ServerProtocol.html | 314 +++++++++++ doc/uk/org/ury/server/ServerRequestHandler.html | 283 ++++++++++ .../org/ury/server/class-use/RequestHandler.html | 209 +++++++ doc/uk/org/ury/server/class-use/Server.html | 223 ++++++++ .../org/ury/server/class-use/ServerProtocol.html | 144 +++++ .../ury/server/class-use/ServerRequestHandler.html | 144 +++++ .../ury/server/exceptions/BadRequestException.html | 271 ++++++++++ .../server/exceptions/HandleFailureException.html | 270 ++++++++++ .../exceptions/HandlerNotFoundException.html | 275 ++++++++++ .../exceptions/HandlerSetupFailureException.html | 278 ++++++++++ .../ury/server/exceptions/HandlingException.html | 275 ++++++++++ .../server/exceptions/NotAHandlerException.html | 254 +++++++++ .../exceptions/class-use/BadRequestException.html | 180 +++++++ .../class-use/HandleFailureException.html | 231 ++++++++ .../class-use/HandlerNotFoundException.html | 180 +++++++ .../class-use/HandlerSetupFailureException.html | 180 +++++++ .../exceptions/class-use/HandlingException.html | 217 ++++++++ .../exceptions/class-use/NotAHandlerException.html | 180 +++++++ .../org/ury/server/exceptions/package-frame.html | 42 ++ .../org/ury/server/exceptions/package-summary.html | 182 +++++++ doc/uk/org/ury/server/exceptions/package-tree.html | 160 ++++++ doc/uk/org/ury/server/exceptions/package-use.html | 238 ++++++++ doc/uk/org/ury/server/package-frame.html | 47 ++ doc/uk/org/ury/server/package-summary.html | 180 +++++++ doc/uk/org/ury/server/package-tree.html | 159 ++++++ doc/uk/org/ury/server/package-use.html | 203 +++++++ doc/uk/org/ury/show/ShowChannel.html | 26 +- doc/uk/org/ury/show/ShowUtils.html | 12 +- doc/uk/org/ury/show/class-use/ShowChannel.html | 4 +- doc/uk/org/ury/show/class-use/ShowUtils.html | 4 +- doc/uk/org/ury/show/item/ShowItem.html | 278 ++++++++++ doc/uk/org/ury/show/item/ShowItemProperty.html | 382 +++++++++++++ doc/uk/org/ury/show/item/class-use/ShowItem.html | 224 ++++++++ .../ury/show/item/class-use/ShowItemProperty.html | 203 +++++++ doc/uk/org/ury/show/item/package-frame.html | 43 ++ doc/uk/org/ury/show/item/package-summary.html | 171 ++++++ doc/uk/org/ury/show/item/package-tree.html | 165 ++++++ doc/uk/org/ury/show/item/package-use.html | 189 +++++++ doc/uk/org/ury/show/package-frame.html | 17 +- doc/uk/org/ury/show/package-summary.html | 30 +- doc/uk/org/ury/show/package-tree.html | 24 +- doc/uk/org/ury/show/package-use.html | 29 +- doc/uk/org/ury/show/viewer/ChannelPanel.html | 24 +- .../org/ury/show/viewer/LibraryControlPanel.html | 4 +- doc/uk/org/ury/show/viewer/ShowViewer.html | 170 +----- doc/uk/org/ury/show/viewer/ShowViewerPanel.html | 27 +- doc/uk/org/ury/show/viewer/TrackBin.html | 22 +- .../ury/show/viewer/class-use/ChannelPanel.html | 4 +- .../show/viewer/class-use/LibraryControlPanel.html | 4 +- .../org/ury/show/viewer/class-use/ShowViewer.html | 4 +- .../ury/show/viewer/class-use/ShowViewerPanel.html | 4 +- doc/uk/org/ury/show/viewer/class-use/TrackBin.html | 4 +- doc/uk/org/ury/show/viewer/package-frame.html | 4 +- doc/uk/org/ury/show/viewer/package-summary.html | 12 +- doc/uk/org/ury/show/viewer/package-tree.html | 26 +- doc/uk/org/ury/show/viewer/package-use.html | 4 +- doc/uk/org/ury/testrig/ApplicationLauncher.html | 289 ++++++++++ doc/uk/org/ury/testrig/DemoControlPanel.html | 8 +- doc/uk/org/ury/testrig/DemoMenu.html | 180 ++----- doc/uk/org/ury/testrig/DemoMenuPanel.html | 20 +- doc/uk/org/ury/testrig/Launcher.html | 215 ++++++++ .../ury/testrig/class-use/ApplicationLauncher.html | 144 +++++ .../ury/testrig/class-use/DemoControlPanel.html | 4 +- doc/uk/org/ury/testrig/class-use/DemoMenu.html | 4 +- .../org/ury/testrig/class-use/DemoMenuPanel.html | 4 +- doc/uk/org/ury/testrig/class-use/Launcher.html | 210 ++++++++ doc/uk/org/ury/testrig/package-frame.html | 17 +- doc/uk/org/ury/testrig/package-summary.html | 22 +- doc/uk/org/ury/testrig/package-tree.html | 21 +- doc/uk/org/ury/testrig/package-use.html | 51 +- 232 files changed, 19993 insertions(+), 1767 deletions(-) create mode 100644 doc/index-files/index-19.html create mode 100644 doc/uk/org/ury/client/Client.html create mode 100644 doc/uk/org/ury/client/class-use/Client.html create mode 100644 doc/uk/org/ury/client/package-frame.html create mode 100644 doc/uk/org/ury/client/package-summary.html create mode 100644 doc/uk/org/ury/client/package-tree.html create mode 100644 doc/uk/org/ury/client/package-use.html create mode 100644 doc/uk/org/ury/client/test/ClientTest.html create mode 100644 doc/uk/org/ury/client/test/class-use/ClientTest.html create mode 100644 doc/uk/org/ury/client/test/package-frame.html create mode 100644 doc/uk/org/ury/client/test/package-summary.html create mode 100644 doc/uk/org/ury/client/test/package-tree.html create mode 100644 doc/uk/org/ury/client/test/package-use.html create mode 100644 doc/uk/org/ury/frontend/FrontendApplet.html create mode 100644 doc/uk/org/ury/frontend/class-use/FrontendApplet.html create mode 100644 doc/uk/org/ury/frontend/exceptions/LoadFailureException.html create mode 100644 doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html create mode 100644 doc/uk/org/ury/library/LibraryRequestHandler.html create mode 100644 doc/uk/org/ury/library/class-use/LibraryRequestHandler.html create mode 100644 doc/uk/org/ury/library/item/LibraryItem.html create mode 100644 doc/uk/org/ury/library/item/LibraryItemProperty.html create mode 100644 doc/uk/org/ury/library/item/class-use/LibraryItem.html create mode 100644 doc/uk/org/ury/library/item/class-use/LibraryItemProperty.html create mode 100644 doc/uk/org/ury/library/item/package-frame.html create mode 100644 doc/uk/org/ury/library/item/package-summary.html create mode 100644 doc/uk/org/ury/library/item/package-tree.html create mode 100644 doc/uk/org/ury/library/item/package-use.html create mode 100644 doc/uk/org/ury/library/viewer/LibraryTableModel.html create mode 100644 doc/uk/org/ury/library/viewer/class-use/LibraryTableModel.html create mode 100644 doc/uk/org/ury/protocol/Directive.html create mode 100644 doc/uk/org/ury/protocol/ProtocolUtils.html create mode 100644 doc/uk/org/ury/protocol/Status.html create mode 100644 doc/uk/org/ury/protocol/class-use/Directive.html create mode 100644 doc/uk/org/ury/protocol/class-use/ProtocolUtils.html create mode 100644 doc/uk/org/ury/protocol/class-use/Status.html create mode 100644 doc/uk/org/ury/protocol/exceptions/DecodeFailureException.html create mode 100644 doc/uk/org/ury/protocol/exceptions/InvalidMessageException.html create mode 100644 doc/uk/org/ury/protocol/exceptions/class-use/DecodeFailureException.html create mode 100644 doc/uk/org/ury/protocol/exceptions/class-use/InvalidMessageException.html create mode 100644 doc/uk/org/ury/protocol/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/protocol/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/protocol/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/protocol/exceptions/package-use.html create mode 100644 doc/uk/org/ury/protocol/package-frame.html create mode 100644 doc/uk/org/ury/protocol/package-summary.html create mode 100644 doc/uk/org/ury/protocol/package-tree.html create mode 100644 doc/uk/org/ury/protocol/package-use.html create mode 100644 doc/uk/org/ury/server/RequestHandler.html create mode 100644 doc/uk/org/ury/server/Server.html create mode 100644 doc/uk/org/ury/server/ServerProtocol.html create mode 100644 doc/uk/org/ury/server/ServerRequestHandler.html create mode 100644 doc/uk/org/ury/server/class-use/RequestHandler.html create mode 100644 doc/uk/org/ury/server/class-use/Server.html create mode 100644 doc/uk/org/ury/server/class-use/ServerProtocol.html create mode 100644 doc/uk/org/ury/server/class-use/ServerRequestHandler.html create mode 100644 doc/uk/org/ury/server/exceptions/BadRequestException.html create mode 100644 doc/uk/org/ury/server/exceptions/HandleFailureException.html create mode 100644 doc/uk/org/ury/server/exceptions/HandlerNotFoundException.html create mode 100644 doc/uk/org/ury/server/exceptions/HandlerSetupFailureException.html create mode 100644 doc/uk/org/ury/server/exceptions/HandlingException.html create mode 100644 doc/uk/org/ury/server/exceptions/NotAHandlerException.html create mode 100644 doc/uk/org/ury/server/exceptions/class-use/BadRequestException.html create mode 100644 doc/uk/org/ury/server/exceptions/class-use/HandleFailureException.html create mode 100644 doc/uk/org/ury/server/exceptions/class-use/HandlerNotFoundException.html create mode 100644 doc/uk/org/ury/server/exceptions/class-use/HandlerSetupFailureException.html create mode 100644 doc/uk/org/ury/server/exceptions/class-use/HandlingException.html create mode 100644 doc/uk/org/ury/server/exceptions/class-use/NotAHandlerException.html create mode 100644 doc/uk/org/ury/server/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/server/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/server/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/server/exceptions/package-use.html create mode 100644 doc/uk/org/ury/server/package-frame.html create mode 100644 doc/uk/org/ury/server/package-summary.html create mode 100644 doc/uk/org/ury/server/package-tree.html create mode 100644 doc/uk/org/ury/server/package-use.html create mode 100644 doc/uk/org/ury/show/item/ShowItem.html create mode 100644 doc/uk/org/ury/show/item/ShowItemProperty.html create mode 100644 doc/uk/org/ury/show/item/class-use/ShowItem.html create mode 100644 doc/uk/org/ury/show/item/class-use/ShowItemProperty.html create mode 100644 doc/uk/org/ury/show/item/package-frame.html create mode 100644 doc/uk/org/ury/show/item/package-summary.html create mode 100644 doc/uk/org/ury/show/item/package-tree.html create mode 100644 doc/uk/org/ury/show/item/package-use.html create mode 100644 doc/uk/org/ury/testrig/ApplicationLauncher.html create mode 100644 doc/uk/org/ury/testrig/Launcher.html create mode 100644 doc/uk/org/ury/testrig/class-use/ApplicationLauncher.html create mode 100644 doc/uk/org/ury/testrig/class-use/Launcher.html (limited to 'doc') diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html index 5b817fb..73bb778 100644 --- a/doc/allclasses-frame.html +++ b/doc/allclasses-frame.html @@ -2,12 +2,12 @@ - + All Classes - + @@ -23,10 +23,18 @@ All Classes AbstractFrontendModule
+ApplicationLauncher +
Auth
+BadRequestException +
ChannelPanel
+Client +
+ClientTest +
ConfigReader
ConnectionFailureException @@ -37,15 +45,19 @@ All Classes
DatabaseItem
+DecodeFailureException +
DemoControlPanel
DemoMenu
DemoMenuPanel
+Directive +
EmptySearchException
-FrontendAppletPanel +FrontendApplet
FrontendBanner
@@ -65,15 +77,29 @@ All Classes
FrontendSubBanner
+HandleFailureException +
+HandlerNotFoundException +
+HandlerSetupFailureException +
+HandlingException +
HintField
+InvalidMessageException +
+Launcher +
LibraryControlPanel
-LibraryItem +LibraryItem +
+LibraryItemProperty
-LibraryItemProperty +LibraryRequestHandler
-LibraryTableModel +LibraryTableModel
LibraryUtils
@@ -81,17 +107,31 @@ All Classes
LibraryViewerPanel
+LoadFailureException +
MissingCredentialsException
MissingPropertyException
+NotAHandlerException +
+ProtocolUtils +
QueryFailureException
+RequestHandler +
+Server +
+ServerProtocol +
+ServerRequestHandler +
ShowChannel
-ShowItem +ShowItem
-ShowItemProperty +ShowItemProperty
ShowUtils
@@ -99,6 +139,8 @@ All Classes
ShowViewerPanel
+Status +
TrackBin
UICreationFailureException diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html index b680097..b8dfe7d 100644 --- a/doc/allclasses-noframe.html +++ b/doc/allclasses-noframe.html @@ -2,12 +2,12 @@ - + All Classes - + @@ -23,10 +23,18 @@ All Classes AbstractFrontendModule
+ApplicationLauncher +
Auth
+BadRequestException +
ChannelPanel
+Client +
+ClientTest +
ConfigReader
ConnectionFailureException @@ -37,15 +45,19 @@ All Classes
DatabaseItem
+DecodeFailureException +
DemoControlPanel
DemoMenu
DemoMenuPanel
+Directive +
EmptySearchException
-FrontendAppletPanel +FrontendApplet
FrontendBanner
@@ -65,15 +77,29 @@ All Classes
FrontendSubBanner
+HandleFailureException +
+HandlerNotFoundException +
+HandlerSetupFailureException +
+HandlingException +
HintField
+InvalidMessageException +
+Launcher +
LibraryControlPanel
-LibraryItem +LibraryItem +
+LibraryItemProperty
-LibraryItemProperty +LibraryRequestHandler
-LibraryTableModel +LibraryTableModel
LibraryUtils
@@ -81,17 +107,31 @@ All Classes
LibraryViewerPanel
+LoadFailureException +
MissingCredentialsException
MissingPropertyException
+NotAHandlerException +
+ProtocolUtils +
QueryFailureException
+RequestHandler +
+Server +
+ServerProtocol +
+ServerRequestHandler +
ShowChannel
-ShowItem +ShowItem
-ShowItemProperty +ShowItemProperty
ShowUtils
@@ -99,6 +139,8 @@ All Classes
ShowViewerPanel
+Status +
TrackBin
UICreationFailureException diff --git a/doc/constant-values.html b/doc/constant-values.html index 2d64792..e09905e 100644 --- a/doc/constant-values.html +++ b/doc/constant-values.html @@ -2,12 +2,12 @@ - + Constant Field Values - + @@ -98,6 +98,24 @@ uk.org.*

+ + + + + + + + + + + +
uk.org.ury.server.ServerProtocol
+public static final java.lang.StringGET_HEADER"HTTP/1.1 200 OK\n"
+ +

+ +

+ @@ -114,6 +132,24 @@ uk.org.*

+

+ +

uk.org.ury.show.ShowUtils
+ + + + + + + + + + +
uk.org.ury.testrig.Launcher
+public static final java.lang.StringDEFAULT_MODULE_NAME"testrig.DemoMenu"
+ +

+

diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html index 65a757f..480c71f 100644 --- a/doc/deprecated-list.html +++ b/doc/deprecated-list.html @@ -2,12 +2,12 @@ - + Deprecated List - + diff --git a/doc/help-doc.html b/doc/help-doc.html index 52d4416..dbfa0f8 100644 --- a/doc/help-doc.html +++ b/doc/help-doc.html @@ -2,12 +2,12 @@ - + API Help - + diff --git a/doc/index-files/index-1.html b/doc/index-files/index-1.html index fe3d35a..888aa74 100644 --- a/doc/index-files/index-1.html +++ b/doc/index-files/index-1.html @@ -2,12 +2,12 @@ - + A-Index - + @@ -78,19 +78,25 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V

A

AbstractFrontendModule - Class in uk.org.ury.frontend
An abstract implementation of the FrontendModule interface.
AbstractFrontendModule() - Constructor for class uk.org.ury.frontend.AbstractFrontendModule
  -
add(int, ShowItem) - +
add(int, ShowItem) - Method in class uk.org.ury.show.ShowChannel
Add a new item to the channel. -
add(ShowItem) - +
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() - +Constructor for class uk.org.ury.testrig.ApplicationLauncher +
  +
asResponse() - +Method in class uk.org.ury.database.DatabaseItem +
Retrieve a map of string representations of the properties.
Auth - Class in uk.org.ury.config
A login authorisation configuration
Auth(String, String) - Constructor for class uk.org.ury.config.Auth
Create a login auth object @@ -148,7 +154,7 @@ Constructor for class uk.org.ury.config. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-10.html b/doc/index-files/index-10.html index aa8a428..a8824ad 100644 --- a/doc/index-files/index-10.html +++ b/doc/index-files/index-10.html @@ -2,12 +2,12 @@ - + L-Index - + @@ -78,36 +78,46 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V

L

-
LibraryControlPanel - Class in uk.org.ury.show.viewer
Control panel for the demo system.
LibraryControlPanel() - +
Launcher - Interface in uk.org.ury.testrig
Interface for entry points into the frontend.
LibraryControlPanel - Class in uk.org.ury.show.viewer
Control panel for the demo system.
LibraryControlPanel() - Constructor for class uk.org.ury.show.viewer.LibraryControlPanel
Construct a new LibraryControlPanel. -
LibraryItem - Class in uk.org.ury.library
An item in the URY library.
LibraryItem(Map<LibraryItemProperty, String>) - -Constructor for class uk.org.ury.library.LibraryItem +
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
The parameters that are stored in the LibraryItem.
LibraryTableModel - Class in uk.org.ury.library
A table model for the library viewer.
LibraryTableModel(List<LibraryItem>) - -Constructor for class uk.org.ury.library.LibraryTableModel +
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() - +Constructor for class uk.org.ury.library.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.
LibraryUtils - Class in uk.org.ury.library
A set of common utility routines to facilitate the extraction of library items from the library areas of the URY database.
LibraryUtils() - Constructor for class uk.org.ury.library.LibraryUtils
  -
LibraryViewer - Class in uk.org.ury.library.viewer
 
LibraryViewer() - +
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.
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. -
loadModule(String) - -Method in class uk.org.ury.frontend.FrontendAppletPanel +
LoadFailureException - Exception in uk.org.ury.frontend.exceptions
Exception thrown when the loading of a new frontend module fails.
LoadFailureException() - +Constructor for exception uk.org.ury.frontend.exceptions.LoadFailureException +
Construct a new LoadFailureException with a + default reason. +
LoadFailureException(String) - +Constructor for exception uk.org.ury.frontend.exceptions.LoadFailureException +
Construct a new LoadFailureException. +
loadModule(String) - +Method in class uk.org.ury.frontend.FrontendApplet
Load a module into the frontend frame. -
loadModule(String, String) - -Method in class uk.org.ury.frontend.FrontendAppletPanel -
Load a module into the frontend frame, additionally installing - a control panel to communicate with the previous module. +
loadModule(String, String) - +Method in class uk.org.ury.frontend.FrontendApplet +
Load a module into the frontend frame, additionally installing a control + panel to communicate with the previous module.
loadModule(String) - Method in class uk.org.ury.frontend.FrontendFrame
Load a module into the frontend frame. @@ -179,7 +189,7 @@ Method in class uk.org.ury.testrig. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-11.html b/doc/index-files/index-11.html index 414c5ef..6cae7cd 100644 --- a/doc/index-files/index-11.html +++ b/doc/index-files/index-11.html @@ -2,12 +2,12 @@ - + M-Index - + @@ -78,12 +78,15 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V

M

-
main(String[]) - -Static method in class uk.org.ury.testrig.DemoMenu +
main(String[]) - +Static method in class uk.org.ury.server.Server +
The main method, which serves to create a server. +
main(String[]) - +Static method in class uk.org.ury.testrig.ApplicationLauncher
Main method.
MissingCredentialsException - Exception in uk.org.ury.database.exceptions
Exception thrown when the database credentials required to log into the URY database under a user class are missing, @@ -156,7 +159,7 @@ Constructor for exception uk.org.ury.database.exceptions. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-12.html b/doc/index-files/index-12.html index d0810f7..98ffbc9 100644 --- a/doc/index-files/index-12.html +++ b/doc/index-files/index-12.html @@ -2,12 +2,12 @@ - + N-Index - + @@ -78,10 +78,15 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V

N

+
NotAHandlerException - Exception in uk.org.ury.server.exceptions
Exception thrown if the class requested as a handler by the client + is, in fact, not a handler (it does not implement RequestHandler).
NotAHandlerException(String) - +Constructor for exception uk.org.ury.server.exceptions.NotAHandlerException +
Construct a NotAHandlerException with the name of the class that + is not a handler.
NUM_CHANNELS - Static variable in class uk.org.ury.show.ShowUtils
The number of channels reserved for show items. @@ -139,7 +144,7 @@ Static variable in class uk.org.ury.show. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-13.html b/doc/index-files/index-13.html index a6f269e..0d582d8 100644 --- a/doc/index-files/index-13.html +++ b/doc/index-files/index-13.html @@ -2,12 +2,12 @@ - + -Q-Index +P-Index - + @@ -15,7 +15,7 @@ Q-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Q-Index"; + parent.document.title="P-Index"; } } @@ -78,18 +78,24 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
-

-Q

+A B C D E F G H I L M N P Q R S T U V
+

+P

-
QueryFailureException - Exception in uk.org.ury.database.exceptions
Exception thrown when the database backend fails to execute - a query.
QueryFailureException() - -Constructor for exception uk.org.ury.database.exceptions.QueryFailureException -
Construct a new QueryFailureException with a - default reason. -
QueryFailureException(String) - -Constructor for exception uk.org.ury.database.exceptions.QueryFailureException -
Construct a new QueryFailureException. +
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 +
 
@@ -144,7 +150,7 @@ Constructor for exception uk.org.ury.database.exceptions. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-14.html b/doc/index-files/index-14.html index f405e56..6811312 100644 --- a/doc/index-files/index-14.html +++ b/doc/index-files/index-14.html @@ -2,12 +2,12 @@ - + -R-Index +Q-Index - + @@ -15,7 +15,7 @@ R-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="R-Index"; + parent.document.title="Q-Index"; } } @@ -78,40 +78,18 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
-

-R

+A B C D E F G H I L M N P Q R S T U V
+

+Q

-
reportFatal(String, FrontendFrame) - -Static method in class uk.org.ury.frontend.FrontendError -
Create an error dialogue to report a fatal error. -
reportFatal(String, FrontendAppletPanel) - -Static method in class uk.org.ury.frontend.FrontendError -
  -
restoreModule(FrontendModulePanel, FrontendControlPanel) - -Method in class uk.org.ury.frontend.FrontendAppletPanel -
Restore an existing module and control panel into the frontend - frame. -
restoreModule(FrontendModulePanel, FrontendControlPanel) - -Method in class uk.org.ury.frontend.FrontendFrame -
Restore an existing module and control panel into the frontend - frame. -
restoreModule(FrontendModulePanel, FrontendControlPanel) - -Method in interface uk.org.ury.frontend.FrontendMaster -
Restore an existing module and control panel into the frontend - master. -
run() - -Method in class uk.org.ury.testrig.DemoMenu -
Run the demo menu, creating a user interface. -
runFrontend(FrontendMaster) - -Method in interface uk.org.ury.frontend.FrontendModule -
Begin execution of the frontend module. -
runFrontend(FrontendMaster) - -Method in class uk.org.ury.library.viewer.LibraryViewer -
Run the library viewer frontend. -
runFrontend(FrontendMaster) - -Method in class uk.org.ury.show.viewer.ShowViewer -
Run the library viewer frontend. +
QueryFailureException - Exception in uk.org.ury.database.exceptions
Exception thrown when the database backend fails to execute + a query.
QueryFailureException() - +Constructor for exception uk.org.ury.database.exceptions.QueryFailureException +
Construct a new QueryFailureException with a + default reason. +
QueryFailureException(String) - +Constructor for exception uk.org.ury.database.exceptions.QueryFailureException +
Construct a new QueryFailureException.
@@ -166,7 +144,7 @@ Method in class uk.org.ury.show.viewer. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-15.html b/doc/index-files/index-15.html index e56cc06..933479c 100644 --- a/doc/index-files/index-15.html +++ b/doc/index-files/index-15.html @@ -2,12 +2,12 @@ - + -S-Index +R-Index - + @@ -15,7 +15,7 @@ S-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="S-Index"; + parent.document.title="R-Index"; } } @@ -78,67 +78,46 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
-

-S

+A B C D E F G H I L M N P Q R S T U V
+

+R

-
search(DatabaseDriver, String) - -Static method in class uk.org.ury.library.LibraryUtils -
Perform a library search. -
search() - -Method in class uk.org.ury.library.viewer.LibraryViewerPanel -
Action method for performing a search, bound by the UI XML - manifest to the search field and button. -
search() - -Method in class uk.org.ury.show.viewer.ShowViewerPanel -
Initialise the library viewer for the purposes of adding tracks - and/or browsing the library. -
setMaster(FrontendMaster) - -Method in class uk.org.ury.frontend.FrontendPanel -
Set the frontend master. -
setPanels(FrontendModulePanel, FrontendModulePanel) - -Method in class uk.org.ury.frontend.FrontendControlPanel -
Set the parent and child panels that this ControlPanel - facilitates intercommunication. -
setPreviousCPanel(FrontendControlPanel) - -Method in class uk.org.ury.frontend.FrontendControlPanel -
Set the previous control panel (if any), so that it can be - restored when this control panel returns control to the - parent. -
setText(String) - -Method in class uk.org.ury.frontend.FrontendSubBanner +
reportFatal(String, FrontendFrame) - +Static method in class uk.org.ury.frontend.FrontendError +
Create an error dialogue to report a fatal error. +
reportFatal(String, FrontendApplet) - +Static method in class uk.org.ury.frontend.FrontendError
  -
setTitle(String) - -Method in class uk.org.ury.frontend.FrontendBanner -
Change the title displayed on the banner. -
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. -
ShowItem - Class in uk.org.ury.show
An item in the show database.
ShowItem(Map<ShowItemProperty, String>) - -Constructor for class uk.org.ury.show.ShowItem -
Construct a new ShowItem. -
ShowItemProperty - Enum in uk.org.ury.show
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() - -Constructor for class uk.org.ury.show.viewer.ShowViewer -
Construct a new ShowViewer as a frontend object. -
ShowViewerPanel - Class in uk.org.ury.show.viewer
Frontend panel providing access to an underlying lshow viewer.
ShowViewerPanel(ShowViewer, FrontendMaster) - -Constructor for class uk.org.ury.show.viewer.ShowViewerPanel -
Construct a new ShowViewerPanel. -
sql - -Variable in enum uk.org.ury.library.LibraryItemProperty -
  -
sql - -Variable in enum uk.org.ury.show.ShowItemProperty -
  -
start() - +
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<?, ?>) - +Static method in class uk.org.ury.protocol.ProtocolUtils +
Check if a response is flagged as having OK status. +
restoreModule(FrontendModulePanel, FrontendControlPanel) - +Method in class uk.org.ury.frontend.FrontendApplet +
Restore an existing module and control panel into the frontend frame. +
restoreModule(FrontendModulePanel, FrontendControlPanel) - +Method in class uk.org.ury.frontend.FrontendFrame +
Restore an existing module and control panel into the frontend + frame. +
restoreModule(FrontendModulePanel, FrontendControlPanel) - +Method in interface uk.org.ury.frontend.FrontendMaster +
Restore an existing module and control panel into the frontend + master. +
run() - +Method in class uk.org.ury.testrig.DemoMenu +
Run the demo menu, creating a user interface. +
runFrontend(FrontendMaster) - +Method in interface uk.org.ury.frontend.FrontendModule +
Begin execution of the frontend module. +
runFrontend(FrontendMaster) - Method in class uk.org.ury.library.viewer.LibraryViewer -
Run the library viewer frontend as an applet. -
start() - +
Run the library viewer frontend. +
runFrontend(FrontendMaster) - Method in class uk.org.ury.show.viewer.ShowViewer -
Run the library viewer frontend as an applet. +
Run the library viewer frontend. +
runFrontend(FrontendMaster) - +Method in class uk.org.ury.testrig.DemoMenu +
Run the demo menu in frontend mode.
@@ -193,7 +172,7 @@ Method in class uk.org.ury.show.viewer. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-16.html b/doc/index-files/index-16.html index 0e7c50a..3eab2a9 100644 --- a/doc/index-files/index-16.html +++ b/doc/index-files/index-16.html @@ -2,12 +2,12 @@ - + -T-Index +S-Index - + @@ -15,7 +15,7 @@ T-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="T-Index"; + parent.document.title="S-Index"; } } @@ -78,17 +78,83 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
-

-T

+A B C D E F G H I L M N P Q R S T U V
+

+S

-
toString() - -Method in class uk.org.ury.show.ShowItem +
search(DatabaseDriver, String) - +Static method in class uk.org.ury.library.LibraryUtils +
Perform a library search. +
search() - +Method in class uk.org.ury.library.viewer.LibraryViewerPanel +
Action method for performing a search, bound by the UI XML manifest to + the search field and button. +
search() - +Method in class uk.org.ury.show.viewer.ShowViewerPanel +
Initialise the library viewer for the purposes of adding tracks + and/or browsing the library. +
Server - Class in uk.org.ury.server
The unified URY server, accepting requests over HTTP.
Server() - +Constructor for class uk.org.ury.server.Server
  -
TrackBin - Class in uk.org.ury.show.viewer
A panel displaying track bin contents.
TrackBin(String) - -Constructor for class uk.org.ury.show.viewer.TrackBin -
Construct a new TrackBin. -
+
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 +
  +
ServerRequestHandler - Class in uk.org.ury.server
A request handler for server queries.
ServerRequestHandler() - +Constructor for class uk.org.ury.server.ServerRequestHandler +
  +
setMaster(FrontendMaster) - +Method in class uk.org.ury.frontend.FrontendPanel +
Set the frontend master. +
setPanels(FrontendModulePanel, FrontendModulePanel) - +Method in class uk.org.ury.frontend.FrontendControlPanel +
Set the parent and child panels that this ControlPanel + facilitates intercommunication. +
setPreviousCPanel(FrontendControlPanel) - +Method in class uk.org.ury.frontend.FrontendControlPanel +
Set the previous control panel (if any), so that it can be + restored when this control panel returns control to the + parent. +
setText(String) - +Method in class uk.org.ury.frontend.FrontendSubBanner +
  +
setTitle(String) - +Method in class uk.org.ury.frontend.FrontendBanner +
Change the title displayed on the banner. +
setUp() - +Method in class uk.org.ury.client.test.ClientTest +
  +
setupUI() - +Method in class uk.org.ury.frontend.FrontendApplet +
Set up the user interface of the frame. +
setupUI() - +Method in class uk.org.ury.frontend.FrontendFrame +
Set up the user interface of the frame. +
setupUI() - +Method in interface uk.org.ury.frontend.FrontendMaster +
Set up the frontend master's user interface. +
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. +
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() - +Constructor for class uk.org.ury.show.ShowUtils +
  +
ShowViewer - Class in uk.org.ury.show.viewer
Frontend module for viewing show details.
ShowViewer() - +Constructor for class uk.org.ury.show.viewer.ShowViewer +
Construct a new ShowViewer as a frontend object. +
ShowViewerPanel - Class in uk.org.ury.show.viewer
Frontend panel providing access to an underlying show viewer.
ShowViewerPanel(ShowViewer, FrontendMaster) - +Constructor for class uk.org.ury.show.viewer.ShowViewerPanel +
Construct a new ShowViewerPanel. +
sql - +Variable in enum uk.org.ury.library.item.LibraryItemProperty +
  +
sql - +Variable in enum uk.org.ury.show.item.ShowItemProperty +
  +
Status - Enum in uk.org.ury.protocol
Statuses that can follow the STATUS directory.
@@ -142,7 +208,7 @@ Constructor for class uk.org.ury.show.viewer. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-17.html b/doc/index-files/index-17.html index 91dc96d..2e809b2 100644 --- a/doc/index-files/index-17.html +++ b/doc/index-files/index-17.html @@ -2,12 +2,12 @@ - + -U-Index +T-Index - + @@ -15,7 +15,7 @@ U-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="U-Index"; + parent.document.title="T-Index"; } } @@ -78,18 +78,23 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
-

-U

+A B C D E F G H I L M N P Q R S T U V
+

+T

-
UICreationFailureException - Exception in uk.org.ury.frontend.exceptions
Exception thrown when the creation of a UI element fails.
UICreationFailureException() - -Constructor for exception uk.org.ury.frontend.exceptions.UICreationFailureException -
Construct a new UICreationFailureException with a - default reason. -
UICreationFailureException(String) - -Constructor for exception uk.org.ury.frontend.exceptions.UICreationFailureException -
Construct a new UICreationFailureException. -
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.viewer - package uk.org.ury.library.viewer
 
uk.org.ury.show - package uk.org.ury.show
 
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.
+
tearDown() - +Method in class uk.org.ury.client.test.ClientTest +
  +
testGet() - +Method in class uk.org.ury.client.test.ClientTest +
Test method for Client.get(java.lang.String). +
toString() - +Method in class uk.org.ury.show.item.ShowItem +
  +
TrackBin - Class in uk.org.ury.show.viewer
A panel displaying track bin contents.
TrackBin(String) - +Constructor for class uk.org.ury.show.viewer.TrackBin +
Construct a new TrackBin. +
@@ -143,7 +148,7 @@ Constructor for exception uk.org.ury.frontend.exceptions. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-18.html b/doc/index-files/index-18.html index 2d007e7..47e99d5 100644 --- a/doc/index-files/index-18.html +++ b/doc/index-files/index-18.html @@ -2,12 +2,12 @@ - + -V-Index +U-Index - + @@ -15,7 +15,7 @@ V-Index function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="V-Index"; + parent.document.title="U-Index"; } } @@ -56,7 +56,7 @@ function windowTitle()  PREV LETTER  - NEXT LETTER + NEXT LETTER FRAMES    NO FRAMES   @@ -78,32 +78,18 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
-

-V

+A B C D E F G H I L M N P Q R S T U V
+

+U

-
valueOf(String) - -Static method in enum uk.org.ury.database.UserClass -
Returns the enum constant of this type with the specified name. -
valueOf(String) - -Static method in enum uk.org.ury.library.LibraryItemProperty -
Returns the enum constant of this type with the specified name. -
valueOf(String) - -Static method in enum uk.org.ury.show.ShowItemProperty -
Returns the enum constant of this type with the specified name. -
values() - -Static method in enum uk.org.ury.database.UserClass -
Returns an array containing the constants of this enum type, in -the order they are declared. -
values() - -Static method in enum uk.org.ury.library.LibraryItemProperty -
Returns an array containing the constants of this enum type, in -the order they are declared. -
values() - -Static method in enum uk.org.ury.show.ShowItemProperty -
Returns an array containing the constants of this enum type, in -the order they are declared. -
+
UICreationFailureException - Exception in uk.org.ury.frontend.exceptions
Exception thrown when the creation of a UI element fails.
UICreationFailureException() - +Constructor for exception uk.org.ury.frontend.exceptions.UICreationFailureException +
Construct a new UICreationFailureException with a + default reason. +
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.
@@ -135,7 +121,7 @@ the order they are declared.  PREV LETTER  - NEXT LETTER + NEXT LETTER FRAMES    NO FRAMES   @@ -157,7 +143,7 @@ the order they are declared. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-19.html b/doc/index-files/index-19.html new file mode 100644 index 0000000..64fc42e --- /dev/null +++ b/doc/index-files/index-19.html @@ -0,0 +1,177 @@ + + + + + + +V-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N P Q R S T U V
+

+V

+
+
valueOf(String) - +Static method in enum uk.org.ury.database.UserClass +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum uk.org.ury.library.item.LibraryItemProperty +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum uk.org.ury.protocol.Directive +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum uk.org.ury.protocol.Status +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum uk.org.ury.show.item.ShowItemProperty +
Returns the enum constant of this type with the specified name. +
values() - +Static method in enum uk.org.ury.database.UserClass +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum uk.org.ury.library.item.LibraryItemProperty +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum uk.org.ury.protocol.Directive +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum uk.org.ury.protocol.Status +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum uk.org.ury.show.item.ShowItemProperty +
Returns an array containing the constants of this enum type, in +the order they are declared. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N P Q R S T U V
+ + + diff --git a/doc/index-files/index-2.html b/doc/index-files/index-2.html index a4248ea..9e90266 100644 --- a/doc/index-files/index-2.html +++ b/doc/index-files/index-2.html @@ -2,12 +2,12 @@ - + B-Index - + @@ -78,7 +78,7 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V

B

@@ -88,6 +88,17 @@ Method in class uk.org.ury.show.viewer.back() - Method in class uk.org.ury.testrig.DemoControlPanel
Go back to the previous module. +
BadRequestException - Exception in uk.org.ury.server.exceptions
Exception thrown when the server meets a malformed request, or + part of one.
BadRequestException() - +Constructor for exception uk.org.ury.server.exceptions.BadRequestException +
Construct a new BadRequestException with a default reason. +
BadRequestException(Throwable) - +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 +
 
@@ -142,7 +153,7 @@ Method in class uk.org.ury.testrig. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-3.html b/doc/index-files/index-3.html index 5bfa492..87e13f7 100644 --- a/doc/index-files/index-3.html +++ b/doc/index-files/index-3.html @@ -2,12 +2,12 @@ - + C-Index - + @@ -78,13 +78,19 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V

C

-
ChannelPanel - Class in uk.org.ury.show.viewer
A panel displaying channel informstion.
ChannelPanel(int, ShowChannel) - +
ChannelPanel - Class in uk.org.ury.show.viewer
A panel displaying channel information.
ChannelPanel(int, ShowChannel) - Constructor for class uk.org.ury.show.viewer.ChannelPanel
Construct a new ChannelPanel. +
Client - Class in uk.org.ury.client
 
Client() - +Constructor for class uk.org.ury.client.Client +
  +
ClientTest - Class in uk.org.ury.client.test
JUnit test for the low-level client logic.
ClientTest() - +Constructor for class uk.org.ury.client.test.ClientTest +
 
configName - Variable in enum uk.org.ury.database.UserClass
The name of the tag in the configuration file that contains @@ -154,7 +160,7 @@ Constructor for exception uk.org.ury.database.exceptions. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-4.html b/doc/index-files/index-4.html index 392ef08..0b2e075 100644 --- a/doc/index-files/index-4.html +++ b/doc/index-files/index-4.html @@ -2,12 +2,12 @@ - + D-Index - + @@ -78,7 +78,7 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V

D

@@ -95,6 +95,15 @@ Constructor for class uk.org.ury.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) - +Static method in class uk.org.ury.protocol.ProtocolUtils +
Decode a protocol string into a key-value map. +
DecodeFailureException - Exception in uk.org.ury.protocol.exceptions
Exception thrown when the protocol decoder fails.
DecodeFailureException(String) - +Constructor for exception uk.org.ury.protocol.exceptions.DecodeFailureException +
Construct a new DecodeFailureException with a reason. +
DEFAULT_MODULE_NAME - +Static variable in interface uk.org.ury.testrig.Launcher +
 
DemoControlPanel - Class in uk.org.ury.testrig
Control panel for the demo system.
DemoControlPanel() - Constructor for class uk.org.ury.testrig.DemoControlPanel
Constructs a new DemoControlPanel. @@ -104,6 +113,9 @@ 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 +
 
doSearch(String) - Method in class uk.org.ury.library.viewer.LibraryViewer
Do a library search. @@ -161,7 +173,7 @@ Method in class uk.org.ury.library.viewer. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-5.html b/doc/index-files/index-5.html index 17a9150..563446c 100644 --- a/doc/index-files/index-5.html +++ b/doc/index-files/index-5.html @@ -2,12 +2,12 @@ - + E-Index - + @@ -78,7 +78,7 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V

E

@@ -90,6 +90,9 @@ Constructor for exception uk.org.ury.library.exceptions.EmptySearchException(String) - Constructor for exception uk.org.ury.library.exceptions.EmptySearchException
Construct a new EmptySearchException. +
encode(Map<String, Object>) - +Static method in class uk.org.ury.protocol.ProtocolUtils +
Encode a key-value map into a protocol string.
executeQuery(String, int) - Method in class uk.org.ury.database.DatabaseDriver
Execute an unprepared SQL statement with no arguments. @@ -150,7 +153,7 @@ Method in class uk.org.ury.database. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-6.html b/doc/index-files/index-6.html index d73164c..ae3effa 100644 --- a/doc/index-files/index-6.html +++ b/doc/index-files/index-6.html @@ -2,12 +2,12 @@ - + F-Index - + @@ -78,12 +78,12 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V

F

-
fatalError(String) - -Method in class uk.org.ury.frontend.FrontendAppletPanel +
fatalError(String) - +Method in class uk.org.ury.frontend.FrontendApplet
Report a fatal error,
fatalError(String) - Method in class uk.org.ury.frontend.FrontendFrame @@ -91,9 +91,9 @@ Method in class uk.org.ury.frontend.fatalError(String) - Method in interface uk.org.ury.frontend.FrontendMaster
Report a fatal error, -
FrontendAppletPanel - Class in uk.org.ury.frontend
A frame that hosts a FrontendModulePanel, used for serving frontend - panels in a window (application mode).
FrontendAppletPanel(FrontendModulePanel) - -Constructor for class uk.org.ury.frontend.FrontendAppletPanel +
FrontendApplet - Class in uk.org.ury.frontend
A frame that hosts a FrontendModulePanel, used for serving frontend panels in + a window (application mode).
FrontendApplet() - +Constructor for class uk.org.ury.frontend.FrontendApplet
 
FrontendBanner - Class in uk.org.ury.frontend
A banner, displaying a title, intended for use at the top of the frontend frame.
FrontendBanner(String) - @@ -107,9 +107,9 @@ Constructor for class uk.org.ury.frontend.FrontendError
 
FrontendFrame - Class in uk.org.ury.frontend
A frame that hosts a FrontendModulePanel, used for serving frontend - panels in a window (application mode).
FrontendFrame(FrontendModulePanel) - + panels in a window (application mode).
FrontendFrame(String) - Constructor for class uk.org.ury.frontend.FrontendFrame -
  +
Construct a new FrontendFrame given an initial frontend module.
FrontendMaster - Interface in uk.org.ury.frontend
Interface for classes providing the parent unit of a frontend session.
FrontendModule - Interface in uk.org.ury.frontend
Interface for all system modules that are to be reachable from the frontend array.
FrontendModulePanel - Class in uk.org.ury.frontend
A frontend user interface panel.
FrontendModulePanel(FrontendModule, FrontendMaster) - @@ -183,7 +183,7 @@ Constructor for class uk.org.ury.frontend. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-7.html b/doc/index-files/index-7.html index f6447e1..6fac977 100644 --- a/doc/index-files/index-7.html +++ b/doc/index-files/index-7.html @@ -2,12 +2,12 @@ - + G-Index - + @@ -78,16 +78,22 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V

G

+
get(String) - +Method in class uk.org.ury.client.Client +
Get a raw response from the server.
get(E) - Method in class uk.org.ury.database.DatabaseItem
Query this item for a property.
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 +
 
getBins() - Method in class uk.org.ury.show.viewer.ShowViewer
  @@ -98,24 +104,30 @@ Static method in class uk.org.ury.show.getChannels() - Method in class uk.org.ury.show.viewer.ShowViewer
  -
getColumnClass(int) - -Method in class uk.org.ury.library.LibraryTableModel +
getColumnClass(int) - +Method in class uk.org.ury.library.viewer.LibraryTableModel
  -
getColumnCount() - -Method in class uk.org.ury.library.LibraryTableModel +
getColumnCount() - +Method in class uk.org.ury.library.viewer.LibraryTableModel
  -
getColumnName(int) - -Method in class uk.org.ury.library.LibraryTableModel +
getColumnName(int) - +Method in class uk.org.ury.library.viewer.LibraryTableModel
 
getDatabase() - Method in class uk.org.ury.config.ConfigReader
Get the database configuration +
getDatabaseConnection(UserClass) - +Method in class uk.org.ury.server.Server +
Get a database connection using the given user class.
getDb() - Method in class uk.org.ury.config.Database
Get the name of the database
getElementAt(int) - Method in class uk.org.ury.show.ShowChannel
List model retrieval wrapper for get. +
getFromSQL(String) - +Static method in enum uk.org.ury.library.item.LibraryItemProperty +
Retrieve a LibraryItemProperty given its SQL identifier.
getHost() - Method in class uk.org.ury.config.Database
Get the hostname of the database server @@ -125,16 +137,16 @@ Method in class uk.org.ury.library.viewer.getModule() - Method in class uk.org.ury.frontend.FrontendModulePanel
Retrieve the module that this panel is serving as a view into. -
getName() - +
getModuleName() - Method in class uk.org.ury.frontend.FrontendModulePanel
  -
getName() - +
getModuleName() - Method in class uk.org.ury.library.viewer.LibraryViewerPanel
  -
getName() - +
getModuleName() - Method in class uk.org.ury.show.viewer.ShowViewerPanel
  -
getName() - +
getModuleName() - Method in class uk.org.ury.testrig.DemoMenuPanel
 
getPass() - @@ -146,11 +158,20 @@ Method in class uk.org.ury.config.getPublicFolders(DatabaseDriver) - Static method in class uk.org.ury.show.ShowUtils
Return the names of the public track folders, or "bins". +
getResourceDirectory() - +Method in class uk.org.ury.frontend.FrontendApplet +
  +
getResourceDirectory() - +Method in class uk.org.ury.frontend.FrontendFrame +
  +
getResourceDirectory() - +Method in interface uk.org.ury.frontend.FrontendMaster +
 
getRoAuth() - Method in class uk.org.ury.config.ConfigReader
Get the read only login auth configuration -
getRowCount() - -Method in class uk.org.ury.library.LibraryTableModel +
getRowCount() - +Method in class uk.org.ury.library.viewer.LibraryTableModel
 
getRwAuth() - Method in class uk.org.ury.config.ConfigReader @@ -161,8 +182,11 @@ Method in class uk.org.ury.show.getUser() - Method in class uk.org.ury.config.Auth
Get the username of the login -
getValueAt(int, int) - -Method in class uk.org.ury.library.LibraryTableModel +
getValueAt(int, int) - +Method in class uk.org.ury.library.viewer.LibraryTableModel +
  +
getVersion() - +Method in class uk.org.ury.server.Server
 
@@ -218,7 +242,7 @@ Method in class uk.org.ury.library. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-8.html b/doc/index-files/index-8.html index 285f452..86db5a8 100644 --- a/doc/index-files/index-8.html +++ b/doc/index-files/index-8.html @@ -2,12 +2,12 @@ - + H-Index - + @@ -78,10 +78,58 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V

H

+
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 +
Construct a new HandleFailureException with a + default reason. +
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) - +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 server GET request (that is, a request for data + output). +
handleGetRequest(Map<String, String>, Server) - +Method in class uk.org.ury.server.ServerRequestHandler +
Handle a server GET request (that is, a request for data + output). +
HandlerNotFoundException - Exception in uk.org.ury.server.exceptions
Exception thrown when the server request handler requested + by the client is not * found in the class space.
HandlerNotFoundException() - +Constructor for exception uk.org.ury.server.exceptions.HandlerNotFoundException +
Construct a new HandlerNotFoundException with a + default reason. +
HandlerNotFoundException(String, Throwable) - +Constructor for exception uk.org.ury.server.exceptions.HandlerNotFoundException +
Construct a new HandlerNotFoundException with a class name and + chained exception. +
HandlerSetupFailureException - Exception in uk.org.ury.server.exceptions
Exception thrown when the server request handler requested + by the client cannot be set up to process the request.
HandlerSetupFailureException() - +Constructor for exception uk.org.ury.server.exceptions.HandlerSetupFailureException +
Construct a new HandlerNotFoundException with a + default reason. +
HandlerSetupFailureException(String, Throwable) - +Constructor for exception uk.org.ury.server.exceptions.HandlerSetupFailureException +
Construct a new HandlerSetupFailureException with a class name + and chained exception. +
HandlingException - Exception in uk.org.ury.server.exceptions
Generic exception thrown when the server cannot handle a request.
HandlingException(String) - +Constructor for exception uk.org.ury.server.exceptions.HandlingException +
Construct a HandlingException with a reason. +
HandlingException(String, Throwable) - +Constructor for exception uk.org.ury.server.exceptions.HandlingException +
Construct a HandlingException with a reason and a cause to + chain.
has(E) - Method in class uk.org.ury.database.DatabaseItem
Check whether a property has been set in the item. @@ -146,7 +194,7 @@ Constructor for class uk.org.ury.frontend. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index-files/index-9.html b/doc/index-files/index-9.html index 3b1e941..1abc931 100644 --- a/doc/index-files/index-9.html +++ b/doc/index-files/index-9.html @@ -2,12 +2,12 @@ - + I-Index - + @@ -78,22 +78,17 @@ function windowTitle() -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V

I

-
init() - -Method in class uk.org.ury.frontend.AbstractFrontendModule -
Initialise the module as an applet. -
init() - -Method in class uk.org.ury.library.viewer.LibraryViewer -
Initialise the library viewer frontend as an applet. -
init() - -Method in class uk.org.ury.show.viewer.ShowViewer -
Initialise the library viewer frontend as an applet. -
init() - -Method in class uk.org.ury.testrig.DemoMenu -
Initialise the menu as an applet. +
init() - +Method in class uk.org.ury.frontend.FrontendApplet +
Main method. +
InvalidMessageException - Exception in uk.org.ury.protocol.exceptions
Generic exception thrown when a protocol function cannot process a + message due to an issue with the message.
InvalidMessageException(String) - +Constructor for exception uk.org.ury.protocol.exceptions.InvalidMessageException +
Construct a new InvalidMessageException with a reason.
@@ -148,7 +143,7 @@ Method in class uk.org.ury.testrig. -A B C D E F G H I L M N Q R S T U V
+A B C D E F G H I L M N P Q R S T U V
diff --git a/doc/index.html b/doc/index.html index 158e2d8..4e70ba9 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled) diff --git a/doc/overview-frame.html b/doc/overview-frame.html index 785bbe5..f7d4b10 100644 --- a/doc/overview-frame.html +++ b/doc/overview-frame.html @@ -2,12 +2,12 @@ - + Overview List - + @@ -30,6 +30,10 @@ Overview List Packages
+uk.org.ury.client +
+uk.org.ury.client.test +
uk.org.ury.config
uk.org.ury.database @@ -44,10 +48,22 @@ Packages
uk.org.ury.library.exceptions
+uk.org.ury.library.item +
uk.org.ury.library.viewer
+uk.org.ury.protocol +
+uk.org.ury.protocol.exceptions +
+uk.org.ury.server +
+uk.org.ury.server.exceptions +
uk.org.ury.show
+uk.org.ury.show.item +
uk.org.ury.show.viewer
uk.org.ury.testrig diff --git a/doc/overview-summary.html b/doc/overview-summary.html index a6deb18..a671d89 100644 --- a/doc/overview-summary.html +++ b/doc/overview-summary.html @@ -2,12 +2,12 @@ - + Overview - + @@ -86,6 +86,14 @@ function windowTitle() Packages +uk.org.ury.client +  + + +uk.org.ury.client.test +  + + uk.org.ury.config   @@ -114,14 +122,38 @@ function windowTitle()   +uk.org.ury.library.item +  + + uk.org.ury.library.viewer   +uk.org.ury.protocol +  + + +uk.org.ury.protocol.exceptions +  + + +uk.org.ury.server +  + + +uk.org.ury.server.exceptions +  + + uk.org.ury.show   +uk.org.ury.show.item +  + + uk.org.ury.show.viewer   diff --git a/doc/overview-tree.html b/doc/overview-tree.html index e85da6d..adf3094 100644 --- a/doc/overview-tree.html +++ b/doc/overview-tree.html @@ -2,12 +2,12 @@ - + Class Hierarchy - + @@ -84,20 +84,24 @@ function windowTitle() Hierarchy For All Packages
-
Package Hierarchies:
uk.org.ury.config, uk.org.ury.database, uk.org.ury.database.exceptions, uk.org.ury.frontend, uk.org.ury.frontend.exceptions, uk.org.ury.library, uk.org.ury.library.exceptions, uk.org.ury.library.viewer, uk.org.ury.show, uk.org.ury.show.viewer, uk.org.ury.testrig
+
Package Hierarchies:
uk.org.ury.client, uk.org.ury.client.test, uk.org.ury.config, uk.org.ury.database, uk.org.ury.database.exceptions, uk.org.ury.frontend, uk.org.ury.frontend.exceptions, uk.org.ury.library, uk.org.ury.library.exceptions, uk.org.ury.library.item, uk.org.ury.library.viewer, uk.org.ury.protocol, uk.org.ury.protocol.exceptions, uk.org.ury.server, uk.org.ury.server.exceptions, uk.org.ury.show, uk.org.ury.show.item, uk.org.ury.show.viewer, uk.org.ury.testrig

Class Hierarchy

+
  • uk.org.ury.frontend.FrontendError
  • uk.org.ury.library.LibraryRequestHandler (implements uk.org.ury.server.RequestHandler) +
  • uk.org.ury.library.LibraryUtils
  • uk.org.ury.protocol.ProtocolUtils
  • uk.org.ury.server.Server
  • uk.org.ury.server.ServerProtocol
  • uk.org.ury.server.ServerRequestHandler (implements uk.org.ury.server.RequestHandler) +
  • uk.org.ury.show.ShowUtils
  • java.lang.Throwable (implements java.io.Serializable) @@ -157,7 +162,7 @@ Class Hierarchy Interface Hierarchy +
  • uk.org.ury.frontend.FrontendMaster
  • uk.org.ury.frontend.FrontendModule
  • uk.org.ury.testrig.Launcher
  • uk.org.ury.server.RequestHandler

    Enum Hierarchy

    @@ -165,7 +170,7 @@ Enum Hierarchy
  • java.lang.Object
    diff --git a/doc/package-list b/doc/package-list index 651f7ca..1d2873c 100644 --- a/doc/package-list +++ b/doc/package-list @@ -1,3 +1,5 @@ +uk.org.ury.client +uk.org.ury.client.test uk.org.ury.config uk.org.ury.database uk.org.ury.database.exceptions @@ -5,7 +7,13 @@ uk.org.ury.frontend uk.org.ury.frontend.exceptions uk.org.ury.library uk.org.ury.library.exceptions +uk.org.ury.library.item uk.org.ury.library.viewer +uk.org.ury.protocol +uk.org.ury.protocol.exceptions +uk.org.ury.server +uk.org.ury.server.exceptions uk.org.ury.show +uk.org.ury.show.item uk.org.ury.show.viewer uk.org.ury.testrig diff --git a/doc/serialized-form.html b/doc/serialized-form.html index b98d4ce..119b4c6 100644 --- a/doc/serialized-form.html +++ b/doc/serialized-form.html @@ -2,12 +2,12 @@ - + Serialized Form - + @@ -157,25 +157,11 @@ Serialized Form

    - + - -
    -Class uk.org.ury.frontend.AbstractFrontendModule extends javax.swing.JApplet implements Serializable
    - -

    -serialVersionUID: 5309585577127763538L - -

    - -

    - - - - +Class uk.org.ury.frontend.FrontendApplet extends javax.swing.JApplet implements Serializable
    -Class uk.org.ury.frontend.FrontendAppletPanel extends javax.swing.JFrame implements Serializable
    @@ -191,15 +177,6 @@ Serialized Form -

    -banner

    -
    -FrontendBanner banner
    -
    -
    -
    -
    -

    child

    @@ -441,11 +418,11 @@ master
 
 
 
    
-
+
 
+Class uk.org.ury.frontend.exceptions.LoadFailureException extends java.lang.Exception implements Serializable
    
 
    
 
-Class uk.org.ury.frontend.exceptions.UICreationFailureException extends java.lang.Exception implements Serializable
 
    
 
    
 
@@ -453,44 +430,20 @@ master
 serialVersionUID: -7353531873142099828L
 
 
    
-
    
-
-
-
-
-
-
    
-Package uk.org.ury.library
    
 
 
    
-
+
 
+Class uk.org.ury.frontend.exceptions.UICreationFailureException extends java.lang.Exception implements Serializable
    
 
    
 
-Class uk.org.ury.library.LibraryTableModel extends javax.swing.table.AbstractTableModel implements Serializable
 
    
 
    
 
 
    
-serialVersionUID: -1744980619128903509L
+serialVersionUID: -7353531873142099828L
 
 
    
-
-
-
-
-
-
    
-Serialized Fields
    
-
-
    
-data
    
-
    -java.util.List<E> data
    
-
    
-
    
-
    
-
    
 
    
 
 
@@ -523,16 +476,16 @@ java.util.List<E> data
    
 
    
 
 
    
-
+
 
+Class uk.org.ury.library.viewer.LibraryTableModel extends javax.swing.table.AbstractTableModel implements Serializable
    
 
    
 
-Class uk.org.ury.library.viewer.LibraryViewer extends AbstractFrontendModule implements Serializable
 
    
 
    
 
 
    
-serialVersionUID: -2782366476480563739L
+serialVersionUID: -1744980619128903509L
 
 
    
 
@@ -544,36 +497,9 @@ java.util.List<E> data

    -dd

    -
    -DatabaseDriver dd
    -
    -
    -
    -
    -
    -

    -libraryList

    -
    -java.util.List<E> libraryList
    -
    -
    -
    -
    -
    -

    -panel

    -
    -LibraryViewerPanel panel
    -
    -
    -
    -
    -
    -

    -config

    +data 
    -ConfigReader config
    +java.util.List<E> data
    @@ -646,6 +572,15 @@ javax.swing.JPanel searchingPanel

    +searchingLabel

    +
    +javax.swing.JLabel searchingLabel
    +
    +
    +
    +
    +
    +

    searchField

     javax.swing.JTextField searchField
    @@ -664,6 +599,24 @@ javax.swing.JButton searchButton

    • +searchForLabel

    +
    +javax.swing.JLabel searchForLabel
    +
    +
    +
    +
    +
    +

    +hint

    +
    +HintField hint
    +
    +
    +
    +
    +
    +

    searchFailureMessage

     java.lang.String searchFailureMessage
    @@ -671,6 +624,143 @@ java.lang.String searchFailureMessage
    +
    +

    +rb

    +
    +java.util.ResourceBundle rb
    +
    +
    +
    +
    +
    + + + + + +
    +Package uk.org.ury.protocol.exceptions
    + +

    + + + + + +
    +Class uk.org.ury.protocol.exceptions.DecodeFailureException extends java.lang.Exception implements Serializable
    + +

    +serialVersionUID: -3972492943653273528L + +

    + +

    + + + + + +
    +Class uk.org.ury.protocol.exceptions.InvalidMessageException extends java.lang.Exception implements Serializable
    + +

    +serialVersionUID: -3972492943653273528L + +

    +

    + + + + + +
    +Package uk.org.ury.server.exceptions
    + +

    + + + + + +
    +Class uk.org.ury.server.exceptions.BadRequestException extends HandlingException implements Serializable
    + +

    +serialVersionUID: 1825771401085225357L + +

    + +

    + + + + + +
    +Class uk.org.ury.server.exceptions.HandleFailureException extends HandlingException implements Serializable
    + +

    +serialVersionUID: -397479334359858162L + +

    + +

    + + + + + +
    +Class uk.org.ury.server.exceptions.HandlerNotFoundException extends HandlingException implements Serializable
    + +

    +serialVersionUID: -397479334359858162L + +

    + +

    + + + + + +
    +Class uk.org.ury.server.exceptions.HandlerSetupFailureException extends HandlingException implements Serializable
    + +

    +serialVersionUID: -397479334359858162L + +

    + +

    + + + + + +
    +Class uk.org.ury.server.exceptions.HandlingException extends java.lang.Exception implements Serializable
    + +

    +serialVersionUID: -397479334359858162L + +

    + +

    + + + + + +
    +Class uk.org.ury.server.exceptions.NotAHandlerException extends HandlingException implements Serializable
    + +

    +serialVersionUID: -7268289187311868036L + +

    @@ -723,7 +813,7 @@ java.util.List<E> items
    +Class uk.org.ury.show.viewer.ChannelPanel extends FrontendPanel implements Serializable
    -Class uk.org.ury.show.viewer.ChannelPanel extends javax.swing.JPanel implements Serializable
    @@ -798,63 +888,6 @@ javax.swing.JButton stopButton

    -

    - - - - - -
    -Class uk.org.ury.show.viewer.ShowViewer extends AbstractFrontendModule implements Serializable
    - -

    -serialVersionUID: -2782366476480563739L - -

    - - - - - -
    -Serialized Fields
    - -

    -dd

    -
    -DatabaseDriver dd
    -
    -
    -
    -
    -
    -

    -channels

    -
    -ShowChannel[] channels
    -
    -
    -
    -
    -
    -

    -panel

    -
    -ShowViewerPanel panel
    -
    -
    -
    -
    -
    -

    -config

    -
    -ConfigReader config
    -
    -
    -
    -
    -

    @@ -899,7 +932,7 @@ javax.swing.JPanel binGroupPanel
    +Class uk.org.ury.show.viewer.TrackBin extends FrontendPanel implements Serializable
    -Class uk.org.ury.show.viewer.TrackBin extends javax.swing.JPanel implements Serializable
    @@ -946,36 +979,6 @@ javax.swing.JLabel binName

    -

    - - - - - -
    -Class uk.org.ury.testrig.DemoMenu extends javax.swing.JApplet implements Serializable
    - -

    -serialVersionUID: -5264235507636809476L - -

    - - - - - -
    -Serialized Fields
    - -

    -master

    -
    -FrontendMaster master
    -
    -
    -
    -
    -

    diff --git a/doc/uk/org/ury/client/Client.html b/doc/uk/org/ury/client/Client.html new file mode 100644 index 0000000..bcebbd1 --- /dev/null +++ b/doc/uk/org/ury/client/Client.html @@ -0,0 +1,259 @@ + + + + + + +Client + + + + + + + + + + + + +
    + + + + + +
    + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.client +
    +Class Client

    +
    +java.lang.Object
+  extended by uk.org.ury.client.Client
+
    +
    +
    +
    public class Client
    extends java.lang.Object
    + + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Client() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.util.Map<?,?>get(java.lang.String file) + +
    +          Get a raw response from the server.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +Client

    +
    +public Client()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +get

    +
    +public java.util.Map<?,?> get(java.lang.String file)
+                       throws DecodeFailureException
    +
    +
    Get a raw response from the server. +

    +

    +
    Parameters:
    file - The "file", including path and query string, to + fetch from the server. +
    Returns:
    The response from the server, as a key-value map. +
    Throws: +
    DecodeFailureException - if the decode failed.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/client/class-use/Client.html b/doc/uk/org/ury/client/class-use/Client.html new file mode 100644 index 0000000..8c4a5ad --- /dev/null +++ b/doc/uk/org/ury/client/class-use/Client.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.client.Client + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.client.Client

    +
    +No usage of uk.org.ury.client.Client +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/client/package-frame.html b/doc/uk/org/ury/client/package-frame.html new file mode 100644 index 0000000..9705c67 --- /dev/null +++ b/doc/uk/org/ury/client/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +uk.org.ury.client + + + + + + + + + + + +uk.org.ury.client + + + + +
    +Classes  + +
    +Client
    + + + + diff --git a/doc/uk/org/ury/client/package-summary.html b/doc/uk/org/ury/client/package-summary.html new file mode 100644 index 0000000..e4e7b74 --- /dev/null +++ b/doc/uk/org/ury/client/package-summary.html @@ -0,0 +1,157 @@ + + + + + + +uk.org.ury.client + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.client +

    + + + + + + + + + +
    +Class Summary
    Client 
    +  + +

    +

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

    +Hierarchy For Package uk.org.ury.client +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    +
      +
    • java.lang.Object +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/client/package-use.html b/doc/uk/org/ury/client/package-use.html new file mode 100644 index 0000000..c30a691 --- /dev/null +++ b/doc/uk/org/ury/client/package-use.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Package uk.org.ury.client + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    uk.org.ury.client

    +
    +No usage of uk.org.ury.client +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/client/test/ClientTest.html b/doc/uk/org/ury/client/test/ClientTest.html new file mode 100644 index 0000000..b0c3c74 --- /dev/null +++ b/doc/uk/org/ury/client/test/ClientTest.html @@ -0,0 +1,306 @@ + + + + + + +ClientTest + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.client.test +
    +Class ClientTest

    +
    +java.lang.Object
+  extended by uk.org.ury.client.test.ClientTest
+
    +
    +
    +
    public class ClientTest
    extends java.lang.Object
    + + +

    +JUnit test for the low-level client logic. +

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ClientTest() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidsetUp() + +
    +           
    + voidtearDown() + +
    +           
    + voidtestGet() + +
    +          Test method for Client.get(java.lang.String).
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +ClientTest

    +
    +public ClientTest()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setUp

    +
    +public void setUp()
+           throws java.lang.Exception
    +
    +
    + +
    Throws: +
    java.lang.Exception
    +
    +
    +
    + +

    +tearDown

    +
    +public void tearDown()
+              throws java.lang.Exception
    +
    +
    + +
    Throws: +
    java.lang.Exception
    +
    +
    +
    + +

    +testGet

    +
    +public void testGet()
    +
    +
    Test method for Client.get(java.lang.String). +

    +

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/client/test/class-use/ClientTest.html b/doc/uk/org/ury/client/test/class-use/ClientTest.html new file mode 100644 index 0000000..67b587f --- /dev/null +++ b/doc/uk/org/ury/client/test/class-use/ClientTest.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.client.test.ClientTest + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.client.test.ClientTest

    +
    +No usage of uk.org.ury.client.test.ClientTest +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/client/test/package-frame.html b/doc/uk/org/ury/client/test/package-frame.html new file mode 100644 index 0000000..4e0ac01 --- /dev/null +++ b/doc/uk/org/ury/client/test/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +uk.org.ury.client.test + + + + + + + + + + + +uk.org.ury.client.test + + + + +
    +Classes  + +
    +ClientTest
    + + + + diff --git a/doc/uk/org/ury/client/test/package-summary.html b/doc/uk/org/ury/client/test/package-summary.html new file mode 100644 index 0000000..aae901a --- /dev/null +++ b/doc/uk/org/ury/client/test/package-summary.html @@ -0,0 +1,157 @@ + + + + + + +uk.org.ury.client.test + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.client.test +

    + + + + + + + + + +
    +Class Summary
    ClientTestJUnit test for the low-level client logic.
    +  + +

    +

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

    +Hierarchy For Package uk.org.ury.client.test +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    +
      +
    • java.lang.Object +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/client/test/package-use.html b/doc/uk/org/ury/client/test/package-use.html new file mode 100644 index 0000000..299afcd --- /dev/null +++ b/doc/uk/org/ury/client/test/package-use.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Package uk.org.ury.client.test + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    uk.org.ury.client.test

    +
    +No usage of uk.org.ury.client.test +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/config/Auth.html b/doc/uk/org/ury/config/Auth.html index 7413bf2..733df47 100644 --- a/doc/uk/org/ury/config/Auth.html +++ b/doc/uk/org/ury/config/Auth.html @@ -2,12 +2,12 @@ - + Auth - + diff --git a/doc/uk/org/ury/config/ConfigReader.html b/doc/uk/org/ury/config/ConfigReader.html index 6c49f23..4f7e8b5 100644 --- a/doc/uk/org/ury/config/ConfigReader.html +++ b/doc/uk/org/ury/config/ConfigReader.html @@ -2,12 +2,12 @@ - + ConfigReader - + diff --git a/doc/uk/org/ury/config/Database.html b/doc/uk/org/ury/config/Database.html index 521acf8..c763c87 100644 --- a/doc/uk/org/ury/config/Database.html +++ b/doc/uk/org/ury/config/Database.html @@ -2,12 +2,12 @@ - + Database - + diff --git a/doc/uk/org/ury/config/class-use/Auth.html b/doc/uk/org/ury/config/class-use/Auth.html index ec1cf32..f787985 100644 --- a/doc/uk/org/ury/config/class-use/Auth.html +++ b/doc/uk/org/ury/config/class-use/Auth.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.config.Auth - + diff --git a/doc/uk/org/ury/config/class-use/ConfigReader.html b/doc/uk/org/ury/config/class-use/ConfigReader.html index 63faa8c..65de08e 100644 --- a/doc/uk/org/ury/config/class-use/ConfigReader.html +++ b/doc/uk/org/ury/config/class-use/ConfigReader.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.config.ConfigReader - + diff --git a/doc/uk/org/ury/config/class-use/Database.html b/doc/uk/org/ury/config/class-use/Database.html index 13217d4..bd90ceb 100644 --- a/doc/uk/org/ury/config/class-use/Database.html +++ b/doc/uk/org/ury/config/class-use/Database.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.config.Database - + diff --git a/doc/uk/org/ury/config/package-frame.html b/doc/uk/org/ury/config/package-frame.html index d6cd433..2f81a57 100644 --- a/doc/uk/org/ury/config/package-frame.html +++ b/doc/uk/org/ury/config/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.config - + diff --git a/doc/uk/org/ury/config/package-summary.html b/doc/uk/org/ury/config/package-summary.html index 5b97c6b..d70da45 100644 --- a/doc/uk/org/ury/config/package-summary.html +++ b/doc/uk/org/ury/config/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.config - + @@ -55,7 +55,7 @@ function windowTitle() - PREV PACKAGE  + PREV PACKAGE   NEXT PACKAGE FRAMES   @@ -136,7 +136,7 @@ Package uk.org.ury.config - PREV PACKAGE  + PREV PACKAGE   NEXT PACKAGE FRAMES   diff --git a/doc/uk/org/ury/config/package-tree.html b/doc/uk/org/ury/config/package-tree.html index f0ef1aa..a0b9c8b 100644 --- a/doc/uk/org/ury/config/package-tree.html +++ b/doc/uk/org/ury/config/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.config Class Hierarchy - + @@ -55,7 +55,7 @@ function windowTitle() - PREV  + PREV   NEXT FRAMES   @@ -124,7 +124,7 @@ Class Hierarchy - PREV  + PREV   NEXT FRAMES   diff --git a/doc/uk/org/ury/config/package-use.html b/doc/uk/org/ury/config/package-use.html index f9511fb..b97766d 100644 --- a/doc/uk/org/ury/config/package-use.html +++ b/doc/uk/org/ury/config/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.config - + diff --git a/doc/uk/org/ury/database/DatabaseDriver.html b/doc/uk/org/ury/database/DatabaseDriver.html index 4527254..7bd5c25 100644 --- a/doc/uk/org/ury/database/DatabaseDriver.html +++ b/doc/uk/org/ury/database/DatabaseDriver.html @@ -2,12 +2,12 @@ - + DatabaseDriver - + diff --git a/doc/uk/org/ury/database/DatabaseItem.html b/doc/uk/org/ury/database/DatabaseItem.html index 7223386..1f2da1b 100644 --- a/doc/uk/org/ury/database/DatabaseItem.html +++ b/doc/uk/org/ury/database/DatabaseItem.html @@ -2,12 +2,12 @@ - + DatabaseItem - + @@ -96,7 +96,7 @@ java.lang.Object extended by uk.org.ury.database.DatabaseItem<E,T>
    -
    Direct Known Subclasses:
    LibraryItem, ShowItem
    +
    Direct Known Subclasses:
    LibraryItem, ShowItem
    @@ -144,6 +144,14 @@ An abstract class presenting a template for objects serving as + java.util.Map<java.lang.String,java.lang.String> +asResponse() + +
    +          Retrieve a map of string representations of the properties. + + +  T get(E property) @@ -233,6 +241,22 @@ public

    +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.
    +
    +
    diff --git a/doc/uk/org/ury/database/UserClass.html b/doc/uk/org/ury/database/UserClass.html index 9a96ac2..d9231d8 100644 --- a/doc/uk/org/ury/database/UserClass.html +++ b/doc/uk/org/ury/database/UserClass.html @@ -2,12 +2,12 @@ - + UserClass - + diff --git a/doc/uk/org/ury/database/class-use/DatabaseDriver.html b/doc/uk/org/ury/database/class-use/DatabaseDriver.html index 64cc45f..ac09e36 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 - + @@ -94,6 +94,10 @@ Packages that use +uk.org.ury.server +   + + uk.org.ury.show    @@ -116,7 +120,7 @@ Uses of -static java.util.List<LibraryItem> +static java.util.List<LibraryItem>     LibraryUtils.search(DatabaseDriver db, java.lang.String search) @@ -126,6 +130,31 @@ Uses of + + + + +
    +Uses of DatabaseDriver in uk.org.ury.server
    +  +

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

    @@ -142,7 +171,7 @@ Uses of +static java.util.List<ShowItem> - + - +
    -static java.util.List<ShowItem> ShowUtils.getChannelList(DatabaseDriver db, int showID, int channel) diff --git a/doc/uk/org/ury/database/class-use/DatabaseItem.html b/doc/uk/org/ury/database/class-use/DatabaseItem.html index b038fda..e0d5953 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 - + @@ -90,21 +90,21 @@ function windowTitle() Packages that use DatabaseItem
    uk.org.ury.libraryuk.org.ury.library.item   
    uk.org.ury.showuk.org.ury.show.item   
     

    - + +Uses of DatabaseItem in uk.org.ury.library.item
    -Uses of DatabaseItem in uk.org.ury.library
      @@ -112,12 +112,12 @@ Uses of -Subclasses of DatabaseItem in uk.org.ury.library     +Subclasses of DatabaseItem in uk.org.ury.library.item      class -LibraryItem +LibraryItem
              An item in the URY library. @@ -125,11 +125,11 @@ Uses of + +Uses of DatabaseItem in uk.org.ury.show.item
    -Uses of DatabaseItem in uk.org.ury.show
      @@ -137,12 +137,12 @@ Uses of -Subclasses of DatabaseItem in uk.org.ury.show +Subclasses of DatabaseItem in uk.org.ury.show.item  class -ShowItem +ShowItem
              An item in the show database. diff --git a/doc/uk/org/ury/database/class-use/UserClass.html b/doc/uk/org/ury/database/class-use/UserClass.html index cf5ee95..8859b2c 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 - + @@ -93,6 +93,10 @@ Packages that use uk.org.ury.database    + +uk.org.ury.server +   +  

    @@ -145,6 +149,31 @@ the order they are declared.  

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

    + + + + + + + + + +
    Methods in uk.org.ury.server with parameters of type UserClass
    + DatabaseDriverServer.getDatabaseConnection(UserClass userClass) + +
    +          Get 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 d0cd1f3..66133bf 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 4d22eed..9c54154 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 5cab21d..b31fb44 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 91bd6b3..ecb2a3b 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 f1e49c6..ea4b6e8 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 - + @@ -93,6 +93,10 @@ Packages that use uk.org.ury.database    + +uk.org.ury.server +   +  

    @@ -120,6 +124,31 @@ Uses of + + + + +
    +Uses of ConnectionFailureException in uk.org.ury.server
    +  +

    + + + + + + + + + +
    Methods in uk.org.ury.server that throw ConnectionFailureException
    + DatabaseDriverServer.getDatabaseConnection(UserClass userClass) + +
    +          Get 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 25e5d29..c622c6e 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 - + @@ -97,6 +97,10 @@ Packages that use uk.org.ury.database    + +uk.org.ury.server +   +  

    @@ -147,6 +151,31 @@ Uses of + + + + +
    +Uses of MissingCredentialsException in uk.org.ury.server
    +  +

    + + + + + + + + + +
    Methods in uk.org.ury.server that throw MissingCredentialsException
    + DatabaseDriverServer.getDatabaseConnection(UserClass userClass) + +
    +          Get 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 208c82b..98d49a6 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 - + 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 c65f23b..80e07cc 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 - + @@ -94,10 +94,6 @@ Packages that use -uk.org.ury.library.viewer -   - - uk.org.ury.show    @@ -124,7 +120,7 @@ Uses of -static java.util.List<LibraryItem> +static java.util.List<LibraryItem> LibraryUtils.search(DatabaseDriver db, java.lang.String search) @@ -134,31 +130,6 @@ Uses of - - - - -
    -Uses of QueryFailureException in uk.org.ury.library.viewer
    -  -

    - - - - - - - - - -
    Methods in uk.org.ury.library.viewer that throw QueryFailureException
    - voidLibraryViewer.doSearch(java.lang.String search) - -
    -          Do a library search.
    -  -

    @@ -175,7 +146,7 @@ Uses of +static java.util.List<ShowItem> + @@ -180,18 +180,26 @@ Classes in +
    -static java.util.List<ShowItem> ShowUtils.getChannelList(DatabaseDriver db, int showID, int channel) diff --git a/doc/uk/org/ury/database/exceptions/package-frame.html b/doc/uk/org/ury/database/exceptions/package-frame.html index efb585b..e04436e 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 bc46e69..cf790ff 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 - + diff --git a/doc/uk/org/ury/database/exceptions/package-tree.html b/doc/uk/org/ury/database/exceptions/package-tree.html index 4f22c0e..6db51a7 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 a142814..881f707 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 - + @@ -102,7 +102,7 @@ Packages that use -uk.org.ury.library.vieweruk.org.ury.server   
    +Classes in uk.org.ury.database.exceptions used by uk.org.ury.server - +          Exception thrown when the database backend fails to connect to + the database server, in absence of a more specific exception. + + +
    -Classes in uk.org.ury.database.exceptions used by uk.org.ury.library.viewer
    QueryFailureException +ConnectionFailureException
    -          Exception thrown when the database backend fails to execute - a query.
    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.
      diff --git a/doc/uk/org/ury/database/package-frame.html b/doc/uk/org/ury/database/package-frame.html index 415958a..80be895 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 cf09ad9..1f8e620 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 - + diff --git a/doc/uk/org/ury/database/package-tree.html b/doc/uk/org/ury/database/package-tree.html index e297871..b2ff806 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 4810dcf..9a72514 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 - + @@ -98,9 +98,21 @@ Packages that use    +uk.org.ury.library.item +   + + +uk.org.ury.server +   + + uk.org.ury.show    + +uk.org.ury.show.item +   +  

    @@ -133,8 +145,17 @@ Classes in uk.org using suitably privileged accounts, and handles the processing of SQL queries. + +  +

    + + + + + -
    +Classes in uk.org.ury.database used by uk.org.ury.library.item
    DatabaseItem +DatabaseItem
              An abstract class presenting a template for objects serving as @@ -144,6 +165,29 @@ Classes in uk.org
     

    + + + + + + + + + + + +
    +Classes in uk.org.ury.database used by uk.org.ury.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.
    +  +

    @@ -158,8 +202,17 @@ Classes in uk.org using suitably privileged accounts, and handles the processing of SQL queries. +
    +  +

    + + + + + - + NEXT CLASS + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    +Classes in uk.org.ury.database used by uk.org.ury.show.item
    DatabaseItem +DatabaseItem
              An abstract class presenting a template for objects serving as diff --git a/doc/uk/org/ury/frontend/AbstractFrontendModule.html b/doc/uk/org/ury/frontend/AbstractFrontendModule.html index ed3e866..ecac485 100644 --- a/doc/uk/org/ury/frontend/AbstractFrontendModule.html +++ b/doc/uk/org/ury/frontend/AbstractFrontendModule.html @@ -2,12 +2,12 @@ - + AbstractFrontendModule - + @@ -56,7 +56,7 @@ function windowTitle()
     PREV CLASS  - NEXT CLASS FRAMES    NO FRAMES   @@ -76,9 +76,9 @@ function windowTitle()
    - SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
    @@ -93,22 +93,17 @@ uk.org.ury.frontend Class AbstractFrontendModule 

     java.lang.Object
-  extended by java.awt.Component
-      extended by java.awt.Container
-          extended by java.awt.Panel
-              extended by java.applet.Applet
-                  extended by javax.swing.JApplet
-                      extended by uk.org.ury.frontend.AbstractFrontendModule
+  extended by uk.org.ury.frontend.AbstractFrontendModule
    -
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, FrontendModule
    +
    All Implemented Interfaces:
    FrontendModule
    -
    Direct Known Subclasses:
    LibraryViewer, ShowViewer
    +
    Direct Known Subclasses:
    DemoMenu, LibraryViewer, ShowViewer
    -
    public abstract class AbstractFrontendModule
    extends javax.swing.JApplet
    implements FrontendModule
    +
    public abstract class AbstractFrontendModule
    extends java.lang.Object
    implements FrontendModule

    @@ -119,57 +114,11 @@ An abstract implementation of the FrontendModule interface.

    Author:
    Matt Windsor
    -
    See Also:
    Serialized Form
    +

    - - - - - - - -
    -Nested Class Summary
    -  - - - - - - - -
    Nested classes/interfaces inherited from class java.awt.Component
    java.awt.Component.BaselineResizeBehavior
    -  - - - - - - -
    -Field Summary
    -  - - - - - - - -
    Fields inherited from class java.awt.Component
    BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
    -  - - - - - - - -
    Fields inherited from interface java.awt.image.ImageObserver
    ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
    -  @@ -194,59 +143,6 @@ An abstract implementation of the FrontendModule interface. Method Summary - - -abstract  void -init() - -
    -          Initialise the module as an applet. - - -  - - - - - - - -
    Methods inherited from class javax.swing.JApplet
    getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, remove, repaint, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
    -  - - - - - - - -
    Methods inherited from class java.applet.Applet
    destroy, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus, start, stop
    -  - - - - - - - -
    Methods inherited from class java.awt.Panel
    addNotify
    -  - - - - - - - -
    Methods inherited from class java.awt.Container
    add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate
    -  - - - - - - -
    Methods inherited from class java.awt.Component
    action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
      @@ -254,7 +150,7 @@ An abstract implementation of the FrontendModule interface. - +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, wait, wait, waitequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      @@ -285,31 +181,6 @@ AbstractFrontendModule public AbstractFrontendModule()

    - - - - - - - - -
    -Method Detail
    - -

    -init

    -
    -public abstract void init()
    -
    -
    Initialise the module as an applet. -

    -

    -
    Overrides:
    init in class java.applet.Applet
    -
    -
    -
    -
    -
    @@ -342,7 +213,7 @@ public abstract void init()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -362,9 +233,9 @@ public abstract void init() - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD diff --git a/doc/uk/org/ury/frontend/FrontendApplet.html b/doc/uk/org/ury/frontend/FrontendApplet.html new file mode 100644 index 0000000..3ed1e9a --- /dev/null +++ b/doc/uk/org/ury/frontend/FrontendApplet.html @@ -0,0 +1,543 @@ + + + + + + +FrontendApplet + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.frontend +
    +Class FrontendApplet

    +
    +java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by java.awt.Panel
+              extended by java.applet.Applet
+                  extended by javax.swing.JApplet
+                      extended by uk.org.ury.frontend.FrontendApplet
+
    +
    +
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, FrontendMaster, Launcher
    +
    +
    +
    +
    public class FrontendApplet
    extends javax.swing.JApplet
    implements FrontendMaster, Launcher
    + + +

    +A frame that hosts a FrontendModulePanel, used for serving frontend panels in + a window (application mode). +

    + +

    +

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

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class java.awt.Component
    java.awt.Component.BaselineResizeBehavior
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.awt.Component
    BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
    +  + + + + + + + +
    Fields inherited from interface uk.org.ury.testrig.Launcher
    DEFAULT_MODULE_NAME
    +  + + + + + + + +
    Fields inherited from interface java.awt.image.ImageObserver
    ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
    +  + + + + + + + + + + +
    +Constructor Summary
    FrontendApplet() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidfatalError(java.lang.String message) + +
    +          Report a fatal error,
    + java.lang.StringgetResourceDirectory() + +
    +           
    + voidinit() + +
    +          Main method.
    + voidloadModule(java.lang.String moduleName) + +
    +          Load a module into the frontend frame.
    + voidloadModule(java.lang.String moduleName, + java.lang.String cPanelName) + +
    +          Load a module into the frontend frame, additionally installing a control + panel to communicate with the previous module.
    + voidrestoreModule(FrontendModulePanel mpanel, + FrontendControlPanel cpanel) + +
    +          Restore an existing module and control panel into the frontend frame.
    + voidsetupUI() + +
    +          Set up the user interface of the frame.
    +  + + + + + + + +
    Methods inherited from class javax.swing.JApplet
    getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, remove, repaint, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
    +  + + + + + + + +
    Methods inherited from class java.applet.Applet
    destroy, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus, start, stop
    +  + + + + + + + +
    Methods inherited from class java.awt.Panel
    addNotify
    +  + + + + + + + +
    Methods inherited from class java.awt.Container
    add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate
    +  + + + + + + + +
    Methods inherited from class java.awt.Component
    action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +FrontendApplet

    +
    +public FrontendApplet()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +init

    +
    +public void init()
    +
    +
    Main method. +

    +

    +
    Overrides:
    init in class java.applet.Applet
    +
    +
    +
    +
    +
    +
    + +

    +setupUI

    +
    +public void setupUI()
    +
    +
    Set up the user interface of the frame. +

    +

    +
    Specified by:
    setupUI in interface FrontendMaster
    +
    +
    +
    +
    +
    +
    + +

    +loadModule

    +
    +public void loadModule(java.lang.String moduleName)
+                throws LoadFailureException
    +
    +
    Load a module into the frontend frame. + + Loading will fail with a fatal error if the class is not found, or is not + an implementor of FrontendModule. +

    +

    +
    Specified by:
    loadModule in interface FrontendMaster
    +
    +
    +
    Parameters:
    moduleName - The fully qualified class-name of the module, minus the + leading "uk.org.ury." domain. +
    Throws: +
    LoadFailureException - if the class is not found, or is not an implementor of + FrontendModule.
    +
    +
    +
    + +

    +loadModule

    +
    +public void loadModule(java.lang.String moduleName,
+                       java.lang.String cPanelName)
+                throws LoadFailureException
    +
    +
    Load a module into the frontend frame, additionally installing a control + panel to communicate with the previous module. + + Loading will fail with a fatal error if the class is not found, or is not + an implementor of FrontendModule. +

    +

    +
    Specified by:
    loadModule in interface FrontendMaster
    +
    +
    +
    Parameters:
    moduleName - The fully qualified class-name of the module, minus the + leading "uk.org.ury." domain.
    cPanelName - The fully qualified class-name of the control panel to + install, minus the leading "uk.org.ury." domain. +
    Throws: +
    LoadFailureException - if the class is not found, or is not an implementor of + FrontendModule.
    +
    +
    +
    + +

    +restoreModule

    +
    +public void restoreModule(FrontendModulePanel mpanel,
+                          FrontendControlPanel cpanel)
    +
    +
    Restore an existing module and control panel into the frontend frame. +

    +

    +
    Specified by:
    restoreModule in interface FrontendMaster
    +
    +
    +
    Parameters:
    mpanel - The module panel to restore.
    cpanel - The control panel to restore, if any. A null value signifies a + lack of control panel. +
    Throws: +
    java.lang.IllegalArgumentException - if the mpanel is null.
    +
    +
    +
    + +

    +fatalError

    +
    +public void fatalError(java.lang.String message)
    +
    +
    Report a fatal error, +

    +

    +
    Specified by:
    fatalError in interface FrontendMaster
    +
    +
    +
    Parameters:
    message - The message, eg the exception message, to report to the user.
    +
    +
    +
    + +

    +getResourceDirectory

    +
    +public java.lang.String getResourceDirectory()
    +
    +
    +
    Specified by:
    getResourceDirectory in interface FrontendMaster
    +
    +
    + +
    Returns:
    the resource directory.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/frontend/FrontendBanner.html b/doc/uk/org/ury/frontend/FrontendBanner.html index 07f7a10..77cac68 100644 --- a/doc/uk/org/ury/frontend/FrontendBanner.html +++ b/doc/uk/org/ury/frontend/FrontendBanner.html @@ -2,12 +2,12 @@ - + FrontendBanner - + @@ -55,7 +55,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -340,7 +340,7 @@ public void setTitle(java.lang.String title) - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   diff --git a/doc/uk/org/ury/frontend/FrontendControlPanel.html b/doc/uk/org/ury/frontend/FrontendControlPanel.html index f8bc49b..1b43dca 100644 --- a/doc/uk/org/ury/frontend/FrontendControlPanel.html +++ b/doc/uk/org/ury/frontend/FrontendControlPanel.html @@ -2,12 +2,12 @@ - + FrontendControlPanel - + diff --git a/doc/uk/org/ury/frontend/FrontendError.html b/doc/uk/org/ury/frontend/FrontendError.html index 0ee5c70..1858ac8 100644 --- a/doc/uk/org/ury/frontend/FrontendError.html +++ b/doc/uk/org/ury/frontend/FrontendError.html @@ -2,12 +2,12 @@ - + FrontendError - + @@ -140,8 +140,8 @@ Factory for descriptive error dialogues. static void -reportFatal(java.lang.String message, - FrontendAppletPanel panel) +reportFatal(java.lang.String message, + FrontendApplet panel)
                @@ -210,11 +210,11 @@ public static void reportFatal(java.lang.String message,
    -

    +

    reportFatal

     public static void reportFatal(java.lang.String message,
-                               FrontendAppletPanel panel)
    + FrontendApplet panel)
    diff --git a/doc/uk/org/ury/frontend/FrontendFrame.html b/doc/uk/org/ury/frontend/FrontendFrame.html index 9b82f52..57b1dae 100644 --- a/doc/uk/org/ury/frontend/FrontendFrame.html +++ b/doc/uk/org/ury/frontend/FrontendFrame.html @@ -2,12 +2,12 @@ - + FrontendFrame - + @@ -204,10 +204,10 @@ A frame that hosts a FrontendModulePanel, used for serving frontend Constructor Summary     -FrontendFrame(FrontendModulePanel parent) +FrontendFrame(java.lang.String moduleName)
    -            +          Construct a new FrontendFrame given an initial frontend module.   @@ -229,6 +229,14 @@ A frame that hosts a FrontendModulePanel, used for serving frontend + java.lang.String +getResourceDirectory() + +
    +            + + +  void loadModule(java.lang.String moduleName) @@ -255,6 +263,14 @@ A frame that hosts a FrontendModulePanel, used for serving frontend           Restore an existing module and control panel into the frontend frame. + + + void +setupUI() + +
    +          Set up the user interface of the frame. +   @@ -332,11 +348,19 @@ A frame that hosts a FrontendModulePanel, used for serving frontend
    -

    +

    FrontendFrame

    -public FrontendFrame(FrontendModulePanel parent)
    +public FrontendFrame(java.lang.String moduleName)
    +
    Construct a new FrontendFrame given an initial frontend module. + + Loading will fail with a fatal error if the class is not found, + or is not an implementor of FrontendModule. +

    +

    +
    Parameters:
    moduleName - The fully qualified class-name of the module, + minus the leading "uk.org.ury." domain.
    @@ -349,10 +373,27 @@ public FrontendFrame(

    +setupUI

    +
    +public void setupUI()
    +
    +
    Set up the user interface of the frame. +

    +

    +
    Specified by:
    setupUI in interface FrontendMaster
    +
    +
    +
    +
    +
    +
    +

    loadModule

    -public void loadModule(java.lang.String moduleName)
    +public void loadModule(java.lang.String moduleName) + throws LoadFailureException
    Load a module into the frontend frame. @@ -364,7 +405,11 @@ public void loadModule(java.lang.String moduleName)
    Parameters:
    moduleName - The fully qualified class-name of the module, - minus the leading "uk.org.ury." domain.
    + minus the leading "uk.org.ury." domain. +
    Throws: +
    LoadFailureException - if the class is + not found, or is not an implementor of + FrontendModule.
    @@ -373,7 +418,8 @@ public void loadModule(java.lang.String moduleName) loadModule 
     public void loadModule(java.lang.String moduleName,
-                       java.lang.String cPanelName)
    + java.lang.String cPanelName) + throws LoadFailureException
    Load a module into the frontend frame, additionally installing a control panel to communicate with the previous module. @@ -388,7 +434,11 @@ public void loadModule(java.lang.String moduleName,
    Parameters:
    moduleName - The fully qualified class-name of the module, minus the leading "uk.org.ury." domain.
    cPanelName - The fully qualified class-name of the control panel to install, minus the leading - "uk.org.ury." domain.
    + "uk.org.ury." domain. +
    Throws: +
    LoadFailureException - if the class is + not found, or is not an implementor of + FrontendModule.
    @@ -429,6 +479,21 @@ public void fatalError(java.lang.String message) to the user. +
    + +

    +getResourceDirectory

    +
    +public java.lang.String getResourceDirectory()
    +
    +
    +
    Specified by:
    getResourceDirectory in interface FrontendMaster
    +
    +
    + +
    Returns:
    the resource directory.
    +
    +
    diff --git a/doc/uk/org/ury/frontend/FrontendMaster.html b/doc/uk/org/ury/frontend/FrontendMaster.html index 485ebb1..08e34a5 100644 --- a/doc/uk/org/ury/frontend/FrontendMaster.html +++ b/doc/uk/org/ury/frontend/FrontendMaster.html @@ -2,12 +2,12 @@ - + FrontendMaster - + @@ -92,7 +92,7 @@ uk.org.ury.frontend
    Interface FrontendMaster
    -
    All Known Implementing Classes:
    FrontendAppletPanel, FrontendFrame
    +
    All Known Implementing Classes:
    FrontendApplet, FrontendFrame
    @@ -134,6 +134,14 @@ Interface for classes providing the parent unit of a frontend + java.lang.String +getResourceDirectory() + +
    +            + + +  void loadModule(java.lang.String moduleName) @@ -160,6 +168,14 @@ Interface for classes providing the parent unit of a frontend           Restore an existing module and control panel into the frontend master. + + + void +setupUI() + +
    +          Set up the frontend master's user interface. +  

    @@ -177,7 +193,8 @@ Interface for classes providing the parent unit of a frontend

    loadModule

    -void loadModule(java.lang.String moduleName)
    +void loadModule(java.lang.String moduleName) + throws LoadFailureException
    Load a module into the frontend frame. @@ -186,7 +203,11 @@ void loadModule(java.lang.String moduleName)

    Parameters:
    moduleName - The fully qualified class-name of the module, - minus the leading "uk.org.ury." domain.
    + minus the leading "uk.org.ury." domain. +
    Throws: +
    LoadFailureException - if the class is + not found, or is not an implementor of + FrontendModule.
    @@ -195,7 +216,8 @@ void loadModule(java.lang.String moduleName) loadModule 
     void loadModule(java.lang.String moduleName,
-                java.lang.String cPanelName)
    + java.lang.String cPanelName) + throws LoadFailureException
    Load a module into the frontend frame, additionally installing a control panel to communicate with the previous module. @@ -207,7 +229,11 @@ void loadModule(java.lang.String moduleName,
    Parameters:
    moduleName - The fully qualified class-name of the module, minus the leading "uk.org.ury." domain.
    cPanelName - The fully qualified class-name of the control panel to install, minus the leading - "uk.org.ury." domain.
    + "uk.org.ury." domain. +
    Throws: +
    LoadFailureException - if the class is + not found, or is not an implementor of + FrontendModule.
    @@ -241,6 +267,31 @@ void fatalError(java.lang.String message) to the user. +
    + +

    +setupUI

    +
    +void setupUI()
    +
    +
    Set up the frontend master's user interface. +

    +

    +
    +
    +
    +
    + +

    +getResourceDirectory

    +
    +java.lang.String getResourceDirectory()
    +
    +
    + +
    Returns:
    the resource directory.
    +
    +
    diff --git a/doc/uk/org/ury/frontend/FrontendModule.html b/doc/uk/org/ury/frontend/FrontendModule.html index 765faeb..4f728da 100644 --- a/doc/uk/org/ury/frontend/FrontendModule.html +++ b/doc/uk/org/ury/frontend/FrontendModule.html @@ -2,12 +2,12 @@ - + FrontendModule - + @@ -92,7 +92,7 @@ uk.org.ury.frontend
    Interface FrontendModule
    -
    All Known Implementing Classes:
    AbstractFrontendModule, LibraryViewer, ShowViewer
    +
    All Known Implementing Classes:
    AbstractFrontendModule, DemoMenu, LibraryViewer, ShowViewer
    diff --git a/doc/uk/org/ury/frontend/FrontendModulePanel.html b/doc/uk/org/ury/frontend/FrontendModulePanel.html index b7b1b89..aa6603e 100644 --- a/doc/uk/org/ury/frontend/FrontendModulePanel.html +++ b/doc/uk/org/ury/frontend/FrontendModulePanel.html @@ -2,12 +2,12 @@ - + FrontendModulePanel - + @@ -237,7 +237,7 @@ A frontend user interface panel. abstract  java.lang.String -getName() +getModuleName()
                @@ -285,7 +285,7 @@ A frontend user interface panel. Methods inherited from class java.awt.Component -action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle +action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle   @@ -351,15 +351,12 @@ public FrontendModulePanel(

    -getName

    +

    +getModuleName

    -public abstract java.lang.String getName()
    +public abstract java.lang.String getModuleName()
    -
    Overrides:
    getName in class java.awt.Component
    -
    -
    Returns:
    the name of the panel module.
    diff --git a/doc/uk/org/ury/frontend/FrontendPanel.html b/doc/uk/org/ury/frontend/FrontendPanel.html index a06fef4..719bd6b 100644 --- a/doc/uk/org/ury/frontend/FrontendPanel.html +++ b/doc/uk/org/ury/frontend/FrontendPanel.html @@ -2,12 +2,12 @@ - + FrontendPanel - + @@ -103,7 +103,7 @@ java.lang.Object
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    -
    Direct Known Subclasses:
    FrontendControlPanel, FrontendModulePanel
    +
    Direct Known Subclasses:
    ChannelPanel, FrontendControlPanel, FrontendModulePanel, TrackBin
    @@ -113,6 +113,11 @@ java.lang.Object

    An extension of JPanel providing common functionality for user interface panels in the URY system frontend. + + Most notably, this includes automated access to XML-based + preparation of the user interface provided by the panel, + using an appropriate constructor call giving the XML file from + which the user interface form should be read.

    @@ -295,7 +300,9 @@ public FrontendPanel(UICreationFailureException - if the UI creation fails.

    diff --git a/doc/uk/org/ury/frontend/FrontendSubBanner.html b/doc/uk/org/ury/frontend/FrontendSubBanner.html index ece999f..ea28af1 100644 --- a/doc/uk/org/ury/frontend/FrontendSubBanner.html +++ b/doc/uk/org/ury/frontend/FrontendSubBanner.html @@ -2,12 +2,12 @@ - + FrontendSubBanner - + diff --git a/doc/uk/org/ury/frontend/HintField.html b/doc/uk/org/ury/frontend/HintField.html index 6fca8b2..12e6e08 100644 --- a/doc/uk/org/ury/frontend/HintField.html +++ b/doc/uk/org/ury/frontend/HintField.html @@ -2,12 +2,12 @@ - + HintField - + diff --git a/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html b/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html index 63f5b79..f36bd08 100644 --- a/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html +++ b/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.AbstractFrontendModule - + @@ -97,6 +97,10 @@ Packages that use uk.org.ury.show.viewer    + +uk.org.ury.testrig +   +  

    @@ -120,7 +124,7 @@ Uses of LibraryViewer
    -            +          Module for investigating the track library.   @@ -150,6 +154,31 @@ Uses of  

    + + + + + +
    +Uses of AbstractFrontendModule in uk.org.ury.testrig
    +  +

    + + + + + + + + + +
    Subclasses of AbstractFrontendModule in uk.org.ury.testrig
    + classDemoMenu + +
    +          Application frontend, for testing early-stage frontend code.
    +  +

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

    +Uses of Class
    uk.org.ury.frontend.FrontendApplet

    +
    + + + + + + + + + +
    +Packages that use FrontendApplet
    uk.org.ury.frontend  
    +  +

    + + + + + +
    +Uses of FrontendApplet in uk.org.ury.frontend
    +  +

    + + + + + + + + + +
    Methods in uk.org.ury.frontend with parameters of type FrontendApplet
    +static voidFrontendError.reportFatal(java.lang.String message, + FrontendApplet panel) + +
    +           
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendBanner.html b/doc/uk/org/ury/frontend/class-use/FrontendBanner.html index a89c6eb..230ca1b 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendBanner.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendBanner.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendBanner - + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendControlPanel.html b/doc/uk/org/ury/frontend/class-use/FrontendControlPanel.html index bdcd6e7..c7aa65c 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendControlPanel.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendControlPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendControlPanel - + @@ -121,32 +121,31 @@ Uses of  void -FrontendAppletPanel.restoreModule(FrontendModulePanel mpanel, +FrontendApplet.restoreModule(FrontendModulePanel mpanel, FrontendControlPanel cpanel)
    -          Restore an existing module and control panel into the frontend - frame. +          Restore an existing module and control panel into the frontend frame.  void -FrontendMaster.restoreModule(FrontendModulePanel mpanel, +FrontendFrame.restoreModule(FrontendModulePanel mpanel, FrontendControlPanel cpanel)
              Restore an existing module and control panel into the frontend - master. + frame.  void -FrontendFrame.restoreModule(FrontendModulePanel mpanel, +FrontendMaster.restoreModule(FrontendModulePanel mpanel, FrontendControlPanel cpanel)
              Restore an existing module and control panel into the frontend - frame. + master. diff --git a/doc/uk/org/ury/frontend/class-use/FrontendError.html b/doc/uk/org/ury/frontend/class-use/FrontendError.html index 7454d1c..40ed92f 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendError.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendError.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendError - + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendFrame.html b/doc/uk/org/ury/frontend/class-use/FrontendFrame.html index 02c5ee8..0d9b825 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendFrame.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendFrame.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendFrame - + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendMaster.html b/doc/uk/org/ury/frontend/class-use/FrontendMaster.html index 78e7235..528d5cb 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendMaster.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendMaster.html @@ -2,12 +2,12 @@ - + Uses of Interface uk.org.ury.frontend.FrontendMaster - + @@ -125,11 +125,11 @@ Uses of  class -FrontendAppletPanel +FrontendApplet
    -          A frame that hosts a FrontendModulePanel, used for serving frontend - panels in a window (application mode). +          A frame that hosts a FrontendModulePanel, used for serving frontend panels in + a window (application mode). @@ -293,6 +293,22 @@ Uses of + +Methods in uk.org.ury.testrig with parameters of type FrontendMaster + + + + FrontendModulePanel +DemoMenu.runFrontend(FrontendMaster master) + +
    +          Run the demo menu in frontend mode. + + +  +

    + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendModule.html b/doc/uk/org/ury/frontend/class-use/FrontendModule.html index 93cec67..88c88f0 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendModule.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendModule.html @@ -2,12 +2,12 @@ - + Uses of Interface uk.org.ury.frontend.FrontendModule - + @@ -101,6 +101,10 @@ Packages that use uk.org.ury.show.viewer + + + +
    Constructors in uk.org.ury.testrig with parameters of type FrontendMaster   
    uk.org.ury.testrig  
     

    @@ -188,7 +192,7 @@ Uses of LibraryViewer
    -            +          Module for investigating the track library.   @@ -218,6 +222,31 @@ Uses of + + + + +
    +Uses of FrontendModule in uk.org.ury.testrig
    +  +

    + + + + + + + + + +
    Classes in uk.org.ury.testrig that implement FrontendModule
    + classDemoMenu + +
    +          Application frontend, for testing early-stage frontend code.
    +  +

    diff --git a/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html b/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html index 05bd4c8..5e5edb7 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendModulePanel - + @@ -141,32 +141,31 @@ Uses of  void -FrontendAppletPanel.restoreModule(FrontendModulePanel mpanel, +FrontendApplet.restoreModule(FrontendModulePanel mpanel, FrontendControlPanel cpanel)
    -          Restore an existing module and control panel into the frontend - frame. +          Restore an existing module and control panel into the frontend frame.  void -FrontendMaster.restoreModule(FrontendModulePanel mpanel, +FrontendFrame.restoreModule(FrontendModulePanel mpanel, FrontendControlPanel cpanel)
              Restore an existing module and control panel into the frontend - master. + frame.  void -FrontendFrame.restoreModule(FrontendModulePanel mpanel, +FrontendMaster.restoreModule(FrontendModulePanel mpanel, FrontendControlPanel cpanel)
              Restore an existing module and control panel into the frontend - frame. + master. @@ -181,26 +180,6 @@ Uses of  

    - - - - - - - - - - - -
    Constructors in uk.org.ury.frontend with parameters of type FrontendModulePanel
    FrontendAppletPanel(FrontendModulePanel parent) - -
    -           
    FrontendFrame(FrontendModulePanel parent) - -
    -           
    -  -

    @@ -262,7 +241,7 @@ Uses of ShowViewerPanel
    -          Frontend panel providing access to an underlying lshow viewer. +          Frontend panel providing access to an underlying show viewer.
      @@ -308,6 +287,22 @@ Uses of  

    + + + + + + + + + +
    Methods in uk.org.ury.testrig that return FrontendModulePanel
    + FrontendModulePanelDemoMenu.runFrontend(FrontendMaster master) + +
    +          Run the demo menu in frontend mode.
    +  +

    diff --git a/doc/uk/org/ury/frontend/class-use/FrontendPanel.html b/doc/uk/org/ury/frontend/class-use/FrontendPanel.html index a52cdc2..f7f386a 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendPanel.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendPanel - + @@ -183,6 +183,14 @@ Uses of  class +ChannelPanel + +
    +          A panel displaying channel information. + + + + class LibraryControlPanel
    @@ -194,7 +202,15 @@ Uses of ShowViewerPanel
    -          Frontend panel providing access to an underlying lshow viewer. +          Frontend panel providing access to an underlying show viewer. + + + + class +TrackBin + +
    +          A panel displaying track bin contents.   diff --git a/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html b/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html index ff6a506..e5c50cb 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendSubBanner - + diff --git a/doc/uk/org/ury/frontend/class-use/HintField.html b/doc/uk/org/ury/frontend/class-use/HintField.html index 32d0006..feb6a66 100644 --- a/doc/uk/org/ury/frontend/class-use/HintField.html +++ b/doc/uk/org/ury/frontend/class-use/HintField.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.HintField - + diff --git a/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html b/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html new file mode 100644 index 0000000..33acf70 --- /dev/null +++ b/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html @@ -0,0 +1,268 @@ + + + + + + +LoadFailureException + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.frontend.exceptions +
    +Class LoadFailureException

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

    +Exception thrown when the loading of a new frontend module fails. +

    + +

    +

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

    + + + + + + + + + + + + + + +
    +Constructor Summary
    LoadFailureException() + +
    +          Construct a new LoadFailureException with a + default reason.
    LoadFailureException(java.lang.String reason) + +
    +          Construct a new LoadFailureException.
    +  + + + + + + + +
    +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
    + +

    +LoadFailureException

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

    +

    +
    + +

    +LoadFailureException

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

    +

    +
    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/frontend/exceptions/UICreationFailureException.html b/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html index 9eb084b..753628e 100644 --- a/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html @@ -2,12 +2,12 @@ - + UICreationFailureException - + @@ -55,7 +55,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -233,7 +233,7 @@ public UICreationFailureException(java.lang.String reason) - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   diff --git a/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html b/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html new file mode 100644 index 0000000..2434645 --- /dev/null +++ b/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html @@ -0,0 +1,226 @@ + + + + + + +Uses of Class uk.org.ury.frontend.exceptions.LoadFailureException + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.frontend.exceptions.LoadFailureException

    +
    + + + + + + + + + +
    +Packages that use LoadFailureException
    uk.org.ury.frontend  
    +  +

    + + + + + +
    +Uses of LoadFailureException in uk.org.ury.frontend
    +  +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Methods in uk.org.ury.frontend that throw LoadFailureException
    + voidFrontendApplet.loadModule(java.lang.String moduleName) + +
    +          Load a module into the frontend frame.
    + voidFrontendFrame.loadModule(java.lang.String moduleName) + +
    +          Load a module into the frontend frame.
    + voidFrontendMaster.loadModule(java.lang.String moduleName) + +
    +          Load a module into the frontend frame.
    + voidFrontendApplet.loadModule(java.lang.String moduleName, + java.lang.String cPanelName) + +
    +          Load a module into the frontend frame, additionally installing a control + panel to communicate with the previous module.
    + voidFrontendFrame.loadModule(java.lang.String moduleName, + java.lang.String cPanelName) + +
    +          Load a module into the frontend frame, additionally installing + a control panel to communicate with the previous module.
    + voidFrontendMaster.loadModule(java.lang.String moduleName, + java.lang.String cPanelName) + +
    +          Load a module into the frontend frame, additionally installing + a control panel to communicate with the previous module.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html b/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html index 1894d11..ea8a2fa 100644 --- a/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.exceptions.UICreationFailureException - + diff --git a/doc/uk/org/ury/frontend/exceptions/package-frame.html b/doc/uk/org/ury/frontend/exceptions/package-frame.html index fbecad3..de032c1 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-frame.html +++ b/doc/uk/org/ury/frontend/exceptions/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.frontend.exceptions - + @@ -23,6 +23,8 @@ uk.org.ury.frontend.exceptions Exceptions     
    +LoadFailureException +
    UICreationFailureException     diff --git a/doc/uk/org/ury/frontend/exceptions/package-summary.html b/doc/uk/org/ury/frontend/exceptions/package-summary.html index 500b08c..2127de2 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-summary.html +++ b/doc/uk/org/ury/frontend/exceptions/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.frontend.exceptions - + @@ -89,6 +89,10 @@ Package uk.org.ury.frontend.exceptions Exception Summary     +LoadFailureException +Exception thrown when the loading of a new frontend module fails. + + UICreationFailureException Exception thrown when the creation of a UI element fails. diff --git a/doc/uk/org/ury/frontend/exceptions/package-tree.html b/doc/uk/org/ury/frontend/exceptions/package-tree.html index 8975aae..d3764fa 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-tree.html +++ b/doc/uk/org/ury/frontend/exceptions/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.frontend.exceptions Class Hierarchy - + @@ -95,7 +95,7 @@ Class Hierarchy
  • java.lang.Throwable (implements java.io.Serializable) diff --git a/doc/uk/org/ury/frontend/exceptions/package-use.html b/doc/uk/org/ury/frontend/exceptions/package-use.html index 33576e4..93d545d 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-use.html +++ b/doc/uk/org/ury/frontend/exceptions/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.frontend.exceptions - + @@ -115,6 +115,12 @@ Packages that use uk.org.ury.frontend.exceptions used by uk.org.ury.frontend +LoadFailureException + +
    +          Exception thrown when the loading of a new frontend module fails. + + UICreationFailureException
    diff --git a/doc/uk/org/ury/frontend/package-frame.html b/doc/uk/org/ury/frontend/package-frame.html index 6cd39ef..e35b4b8 100644 --- a/doc/uk/org/ury/frontend/package-frame.html +++ b/doc/uk/org/ury/frontend/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.frontend - + @@ -38,7 +38,7 @@ Classes     
    AbstractFrontendModule
    -FrontendAppletPanel +FrontendApplet
    FrontendBanner
    diff --git a/doc/uk/org/ury/frontend/package-summary.html b/doc/uk/org/ury/frontend/package-summary.html index 544a478..119ce35 100644 --- a/doc/uk/org/ury/frontend/package-summary.html +++ b/doc/uk/org/ury/frontend/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.frontend - + @@ -113,9 +113,9 @@ Package uk.org.ury.frontend An abstract implementation of the FrontendModule interface. -FrontendAppletPanel -A frame that hosts a FrontendModulePanel, used for serving frontend - panels in a window (application mode). +FrontendApplet +A frame that hosts a FrontendModulePanel, used for serving frontend panels in + a window (application mode). FrontendBanner diff --git a/doc/uk/org/ury/frontend/package-tree.html b/doc/uk/org/ury/frontend/package-tree.html index 2c0f520..6ead817 100644 --- a/doc/uk/org/ury/frontend/package-tree.html +++ b/doc/uk/org/ury/frontend/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.frontend Class Hierarchy - + @@ -92,6 +92,7 @@ Class Hierarchy
    • java.lang.Object
        +
      • uk.org.ury.frontend.AbstractFrontendModule (implements uk.org.ury.frontend.FrontendModule)
      • java.awt.Component (implements java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable)
        • java.awt.Container @@ -126,7 +127,6 @@ Class Hierarchy diff --git a/doc/uk/org/ury/frontend/package-use.html b/doc/uk/org/ury/frontend/package-use.html index 145b6c1..4868ed8 100644 --- a/doc/uk/org/ury/frontend/package-use.html +++ b/doc/uk/org/ury/frontend/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.frontend - + @@ -115,11 +115,11 @@ Packages that use uk.org.ury.frontend used by uk.org.ury.frontend -FrontendAppletPanel +FrontendApplet
          -          A frame that hosts a FrontendModulePanel, used for serving frontend - panels in a window (application mode). +          A frame that hosts a FrontendModulePanel, used for serving frontend panels in + a window (application mode). FrontendControlPanel @@ -261,6 +261,12 @@ Classes in uk.org Classes in uk.org.ury.frontend used by uk.org.ury.testrig +AbstractFrontendModule + +
          +          An abstract implementation of the FrontendModule interface. + + FrontendControlPanel
          @@ -274,6 +280,13 @@ Classes in uk.org session. +FrontendModule + +
          +          Interface for all system modules that are to be reachable from + the frontend array. + + FrontendModulePanel
          diff --git a/doc/uk/org/ury/library/LibraryRequestHandler.html b/doc/uk/org/ury/library/LibraryRequestHandler.html new file mode 100644 index 0000000..cf88582 --- /dev/null +++ b/doc/uk/org/ury/library/LibraryRequestHandler.html @@ -0,0 +1,283 @@ + + + + + + +LibraryRequestHandler + + + + + + + + + + + + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          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.library +
          +Class LibraryRequestHandler

          +
          +java.lang.Object
+  extended by uk.org.ury.library.LibraryRequestHandler
+
          +
          +
          All Implemented Interfaces:
          RequestHandler
          +
          +
          +
          +
          public class LibraryRequestHandler
          extends java.lang.Object
          implements RequestHandler
          + + +

          +A request handler for library queries. +

          + +

          +

          +
          Author:
          +
          Matt Windsor
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          LibraryRequestHandler() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.util.Map<java.lang.String,java.lang.Object>handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, + Server server) + +
          +          Handle a server GET request (that is, a request for data + output).
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

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

          +LibraryRequestHandler

          +
          +public LibraryRequestHandler()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +handleGetRequest

          +
          +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
          +
          +
          Handle a server GET request (that is, a request for data + output). +

          +

          +
          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. +
          Throws: +
          HandleFailureException - if the handler cannot + handle the request.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          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/library/LibraryUtils.html b/doc/uk/org/ury/library/LibraryUtils.html index 57b5d23..5d72605 100644 --- a/doc/uk/org/ury/library/LibraryUtils.html +++ b/doc/uk/org/ury/library/LibraryUtils.html @@ -2,12 +2,12 @@ - + LibraryUtils - + @@ -55,7 +55,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -140,7 +140,7 @@ A set of common utility routines to facilitate the extraction of -static java.util.List<LibraryItem> +static java.util.List<LibraryItem> search(DatabaseDriver db, java.lang.String search) @@ -190,7 +190,7 @@ public LibraryUtils()

          search

          -public static java.util.List<LibraryItem> search(DatabaseDriver db,
+public static java.util.List<LibraryItem> search(DatabaseDriver db,
                                                  java.lang.String search)
                                           throws QueryFailureException,
                                                  EmptySearchException
          @@ -242,7 +242,7 @@ public static java.util.List< - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   diff --git a/doc/uk/org/ury/library/class-use/LibraryRequestHandler.html b/doc/uk/org/ury/library/class-use/LibraryRequestHandler.html new file mode 100644 index 0000000..b7ad76f --- /dev/null +++ b/doc/uk/org/ury/library/class-use/LibraryRequestHandler.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.library.LibraryRequestHandler + + + + + + + + + + + + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Uses of Class
          uk.org.ury.library.LibraryRequestHandler

          +
          +No usage of uk.org.ury.library.LibraryRequestHandler +

          +

          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/doc/uk/org/ury/library/class-use/LibraryUtils.html b/doc/uk/org/ury/library/class-use/LibraryUtils.html index 0c04a18..7990e0e 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 0cdeb15..6718556 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 00010d8..d10019e 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 - + @@ -116,7 +116,7 @@ Uses of -static java.util.List<LibraryItem> +static java.util.List<LibraryItem>           LibraryUtils.search(DatabaseDriver db, java.lang.String search) diff --git a/doc/uk/org/ury/library/exceptions/package-frame.html b/doc/uk/org/ury/library/exceptions/package-frame.html index 3ad8331..4d9997b 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 d943fbc..29f7dcc 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 - + @@ -56,7 +56,7 @@ function windowTitle()  PREV PACKAGE  - NEXT PACKAGE + NEXT PACKAGE FRAMES    NO FRAMES   @@ -130,7 +130,7 @@ Package uk.org.ury.library.exceptions  PREV PACKAGE  - NEXT PACKAGE + NEXT PACKAGE FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/library/exceptions/package-tree.html b/doc/uk/org/ury/library/exceptions/package-tree.html index f9c3f27..d6803f6 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 - + @@ -56,7 +56,7 @@ function windowTitle()  PREV  - NEXT + NEXT FRAMES    NO FRAMES   @@ -130,7 +130,7 @@ Class Hierarchy  PREV  - NEXT + NEXT FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/library/exceptions/package-use.html b/doc/uk/org/ury/library/exceptions/package-use.html index 5642e8d..eef9aa1 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 new file mode 100644 index 0000000..f112b8c --- /dev/null +++ b/doc/uk/org/ury/library/item/LibraryItem.html @@ -0,0 +1,242 @@ + + + + + + +LibraryItem + + + + + + + + + + + + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          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.library.item +
          +Class LibraryItem

          +
          +java.lang.Object
+  extended by uk.org.ury.database.DatabaseItem<LibraryItemProperty,java.lang.String>
+      extended by uk.org.ury.library.item.LibraryItem
+
          +
          +
          +
          public class LibraryItem
          extends DatabaseItem<LibraryItemProperty,java.lang.String>
          + + +

          +An item in the URY library. +

          + +

          +

          +
          Author:
          +
          Matt Windsor
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          LibraryItem(java.util.Map<LibraryItemProperty,java.lang.String> properties) + +
          +           
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class uk.org.ury.database.DatabaseItem
          asResponse, get, has
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

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

          +LibraryItem

          +
          +public LibraryItem(java.util.Map<LibraryItemProperty,java.lang.String> properties)
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          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/library/item/LibraryItemProperty.html b/doc/uk/org/ury/library/item/LibraryItemProperty.html new file mode 100644 index 0000000..2356980 --- /dev/null +++ b/doc/uk/org/ury/library/item/LibraryItemProperty.html @@ -0,0 +1,599 @@ + + + + + + +LibraryItemProperty + + + + + + + + + + + + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          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.library.item +
          +Enum LibraryItemProperty

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

          +The parameters that are stored in the LibraryItem. +

          + +

          +

          +
          Author:
          +
          Matt Windsor
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Enum Constant Summary
          ALBUM + +
          +           
          ARTIST + +
          +           
          CD_ID + +
          +           
          DATE_ADDED + +
          +           
          DATE_EDITED + +
          +           
          DATE_RELEASED + +
          +           
          FORMAT + +
          +           
          IS_CLEAN + +
          +           
          IS_DIGITISED + +
          +           
          LABEL + +
          +           
          MEDIUM + +
          +           
          SHELF_LETTER + +
          +           
          SHELF_NUMBER + +
          +           
          STATUS + +
          +           
          TITLE + +
          +           
          +  + + + + + + + + + + +
          +Field Summary
          + java.lang.Stringsql + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static LibraryItemPropertygetFromSQL(java.lang.String string) + +
          +          Retrieve a LibraryItemProperty given its SQL identifier.
          +static LibraryItemPropertyvalueOf(java.lang.String name) + +
          +          Returns the enum constant of this type with the specified name.
          +static LibraryItemProperty[]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
          + +

          +TITLE

          +
          +public static final LibraryItemProperty TITLE
          +
          +
          +
          +
          +
          + +

          +ALBUM

          +
          +public static final LibraryItemProperty ALBUM
          +
          +
          +
          +
          +
          + +

          +ARTIST

          +
          +public static final LibraryItemProperty ARTIST
          +
          +
          +
          +
          +
          + +

          +LABEL

          +
          +public static final LibraryItemProperty LABEL
          +
          +
          +
          +
          +
          + +

          +STATUS

          +
          +public static final LibraryItemProperty STATUS
          +
          +
          +
          +
          +
          + +

          +MEDIUM

          +
          +public static final LibraryItemProperty MEDIUM
          +
          +
          +
          +
          +
          + +

          +FORMAT

          +
          +public static final LibraryItemProperty FORMAT
          +
          +
          +
          +
          +
          + +

          +DATE_RELEASED

          +
          +public static final LibraryItemProperty DATE_RELEASED
          +
          +
          +
          +
          +
          + +

          +DATE_ADDED

          +
          +public static final LibraryItemProperty DATE_ADDED
          +
          +
          +
          +
          +
          + +

          +DATE_EDITED

          +
          +public static final LibraryItemProperty DATE_EDITED
          +
          +
          +
          +
          +
          + +

          +SHELF_LETTER

          +
          +public static final LibraryItemProperty SHELF_LETTER
          +
          +
          +
          +
          +
          + +

          +SHELF_NUMBER

          +
          +public static final LibraryItemProperty SHELF_NUMBER
          +
          +
          +
          +
          +
          + +

          +CD_ID

          +
          +public static final LibraryItemProperty CD_ID
          +
          +
          +
          +
          +
          + +

          +IS_DIGITISED

          +
          +public static final LibraryItemProperty IS_DIGITISED
          +
          +
          +
          +
          +
          + +

          +IS_CLEAN

          +
          +public static final LibraryItemProperty IS_CLEAN
          +
          +
          +
          +
          + + + + + + + + +
          +Field Detail
          + +

          +sql

          +
          +public final java.lang.String sql
          +
          +
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +values

          +
          +public static LibraryItemProperty[] 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 (LibraryItemProperty c : LibraryItemProperty.values())
+    System.out.println(c);
+
          +

          +

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

          +valueOf

          +
          +public static LibraryItemProperty 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
          +
          +
          +
          + +

          +getFromSQL

          +
          +public static LibraryItemProperty getFromSQL(java.lang.String string)
          +
          +
          Retrieve a LibraryItemProperty given its SQL identifier. +

          +

          +
          Parameters:
          string - The SQL identifier. +
          Returns:
          The first property to match. +
          Throws: +
          java.lang.IllegalArgumentException - if no matches were + found.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          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/library/item/class-use/LibraryItem.html b/doc/uk/org/ury/library/item/class-use/LibraryItem.html new file mode 100644 index 0000000..8fbcc26 --- /dev/null +++ b/doc/uk/org/ury/library/item/class-use/LibraryItem.html @@ -0,0 +1,224 @@ + + + + + + +Uses of Class uk.org.ury.library.item.LibraryItem + + + + + + + + + + + + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Uses of Class
          uk.org.ury.library.item.LibraryItem

          +
          + + + + + + + + + + + + + +
          +Packages that use LibraryItem
          uk.org.ury.library  
          uk.org.ury.library.viewer  
          +  +

          + + + + + +
          +Uses of LibraryItem in uk.org.ury.library
          +  +

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

          + + + + + +
          +Uses of LibraryItem in uk.org.ury.library.viewer
          +  +

          + + + + + + + + + +
          Methods in uk.org.ury.library.viewer that return types with arguments of type LibraryItem
          + java.util.List<LibraryItem>LibraryViewer.getLibraryList() + +
          +           
          +  +

          + + + + + + + + +
          Constructor parameters in uk.org.ury.library.viewer with type arguments of type LibraryItem
          LibraryTableModel(java.util.List<LibraryItem> data) + +
          +          Construct a new table model.
          +  +

          +

          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/doc/uk/org/ury/library/item/class-use/LibraryItemProperty.html b/doc/uk/org/ury/library/item/class-use/LibraryItemProperty.html new file mode 100644 index 0000000..2d5c3a6 --- /dev/null +++ b/doc/uk/org/ury/library/item/class-use/LibraryItemProperty.html @@ -0,0 +1,211 @@ + + + + + + +Uses of Class uk.org.ury.library.item.LibraryItemProperty + + + + + + + + + + + + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Uses of Class
          uk.org.ury.library.item.LibraryItemProperty

          +
          + + + + + + + + + +
          +Packages that use LibraryItemProperty
          uk.org.ury.library.item  
          +  +

          + + + + + +
          +Uses of LibraryItemProperty in uk.org.ury.library.item
          +  +

          + + + + + + + + + + + + + + + + + +
          Methods in uk.org.ury.library.item that return LibraryItemProperty
          +static LibraryItemPropertyLibraryItemProperty.getFromSQL(java.lang.String string) + +
          +          Retrieve a LibraryItemProperty given its SQL identifier.
          +static LibraryItemPropertyLibraryItemProperty.valueOf(java.lang.String name) + +
          +          Returns the enum constant of this type with the specified name.
          +static LibraryItemProperty[]LibraryItemProperty.values() + +
          +          Returns an array containing the constants of this enum type, in +the order they are declared.
          +  +

          + + + + + + + + +
          Constructor parameters in uk.org.ury.library.item with type arguments of type LibraryItemProperty
          LibraryItem(java.util.Map<LibraryItemProperty,java.lang.String> properties) + +
          +           
          +  +

          +

          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/doc/uk/org/ury/library/item/package-frame.html b/doc/uk/org/ury/library/item/package-frame.html new file mode 100644 index 0000000..d4f571c --- /dev/null +++ b/doc/uk/org/ury/library/item/package-frame.html @@ -0,0 +1,43 @@ + + + + + + +uk.org.ury.library.item + + + + + + + + + + + +uk.org.ury.library.item + + + + +
          +Classes  + +
          +LibraryItem
          + + + + + + +
          +Enums  + +
          +LibraryItemProperty
          + + + + diff --git a/doc/uk/org/ury/library/item/package-summary.html b/doc/uk/org/ury/library/item/package-summary.html new file mode 100644 index 0000000..6e2f33c --- /dev/null +++ b/doc/uk/org/ury/library/item/package-summary.html @@ -0,0 +1,171 @@ + + + + + + +uk.org.ury.library.item + + + + + + + + + + + + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package uk.org.ury.library.item +

          + + + + + + + + + +
          +Class Summary
          LibraryItemAn item in the URY library.
          +  + +

          + + + + + + + + + +
          +Enum Summary
          LibraryItemPropertyThe parameters that are stored in the LibraryItem.
          +  + +

          +

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

          +Hierarchy For Package uk.org.ury.library.item +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Enum Hierarchy +

          +
            +
          • java.lang.Object
              +
            • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
            +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/doc/uk/org/ury/library/item/package-use.html b/doc/uk/org/ury/library/item/package-use.html new file mode 100644 index 0000000..98be535 --- /dev/null +++ b/doc/uk/org/ury/library/item/package-use.html @@ -0,0 +1,208 @@ + + + + + + +Uses of Package uk.org.ury.library.item + + + + + + + + + + + + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Uses of Package
          uk.org.ury.library.item

          +
          + + + + + + + + + + + + + + + + + +
          +Packages that use uk.org.ury.library.item
          uk.org.ury.library  
          uk.org.ury.library.item  
          uk.org.ury.library.viewer  
          +  +

          + + + + + + + + +
          +Classes in uk.org.ury.library.item used by uk.org.ury.library
          LibraryItem + +
          +          An item in the URY library.
          +  +

          + + + + + + + + +
          +Classes in uk.org.ury.library.item used by uk.org.ury.library.item
          LibraryItemProperty + +
          +          The parameters that are stored in the LibraryItem.
          +  +

          + + + + + + + + +
          +Classes in uk.org.ury.library.item used by uk.org.ury.library.viewer
          LibraryItem + +
          +          An item in the URY library.
          +  +

          +

          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/doc/uk/org/ury/library/package-frame.html b/doc/uk/org/ury/library/package-frame.html index d25cd99..1bc8298 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 - + @@ -23,25 +23,12 @@ uk.org.ury.library Classes           
          -LibraryItem -
          -LibraryTableModel +LibraryRequestHandler
          LibraryUtils           - - - - -
          -Enums  - -
          -LibraryItemProperty
          - - diff --git a/doc/uk/org/ury/library/package-summary.html b/doc/uk/org/ury/library/package-summary.html index 2a764d7..6ca2cbd 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 - + @@ -89,12 +89,8 @@ Package uk.org.ury.library Class Summary -LibraryItem -An item in the URY library. - - -LibraryTableModel -A table model for the library viewer. +LibraryRequestHandler +A request handler for library queries. LibraryUtils @@ -104,20 +100,6 @@ Package uk.org.ury.library   -

          - - - - - - - - - -
          -Enum Summary
          LibraryItemPropertyThe parameters that are stored in the LibraryItem.
          -  -

          diff --git a/doc/uk/org/ury/library/package-tree.html b/doc/uk/org/ury/library/package-tree.html index 54d4ddb..52546f1 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,23 +92,9 @@ Class Hierarchy -

          -Enum Hierarchy -

          -
            -
          • java.lang.Object
              -
            • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) - -
            -
          diff --git a/doc/uk/org/ury/library/package-use.html b/doc/uk/org/ury/library/package-use.html index 1aeb0ef..57b1b08 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 - + @@ -83,58 +83,7 @@ function windowTitle()

          Uses of Package
          uk.org.ury.library

          - - - - - - - - - - - - - -
          -Packages that use uk.org.ury.library
          uk.org.ury.library  
          uk.org.ury.library.viewer  
          -  -

          - - - - - - - - - - - -
          -Classes in uk.org.ury.library used by uk.org.ury.library
          LibraryItem - -
          -          An item in the URY library.
          LibraryItemProperty - -
          -          The parameters that are stored in the LibraryItem.
          -  -

          - - - - - - - - -
          -Classes in uk.org.ury.library used by uk.org.ury.library.viewer
          LibraryItem - -
          -          An item in the URY library.
          -  +No usage of uk.org.ury.library

          diff --git a/doc/uk/org/ury/library/viewer/LibraryTableModel.html b/doc/uk/org/ury/library/viewer/LibraryTableModel.html new file mode 100644 index 0000000..ca0bc2b --- /dev/null +++ b/doc/uk/org/ury/library/viewer/LibraryTableModel.html @@ -0,0 +1,362 @@ + + + + + + +LibraryTableModel + + + + + + + + + + + + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          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.library.viewer +
          +Class LibraryTableModel

          +
          +java.lang.Object
+  extended by javax.swing.table.AbstractTableModel
+      extended by uk.org.ury.library.viewer.LibraryTableModel
+
          +
          +
          All Implemented Interfaces:
          java.io.Serializable, javax.swing.table.TableModel
          +
          +
          +
          +
          public class LibraryTableModel
          extends javax.swing.table.AbstractTableModel
          + + +

          +A table model for the library viewer. +

          + +

          +

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

          + + + + + + + + + + + +
          +Constructor Summary
          LibraryTableModel(java.util.List<LibraryItem> data) + +
          +          Construct a new table model.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Class<?>getColumnClass(int c) + +
          +           
          + intgetColumnCount() + +
          +           
          + java.lang.StringgetColumnName(int index) + +
          +           
          + intgetRowCount() + +
          +           
          + java.lang.ObjectgetValueAt(int rowIndex, + int columnIndex) + +
          +           
          +  + + + + + + + +
          Methods inherited from class javax.swing.table.AbstractTableModel
          addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getListeners, getTableModelListeners, isCellEditable, removeTableModelListener, setValueAt
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

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

          +LibraryTableModel

          +
          +public LibraryTableModel(java.util.List<LibraryItem> data)
          +
          +
          Construct a new table model. +

          +

          +
          Parameters:
          data - The list of data on which the model will be based.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getColumnCount

          +
          +public int getColumnCount()
          +
          +
          +
          +
          +
          +
          + +

          +getRowCount

          +
          +public int getRowCount()
          +
          +
          +
          +
          +
          +
          + +

          +getColumnClass

          +
          +public java.lang.Class<?> getColumnClass(int c)
          +
          +
          +
          Specified by:
          getColumnClass in interface javax.swing.table.TableModel
          Overrides:
          getColumnClass in class javax.swing.table.AbstractTableModel
          +
          +
          +
          Parameters:
          c - The column whose class should be investigated. +
          Returns:
          the column class of column c.
          +
          +
          +
          + +

          +getValueAt

          +
          +public java.lang.Object getValueAt(int rowIndex,
+                                   int columnIndex)
          +
          +
          +
          +
          +
          +
          + +

          +getColumnName

          +
          +public java.lang.String getColumnName(int index)
          +
          +
          +
          Specified by:
          getColumnName in interface javax.swing.table.TableModel
          Overrides:
          getColumnName in class javax.swing.table.AbstractTableModel
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          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/library/viewer/LibraryViewer.html b/doc/uk/org/ury/library/viewer/LibraryViewer.html index 5138c9b..e1f328e 100644 --- a/doc/uk/org/ury/library/viewer/LibraryViewer.html +++ b/doc/uk/org/ury/library/viewer/LibraryViewer.html @@ -2,12 +2,12 @@ - + LibraryViewer - + @@ -55,7 +55,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -76,7 +76,7 @@ function windowTitle() - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD @@ -93,75 +93,30 @@ uk.org.ury.library.viewer Class LibraryViewer 
           java.lang.Object
-  extended by java.awt.Component
-      extended by java.awt.Container
-          extended by java.awt.Panel
-              extended by java.applet.Applet
-                  extended by javax.swing.JApplet
-                      extended by uk.org.ury.frontend.AbstractFrontendModule
-                          extended by uk.org.ury.library.viewer.LibraryViewer
+  extended by uk.org.ury.frontend.AbstractFrontendModule
+      extended by uk.org.ury.library.viewer.LibraryViewer
          -
          All Implemented Interfaces:
          java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, FrontendModule
          +
          All Implemented Interfaces:
          FrontendModule
          public class LibraryViewer
          extends AbstractFrontendModule
          +

          +Module for investigating the track library. +

          +

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

          - - - - - - -
          -Nested Class Summary
          -  - - - - - - - -
          Nested classes/interfaces inherited from class java.awt.Component
          java.awt.Component.BaselineResizeBehavior
          -  - - - - - - - -
          -Field Summary
          -  - - - - - - - -
          Fields inherited from class java.awt.Component
          BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
          -  - - - - - - - -
          Fields inherited from interface java.awt.image.ImageObserver
          ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
          -  @@ -196,7 +151,7 @@ java.lang.Object - java.util.List<LibraryItem> + java.util.List<LibraryItem> getLibraryList()
          @@ -204,73 +159,12 @@ java.lang.Object - void -init() - -
          -          Initialise the library viewer frontend as an applet. - - -  FrontendModulePanel runFrontend(FrontendMaster master)
                    Run the library viewer frontend. - - - void -start() - -
          -          Run the library viewer frontend as an applet. - - -  - - - - - - - -
          Methods inherited from class javax.swing.JApplet
          getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, remove, repaint, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
          -  - - - - - - - -
          Methods inherited from class java.applet.Applet
          destroy, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus, stop
          -  - - - - - - - -
          Methods inherited from class java.awt.Panel
          addNotify
          -  - - - - - - - -
          Methods inherited from class java.awt.Container
          add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate
          -  - - - - - - -
          Methods inherited from class java.awt.Component
          action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
            @@ -278,7 +172,7 @@ java.lang.Object - +
          Methods inherited from class java.lang.Object
          equals, getClass, hashCode, notify, notifyAll, wait, wait, waitequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            @@ -313,38 +207,6 @@ public LibraryViewer() -

          -init

          -
          -public void init()
          -
          -
          Initialise the library viewer frontend as an applet. -

          -

          -
          Specified by:
          init in class AbstractFrontendModule
          -
          -
          -
          -
          -
          -
          - -

          -start

          -
          -public void start()
          -
          -
          Run the library viewer frontend as an applet. -

          -

          -
          Overrides:
          start in class java.applet.Applet
          -
          -
          -
          -
          -
          -
          -

          runFrontend

          @@ -365,21 +227,19 @@ doSearch
 
           public void doSearch(java.lang.String search)
               throws EmptySearchException,
-                     QueryFailureException
          
+                     InvalidMessageException
          Do a library search. - This will update the library list to reflect the results of the - search. + This will update the library list to reflect the results of the search.

          -
          Parameters:
          search - The string fragment to use in searches. - Cannot be empty or null. +
          Parameters:
          search - The string fragment to use in searches. Cannot be empty or + null.
          Throws: -
          EmptySearchException - if the search string is - empty or null (from LibraryUtils.search). -
          QueryFailureException - if the search query - fails (from LibraryUtils.search).
          +
          EmptySearchException - if the search string is empty or null (from + LibraryUtils.search). +
          InvalidMessageException - if the response from the server is invalid.
          @@ -387,7 +247,7 @@ public void doSearch(java.lang.String search)

          getLibraryList

          -public java.util.List<LibraryItem> getLibraryList()
          +public java.util.List<LibraryItem> getLibraryList()
          @@ -425,7 +285,7 @@ public java.util.List< - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -446,7 +306,7 @@ public java.util.List< - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD diff --git a/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html b/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html index b09d292..da89669 100644 --- a/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html +++ b/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html @@ -2,12 +2,12 @@ - + LibraryViewerPanel - + @@ -215,7 +215,7 @@ Frontend panel providing access to an underlying library viewer.  java.lang.String -getName() +getModuleName()
                      @@ -226,8 +226,8 @@ Frontend panel providing access to an underlying library viewer. search()
          -          Action method for performing a search, bound by the UI XML - manifest to the search field and button. +          Action method for performing a search, bound by the UI XML manifest to + the search field and button.   @@ -281,7 +281,7 @@ Frontend panel providing access to an underlying library viewer. Methods inherited from class java.awt.Component -action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle +action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle   @@ -331,17 +331,17 @@ public LibraryViewerPanel(

          -getName

          +

          +getModuleName

          -public java.lang.String getName()
          +public java.lang.String getModuleName()
          -
          Specified by:
          getName in class FrontendModulePanel
          +
          Specified by:
          getModuleName in class FrontendModulePanel
          -
          Returns:
          the name of the panel.
          See Also:
          FrontendModulePanel.getName()
          +
          Returns:
          the name of the panel.
          See Also:
          FrontendModulePanel.getModuleName()
          @@ -351,8 +351,8 @@ search 
           public void search()
          -
          Action method for performing a search, bound by the UI XML - manifest to the search field and button. +
          Action method for performing a search, bound by the UI XML manifest to + the search field and button.

          diff --git a/doc/uk/org/ury/library/viewer/class-use/LibraryTableModel.html b/doc/uk/org/ury/library/viewer/class-use/LibraryTableModel.html new file mode 100644 index 0000000..51f7375 --- /dev/null +++ b/doc/uk/org/ury/library/viewer/class-use/LibraryTableModel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.library.viewer.LibraryTableModel + + + + + + + + + + + + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Uses of Class
          uk.org.ury.library.viewer.LibraryTableModel

          +
          +No usage of uk.org.ury.library.viewer.LibraryTableModel +

          +

          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + + +
          Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + 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 0831c4f..1888cf8 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 08944cc..3097d7f 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 896ea25..546a460 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 - + @@ -23,6 +23,8 @@ uk.org.ury.library.viewer Classes 
          +LibraryTableModel +
          LibraryViewer
          LibraryViewerPanel           diff --git a/doc/uk/org/ury/library/viewer/package-summary.html b/doc/uk/org/ury/library/viewer/package-summary.html index 338b637..28b86ee 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 - + @@ -55,8 +55,8 @@ function windowTitle() - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE FRAMES    NO FRAMES   @@ -89,8 +89,12 @@ Package uk.org.ury.library.viewer Class Summary +LibraryTableModel +A table model for the library viewer. + + LibraryViewer -  +Module for investigating the track library. LibraryViewerPanel @@ -132,8 +136,8 @@ Package uk.org.ury.library.viewer - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/library/viewer/package-tree.html b/doc/uk/org/ury/library/viewer/package-tree.html index bf7a3cf..43aaab4 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 - + @@ -55,8 +55,8 @@ function windowTitle() - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   @@ -92,6 +92,12 @@ Class Hierarchy
          • java.lang.Object
              +
            • uk.org.ury.frontend.AbstractFrontendModule (implements uk.org.ury.frontend.FrontendModule) + +
            • javax.swing.table.AbstractTableModel (implements java.io.Serializable, javax.swing.table.TableModel) +
            • java.awt.Component (implements java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable)
              • java.awt.Container
                  @@ -105,17 +111,6 @@ Class Hierarchy
            -
          • java.awt.Panel (implements javax.accessibility.Accessible) -
              -
            • java.applet.Applet -
      @@ -150,8 +145,8 @@ Class Hierarchy - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/library/viewer/package-use.html b/doc/uk/org/ury/library/viewer/package-use.html index 703c9c9..8023f8c 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 - + @@ -106,7 +106,7 @@ Classes in LibraryViewer
      -            +          Module for investigating the track library.   diff --git a/doc/uk/org/ury/protocol/Directive.html b/doc/uk/org/ury/protocol/Directive.html new file mode 100644 index 0000000..4b55fd9 --- /dev/null +++ b/doc/uk/org/ury/protocol/Directive.html @@ -0,0 +1,362 @@ + + + + + + +Directive + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.protocol +
      +Enum Directive

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

      +Directives supported by the protocol. +

      + +

      +

      +
      Author:
      +
      Matt Windsor
      +
      +
      + +

      + + + + + + + + + + + + + + + + + + + +
      +Enum Constant Summary
      INFO + +
      +           
      ITEMS + +
      +           
      REASON + +
      +           
      STATUS + +
      +           
      +  + + + + + + + + + + + + + + + +
      +Method Summary
      +static DirectivevalueOf(java.lang.String name) + +
      +          Returns the enum constant of this type with the specified name.
      +static Directive[]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
      + +

      +INFO

      +
      +public static final Directive INFO
      +
      +
      +
      +
      +
      + +

      +ITEMS

      +
      +public static final Directive ITEMS
      +
      +
      +
      +
      +
      + +

      +STATUS

      +
      +public static final Directive STATUS
      +
      +
      +
      +
      +
      + +

      +REASON

      +
      +public static final Directive REASON
      +
      +
      +
      +
      + + + + + + + + +
      +Method Detail
      + +

      +values

      +
      +public static Directive[] 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 (Directive c : Directive.values())
+    System.out.println(c);
+
      +

      +

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

      +valueOf

      +
      +public static Directive 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/protocol/ProtocolUtils.html b/doc/uk/org/ury/protocol/ProtocolUtils.html new file mode 100644 index 0000000..5ccdde4 --- /dev/null +++ b/doc/uk/org/ury/protocol/ProtocolUtils.html @@ -0,0 +1,322 @@ + + + + + + +ProtocolUtils + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.protocol +
      +Class ProtocolUtils

      +
      +java.lang.Object
+  extended by uk.org.ury.protocol.ProtocolUtils
+
      +
      +
      +
      public class ProtocolUtils
      extends java.lang.Object
      + + +

      +Utilities for converting between strings encoded in the response protocol and + collections of items, as well as validating and unpicking protocol messages. +

      + +

      +

      +
      Author:
      +
      Matt Windsor
      +
      +
      + +

      + + + + + + + + + + + +
      +Constructor Summary
      ProtocolUtils() + +
      +           
      +  + + + + + + + + + + + + + + + + + + + +
      +Method Summary
      +static java.util.Map<?,?>decode(java.lang.String string) + +
      +          Decode a protocol string into a key-value map.
      +static java.lang.Stringencode(java.util.Map<java.lang.String,java.lang.Object> items) + +
      +          Encode a key-value map into a protocol string.
      +static booleanresponseIsOK(java.util.Map<?,?> response) + +
      +          Check if a response is flagged as having OK status.
      +  + + + + + + + +
      Methods inherited from class java.lang.Object
      equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      +  +

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

      +ProtocolUtils

      +
      +public ProtocolUtils()
      +
      +
      + + + + + + + + +
      +Method Detail
      + +

      +encode

      +
      +public static java.lang.String encode(java.util.Map<java.lang.String,java.lang.Object> items)
      +
      +
      Encode a key-value map into a protocol string. + + The map can contain strings, lists and other maps. Other types may be + accepted by the underlying encoding engine, but the above types are the + only ones explicitly accepted. +

      +

      +
      Parameters:
      items - The key-value map of items, which should contain strings, + lists and maps. The keys of any map should be protocol + directives. +
      Returns:
      A string containing the encoded representation of the map.
      +
      +
      +
      + +

      +decode

      +
      +public static java.util.Map<?,?> decode(java.lang.String string)
+                                 throws DecodeFailureException
      +
      +
      Decode a protocol string into a key-value map. +

      +

      +
      Parameters:
      string - The string to decode. +
      Returns:
      A key-value map mapping directives to strings, lists and maps. +
      Throws: +
      DecodeFailureException - if the decoding engine returns something other than a map.
      +
      +
      +
      + +

      +responseIsOK

      +
      +public static boolean responseIsOK(java.util.Map<?,?> response)
+                            throws InvalidMessageException
      +
      +
      Check if a response is flagged as having OK status. +

      +

      +
      Parameters:
      response - The response message, as a key-value map (eg in decoded + format). +
      Returns:
      true if the response is flagged with OK status, false if not (eg + ERROR status). +
      Throws: +
      InvalidMessageException - if the response is invalid (eg the status is missing).
      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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/protocol/Status.html b/doc/uk/org/ury/protocol/Status.html new file mode 100644 index 0000000..fb4e4b1 --- /dev/null +++ b/doc/uk/org/ury/protocol/Status.html @@ -0,0 +1,330 @@ + + + + + + +Status + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.protocol +
      +Enum Status

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

      +Statuses that can follow the STATUS directory. +

      + +

      +

      +
      Author:
      +
      Matt Windsor
      +
      +
      + +

      + + + + + + + + + + + + + +
      +Enum Constant Summary
      ERROR + +
      +           
      OK + +
      +           
      +  + + + + + + + + + + + + + + + +
      +Method Summary
      +static StatusvalueOf(java.lang.String name) + +
      +          Returns the enum constant of this type with the specified name.
      +static Status[]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
      + +

      +OK

      +
      +public static final Status OK
      +
      +
      +
      +
      +
      + +

      +ERROR

      +
      +public static final Status ERROR
      +
      +
      +
      +
      + + + + + + + + +
      +Method Detail
      + +

      +values

      +
      +public static Status[] 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 (Status c : Status.values())
+    System.out.println(c);
+
      +

      +

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

      +valueOf

      +
      +public static Status 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/protocol/class-use/Directive.html b/doc/uk/org/ury/protocol/class-use/Directive.html new file mode 100644 index 0000000..556645c --- /dev/null +++ b/doc/uk/org/ury/protocol/class-use/Directive.html @@ -0,0 +1,189 @@ + + + + + + +Uses of Class uk.org.ury.protocol.Directive + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +
      +

      +Uses of Class
      uk.org.ury.protocol.Directive

      +
      + + + + + + + + + +
      +Packages that use Directive
      uk.org.ury.protocol  
      +  +

      + + + + + +
      +Uses of Directive in uk.org.ury.protocol
      +  +

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

      +

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

      +Uses of Class
      uk.org.ury.protocol.ProtocolUtils

      +
      +No usage of uk.org.ury.protocol.ProtocolUtils +

      +

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

      +Uses of Class
      uk.org.ury.protocol.Status

      +
      + + + + + + + + + +
      +Packages that use Status
      uk.org.ury.protocol  
      +  +

      + + + + + +
      +Uses of Status in uk.org.ury.protocol
      +  +

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

      +

      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/protocol/exceptions/DecodeFailureException.html b/doc/uk/org/ury/protocol/exceptions/DecodeFailureException.html new file mode 100644 index 0000000..60358ee --- /dev/null +++ b/doc/uk/org/ury/protocol/exceptions/DecodeFailureException.html @@ -0,0 +1,250 @@ + + + + + + +DecodeFailureException + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.protocol.exceptions +
      +Class DecodeFailureException

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

      +Exception thrown when the protocol decoder fails. +

      + +

      +

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

      + + + + + + + + + + + +
      +Constructor Summary
      DecodeFailureException(java.lang.String reason) + +
      +          Construct a new DecodeFailureException with a reason.
      +  + + + + + + + +
      +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
      + +

      +DecodeFailureException

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

      +

      +
      Parameters:
      reason - The reason for throwing 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/protocol/exceptions/InvalidMessageException.html b/doc/uk/org/ury/protocol/exceptions/InvalidMessageException.html new file mode 100644 index 0000000..9d4eea3 --- /dev/null +++ b/doc/uk/org/ury/protocol/exceptions/InvalidMessageException.html @@ -0,0 +1,251 @@ + + + + + + +InvalidMessageException + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.protocol.exceptions +
      +Class InvalidMessageException

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

      +Generic exception thrown when a protocol function cannot process a + message due to an issue with the message. +

      + +

      +

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

      + + + + + + + + + + + +
      +Constructor Summary
      InvalidMessageException(java.lang.String reason) + +
      +          Construct a new InvalidMessageException with a reason.
      +  + + + + + + + +
      +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
      + +

      +InvalidMessageException

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

      +

      +
      Parameters:
      reason - The reason for throwing 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/protocol/exceptions/class-use/DecodeFailureException.html b/doc/uk/org/ury/protocol/exceptions/class-use/DecodeFailureException.html new file mode 100644 index 0000000..5560a27 --- /dev/null +++ b/doc/uk/org/ury/protocol/exceptions/class-use/DecodeFailureException.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Class uk.org.ury.protocol.exceptions.DecodeFailureException + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +
      +

      +Uses of Class
      uk.org.ury.protocol.exceptions.DecodeFailureException

      +
      + + + + + + + + + + + + + +
      +Packages that use DecodeFailureException
      uk.org.ury.client  
      uk.org.ury.protocol  
      +  +

      + + + + + +
      +Uses of DecodeFailureException in uk.org.ury.client
      +  +

      + + + + + + + + + +
      Methods in uk.org.ury.client that throw DecodeFailureException
      + java.util.Map<?,?>Client.get(java.lang.String file) + +
      +          Get a raw response from the server.
      +  +

      + + + + + +
      +Uses of DecodeFailureException in uk.org.ury.protocol
      +  +

      + + + + + + + + + +
      Methods in uk.org.ury.protocol that throw DecodeFailureException
      +static java.util.Map<?,?>ProtocolUtils.decode(java.lang.String string) + +
      +          Decode a protocol string into a key-value map.
      +  +

      +

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

      +Uses of Class
      uk.org.ury.protocol.exceptions.InvalidMessageException

      +
      + + + + + + + + + + + + + +
      +Packages that use InvalidMessageException
      uk.org.ury.library.viewer  
      uk.org.ury.protocol  
      +  +

      + + + + + +
      +Uses of InvalidMessageException in uk.org.ury.library.viewer
      +  +

      + + + + + + + + + +
      Methods in uk.org.ury.library.viewer that throw InvalidMessageException
      + voidLibraryViewer.doSearch(java.lang.String search) + +
      +          Do a library search.
      +  +

      + + + + + +
      +Uses of InvalidMessageException in uk.org.ury.protocol
      +  +

      + + + + + + + + + +
      Methods in uk.org.ury.protocol that throw InvalidMessageException
      +static booleanProtocolUtils.responseIsOK(java.util.Map<?,?> response) + +
      +          Check if a response is flagged as having OK status.
      +  +

      +

      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/protocol/exceptions/package-frame.html b/doc/uk/org/ury/protocol/exceptions/package-frame.html new file mode 100644 index 0000000..db1d0de --- /dev/null +++ b/doc/uk/org/ury/protocol/exceptions/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +uk.org.ury.protocol.exceptions + + + + + + + + + + + +uk.org.ury.protocol.exceptions + + + + +
      +Exceptions  + +
      +DecodeFailureException +
      +InvalidMessageException
      + + + + diff --git a/doc/uk/org/ury/protocol/exceptions/package-summary.html b/doc/uk/org/ury/protocol/exceptions/package-summary.html new file mode 100644 index 0000000..45e4348 --- /dev/null +++ b/doc/uk/org/ury/protocol/exceptions/package-summary.html @@ -0,0 +1,162 @@ + + + + + + +uk.org.ury.protocol.exceptions + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +

      +Package uk.org.ury.protocol.exceptions +

      + + + + + + + + + + + + + +
      +Exception Summary
      DecodeFailureExceptionException thrown when the protocol decoder fails.
      InvalidMessageExceptionGeneric exception thrown when a protocol function cannot process a + message due to an issue with the message.
      +  + +

      +

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

      +Hierarchy For Package uk.org.ury.protocol.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/protocol/exceptions/package-use.html b/doc/uk/org/ury/protocol/exceptions/package-use.html new file mode 100644 index 0000000..d6b9dea --- /dev/null +++ b/doc/uk/org/ury/protocol/exceptions/package-use.html @@ -0,0 +1,216 @@ + + + + + + +Uses of Package uk.org.ury.protocol.exceptions + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +
      +

      +Uses of Package
      uk.org.ury.protocol.exceptions

      +
      + + + + + + + + + + + + + + + + + +
      +Packages that use uk.org.ury.protocol.exceptions
      uk.org.ury.client  
      uk.org.ury.library.viewer  
      uk.org.ury.protocol  
      +  +

      + + + + + + + + +
      +Classes in uk.org.ury.protocol.exceptions used by uk.org.ury.client
      DecodeFailureException + +
      +          Exception thrown when the protocol decoder fails.
      +  +

      + + + + + + + + +
      +Classes in uk.org.ury.protocol.exceptions used by uk.org.ury.library.viewer
      InvalidMessageException + +
      +          Generic exception thrown when a protocol function cannot process a + message due to an issue with the message.
      +  +

      + + + + + + + + + + + +
      +Classes in uk.org.ury.protocol.exceptions used by uk.org.ury.protocol
      DecodeFailureException + +
      +          Exception thrown when the protocol decoder fails.
      InvalidMessageException + +
      +          Generic exception thrown when a protocol function cannot process a + message due to an issue with the message.
      +  +

      +

      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/protocol/package-frame.html b/doc/uk/org/ury/protocol/package-frame.html new file mode 100644 index 0000000..c1b7dea --- /dev/null +++ b/doc/uk/org/ury/protocol/package-frame.html @@ -0,0 +1,45 @@ + + + + + + +uk.org.ury.protocol + + + + + + + + + + + +uk.org.ury.protocol + + + + +
      +Classes  + +
      +ProtocolUtils
      + + + + + + +
      +Enums  + +
      +Directive +
      +Status
      + + + + diff --git a/doc/uk/org/ury/protocol/package-summary.html b/doc/uk/org/ury/protocol/package-summary.html new file mode 100644 index 0000000..b4dc33b --- /dev/null +++ b/doc/uk/org/ury/protocol/package-summary.html @@ -0,0 +1,176 @@ + + + + + + +uk.org.ury.protocol + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +

      +Package uk.org.ury.protocol +

      + + + + + + + + + +
      +Class Summary
      ProtocolUtilsUtilities for converting between strings encoded in the response protocol and + collections of items, as well as validating and unpicking protocol messages.
      +  + +

      + + + + + + + + + + + + + +
      +Enum Summary
      DirectiveDirectives supported by the protocol.
      StatusStatuses that can follow the STATUS directory.
      +  + +

      +

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

      +Hierarchy For Package uk.org.ury.protocol +

      +
      +
      +
      Package Hierarchies:
      All Packages
      +
      +

      +Class Hierarchy +

      + +

      +Enum Hierarchy +

      +
        +
      • java.lang.Object
          +
        • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        +
      +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/protocol/package-use.html b/doc/uk/org/ury/protocol/package-use.html new file mode 100644 index 0000000..16b3f92 --- /dev/null +++ b/doc/uk/org/ury/protocol/package-use.html @@ -0,0 +1,176 @@ + + + + + + +Uses of Package uk.org.ury.protocol + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +
      +

      +Uses of Package
      uk.org.ury.protocol

      +
      + + + + + + + + + +
      +Packages that use uk.org.ury.protocol
      uk.org.ury.protocol  
      +  +

      + + + + + + + + + + + +
      +Classes in uk.org.ury.protocol used by uk.org.ury.protocol
      Directive + +
      +          Directives supported by the protocol.
      Status + +
      +          Statuses that can follow the STATUS directory.
      +  +

      +

      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/server/RequestHandler.html b/doc/uk/org/ury/server/RequestHandler.html new file mode 100644 index 0000000..5aa1e29 --- /dev/null +++ b/doc/uk/org/ury/server/RequestHandler.html @@ -0,0 +1,238 @@ + + + + + + +RequestHandler + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.server +
      +Interface RequestHandler

      +
      +
      All Known Implementing Classes:
      LibraryRequestHandler, ServerRequestHandler
      +
      +
      +
      +
      public interface RequestHandler
      + + +

      +Interface for classes that can handle requests addressed to their + class name from the main server. + + For an example of how to implement a RequestHandler, see + ServerRequestHandler. +

      + +

      +

      +
      Author:
      +
      Matt Windsor
      +
      +
      + +

      + + + + + + + + + + + + +
      +Method Summary
      + java.util.Map<java.lang.String,java.lang.Object>handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, + Server server) + +
      +          Handle a server GET request (that is, a request for data + output).
      +  +

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

      +handleGetRequest

      +
      +java.util.Map<java.lang.String,java.lang.Object> handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters,
+                                                                  Server server)
+                                                                  throws HandleFailureException
      +
      +
      Handle a server GET request (that is, a request for data + output). +

      +

      +
      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 series of key-value pairs to pass back to + the client. +
      Throws: +
      HandleFailureException - if the handler cannot + handle the request.
      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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/server/Server.html b/doc/uk/org/ury/server/Server.html new file mode 100644 index 0000000..abb6497 --- /dev/null +++ b/doc/uk/org/ury/server/Server.html @@ -0,0 +1,425 @@ + + + + + + +Server + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.server +
      +Class Server

      +
      +java.lang.Object
+  extended by uk.org.ury.server.Server
+
      +
      +
      +
      public class Server
      extends java.lang.Object
      + + +

      +The unified URY server, accepting requests over HTTP. +

      + +

      +

      +
      Author:
      +
      Matt Windsor
      +
      +
      + +

      + + + + + + + + + + + +
      +Constructor Summary
      Server() + +
      +           
      +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +Method Summary
      + voiddoConnection(java.net.Socket clientSocket) + +
      +           
      + DatabaseDrivergetDatabaseConnection(UserClass userClass) + +
      +          Get a database connection using the given user class.
      + java.lang.StringgetVersion() + +
      +           
      + org.apache.http.HttpResponsehandleGet(java.util.List<java.lang.String> buffer) + +
      +          Handle a HTTP GET request.
      +static voidmain(java.lang.String[] args) + +
      +          The main method, which serves to create a server.
      + java.util.Map<java.lang.String,java.lang.String>parseQueryString(java.lang.String query) + +
      +          Parse a query string, populating a key-value map of the + URL-unescaped results.
      + voidprocessBuffer(java.util.List<java.lang.String> buffer, + java.io.PrintWriter out) + +
      +           
      +  + + + + + + + +
      Methods inherited from class java.lang.Object
      equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      +  +

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

      +Server

      +
      +public Server()
      +
      +
      + + + + + + + + +
      +Method Detail
      + +

      +main

      +
      +public static void main(java.lang.String[] args)
      +
      +
      The main method, which serves to create a server. +

      +

      +
      Parameters:
      args - The argument vector.
      +
      +
      +
      + +

      +doConnection

      +
      +public void doConnection(java.net.Socket clientSocket)
+                  throws java.io.IOException
      +
      +
      + +
      Throws: +
      java.io.IOException
      +
      +
      +
      + +

      +processBuffer

      +
      +public void processBuffer(java.util.List<java.lang.String> buffer,
+                          java.io.PrintWriter out)
      +
      +
      +
      +
      +
      +
      + +

      +handleGet

      +
      +public org.apache.http.HttpResponse handleGet(java.util.List<java.lang.String> buffer)
+                                       throws HandlerNotFoundException,
+                                              HandlerSetupFailureException,
+                                              HandleFailureException,
+                                              BadRequestException,
+                                              NotAHandlerException
      +
      +
      Handle a HTTP GET request. +

      +

      +
      Parameters:
      buffer - The HTTP request as a list of strings. +
      Returns:
      The HTTP response. +
      Throws: +
      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.
      +
      +
      +
      + +

      +parseQueryString

      +
      +public java.util.Map<java.lang.String,java.lang.String> parseQueryString(java.lang.String query)
+                                                                  throws java.io.UnsupportedEncodingException
      +
      +
      Parse a query string, populating a key-value map of the + URL-unescaped results. +

      +

      +
      Parameters:
      query - The query string to parse. +
      Returns:
      A map associating parameter keys and values. +
      Throws: +
      java.io.UnsupportedEncodingException - if the URL decoder + fails.
      +
      +
      +
      + +

      +getDatabaseConnection

      +
      +public DatabaseDriver getDatabaseConnection(UserClass userClass)
+                                     throws MissingCredentialsException,
+                                            ConnectionFailureException
      +
      +
      Get a database connection using the given user class. +

      +

      +
      Parameters:
      userClass - The user class to get a connection for. +
      Returns:
      a database connection, which may or may not + have been created on this call. +
      Throws: +
      MissingCredentialsException - if the credentials + for the given userclass are missing. +
      ConnectionFailureException - if the connection + failed.
      +
      +
      +
      + +

      +getVersion

      +
      +public java.lang.String getVersion()
      +
      +
      + +
      Returns:
      the version string of the server.
      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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/server/ServerProtocol.html b/doc/uk/org/ury/server/ServerProtocol.html new file mode 100644 index 0000000..1014c96 --- /dev/null +++ b/doc/uk/org/ury/server/ServerProtocol.html @@ -0,0 +1,314 @@ + + + + + + +ServerProtocol + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.server +
      +Class ServerProtocol

      +
      +java.lang.Object
+  extended by uk.org.ury.server.ServerProtocol
+
      +
      +
      +
      public class ServerProtocol
      extends java.lang.Object
      + + +

      +The BAPS server protocol (a minimal implementation of HTTP 1.1) handler. +

      + +

      +

      +
      Author:
      +
      Matt Windsor
      +
      +
      + +

      + + + + + + + + + + + + + + + +
      +Field Summary
      + java.util.List<java.lang.String>buffer + +
      +           
      +static java.lang.StringGET_HEADER + +
      +           
      +  + + + + + + + + + + +
      +Constructor Summary
      ServerProtocol() + +
      +           
      +  + + + + + + + + + + + +
      +Method Summary
      + java.lang.StringprocessInput(java.lang.String string) + +
      +           
      +  + + + + + + + +
      Methods inherited from class java.lang.Object
      equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      +  +

      + + + + + + + + +
      +Field Detail
      + +

      +GET_HEADER

      +
      +public static final java.lang.String GET_HEADER
      +
      +
      +
      See Also:
      Constant Field Values
      +
      +
      + +

      +buffer

      +
      +public java.util.List<java.lang.String> buffer
      +
      +
      +
      +
      + + + + + + + + +
      +Constructor Detail
      + +

      +ServerProtocol

      +
      +public ServerProtocol()
      +
      +
      + + + + + + + + +
      +Method Detail
      + +

      +processInput

      +
      +public java.lang.String processInput(java.lang.String string)
      +
      +
      +
      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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/server/ServerRequestHandler.html b/doc/uk/org/ury/server/ServerRequestHandler.html new file mode 100644 index 0000000..c2d61bc --- /dev/null +++ b/doc/uk/org/ury/server/ServerRequestHandler.html @@ -0,0 +1,283 @@ + + + + + + +ServerRequestHandler + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.server +
      +Class ServerRequestHandler

      +
      +java.lang.Object
+  extended by uk.org.ury.server.ServerRequestHandler
+
      +
      +
      All Implemented Interfaces:
      RequestHandler
      +
      +
      +
      +
      public class ServerRequestHandler
      extends java.lang.Object
      implements RequestHandler
      + + +

      +A request handler for server queries. +

      + +

      +

      +
      Author:
      +
      Matt Windsor
      +
      +
      + +

      + + + + + + + + + + + +
      +Constructor Summary
      ServerRequestHandler() + +
      +           
      +  + + + + + + + + + + + +
      +Method Summary
      + java.util.Map<java.lang.String,java.lang.Object>handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, + Server server) + +
      +          Handle a server GET request (that is, a request for data + output).
      +  + + + + + + + +
      Methods inherited from class java.lang.Object
      equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      +  +

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

      +ServerRequestHandler

      +
      +public ServerRequestHandler()
      +
      +
      + + + + + + + + +
      +Method Detail
      + +

      +handleGetRequest

      +
      +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
      +
      +
      Handle a server GET request (that is, a request for data + output). +

      +

      +
      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. +
      Throws: +
      HandleFailureException - if the handler cannot + handle the request.
      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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/server/class-use/RequestHandler.html b/doc/uk/org/ury/server/class-use/RequestHandler.html new file mode 100644 index 0000000..a84af84 --- /dev/null +++ b/doc/uk/org/ury/server/class-use/RequestHandler.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Interface uk.org.ury.server.RequestHandler + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +
      +

      +Uses of Interface
      uk.org.ury.server.RequestHandler

      +
      + + + + + + + + + + + + + +
      +Packages that use RequestHandler
      uk.org.ury.library  
      uk.org.ury.server  
      +  +

      + + + + + +
      +Uses of RequestHandler in uk.org.ury.library
      +  +

      + + + + + + + + + +
      Classes in uk.org.ury.library that implement RequestHandler
      + classLibraryRequestHandler + +
      +          A request handler for library queries.
      +  +

      + + + + + +
      +Uses of RequestHandler in uk.org.ury.server
      +  +

      + + + + + + + + + +
      Classes in uk.org.ury.server that implement RequestHandler
      + classServerRequestHandler + +
      +          A request handler for server queries.
      +  +

      +

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

      +Uses of Class
      uk.org.ury.server.Server

      +
      + + + + + + + + + + + + + +
      +Packages that use Server
      uk.org.ury.library  
      uk.org.ury.server  
      +  +

      + + + + + +
      +Uses of Server in uk.org.ury.library
      +  +

      + + + + + + + + + +
      Methods in uk.org.ury.library with parameters of type Server
      + java.util.Map<java.lang.String,java.lang.Object>LibraryRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, + Server server) + +
      +          Handle a server GET request (that is, a request for data + output).
      +  +

      + + + + + +
      +Uses of Server in uk.org.ury.server
      +  +

      + + + + + + + + + + + + + +
      Methods in uk.org.ury.server with parameters of type Server
      + java.util.Map<java.lang.String,java.lang.Object>ServerRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, + Server server) + +
      +          Handle a server GET request (that is, a request for data + output).
      + java.util.Map<java.lang.String,java.lang.Object>RequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, + Server server) + +
      +          Handle a server GET request (that is, a request for data + output).
      +  +

      +

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

      +Uses of Class
      uk.org.ury.server.ServerProtocol

      +
      +No usage of uk.org.ury.server.ServerProtocol +

      +

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

      +Uses of Class
      uk.org.ury.server.ServerRequestHandler

      +
      +No usage of uk.org.ury.server.ServerRequestHandler +

      +

      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/server/exceptions/BadRequestException.html b/doc/uk/org/ury/server/exceptions/BadRequestException.html new file mode 100644 index 0000000..2c17ab1 --- /dev/null +++ b/doc/uk/org/ury/server/exceptions/BadRequestException.html @@ -0,0 +1,271 @@ + + + + + + +BadRequestException + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.server.exceptions +
      +Class BadRequestException

      +
      +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.server.exceptions.HandlingException
+              extended by uk.org.ury.server.exceptions.BadRequestException
+
      +
      +
      All Implemented Interfaces:
      java.io.Serializable
      +
      +
      +
      +
      public class BadRequestException
      extends HandlingException
      + + +

      +Exception thrown when the server meets a malformed request, or + part of one. +

      + +

      +

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

      + + + + + + + + + + + + + + +
      +Constructor Summary
      BadRequestException() + +
      +          Construct a new BadRequestException with a default reason.
      BadRequestException(java.lang.Throwable cause) + +
      +          Construct a new HandlerNotFoundException with a chained + exception.
      +  + + + + + + + +
      +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
      + +

      +BadRequestException

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

      +

      +
      + +

      +BadRequestException

      +
      +public BadRequestException(java.lang.Throwable cause)
      +
      +
      Construct a new HandlerNotFoundException with a chained + exception. +

      +

      +
      Parameters:
      cause - The exception that this new exception is to + wrap.
      +
      + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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/server/exceptions/HandleFailureException.html b/doc/uk/org/ury/server/exceptions/HandleFailureException.html new file mode 100644 index 0000000..2daa29c --- /dev/null +++ b/doc/uk/org/ury/server/exceptions/HandleFailureException.html @@ -0,0 +1,270 @@ + + + + + + +HandleFailureException + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.server.exceptions +
      +Class HandleFailureException

      +
      +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.server.exceptions.HandlingException
+              extended by uk.org.ury.server.exceptions.HandleFailureException
+
      +
      +
      All Implemented Interfaces:
      java.io.Serializable
      +
      +
      +
      +
      public class HandleFailureException
      extends HandlingException
      + + +

      +Generic exception thrown when a server request handler fails to + handle a request. +

      + +

      +

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

      + + + + + + + + + + + + + + +
      +Constructor Summary
      HandleFailureException() + +
      +          Construct a new HandleFailureException with a + default reason.
      HandleFailureException(java.lang.String reason) + +
      +          Construct a new HandleFailureException.
      +  + + + + + + + +
      +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
      + +

      +HandleFailureException

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

      +

      +
      + +

      +HandleFailureException

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

      +

      +
      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/server/exceptions/HandlerNotFoundException.html b/doc/uk/org/ury/server/exceptions/HandlerNotFoundException.html new file mode 100644 index 0000000..01b72bf --- /dev/null +++ b/doc/uk/org/ury/server/exceptions/HandlerNotFoundException.html @@ -0,0 +1,275 @@ + + + + + + +HandlerNotFoundException + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.server.exceptions +
      +Class HandlerNotFoundException

      +
      +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.server.exceptions.HandlingException
+              extended by uk.org.ury.server.exceptions.HandlerNotFoundException
+
      +
      +
      All Implemented Interfaces:
      java.io.Serializable
      +
      +
      +
      +
      public class HandlerNotFoundException
      extends HandlingException
      + + +

      +Exception thrown when the server request handler requested + by the client is not * found in the class space. +

      + +

      +

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

      + + + + + + + + + + + + + + +
      +Constructor Summary
      HandlerNotFoundException() + +
      +          Construct a new HandlerNotFoundException with a + default reason.
      HandlerNotFoundException(java.lang.String className, + java.lang.Throwable cause) + +
      +          Construct a new HandlerNotFoundException with a class name and + chained exception.
      +  + + + + + + + +
      +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
      + +

      +HandlerNotFoundException

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

      +

      +
      + +

      +HandlerNotFoundException

      +
      +public HandlerNotFoundException(java.lang.String className,
+                                java.lang.Throwable cause)
      +
      +
      Construct a new HandlerNotFoundException with a class name and + chained exception. +

      +

      +
      Parameters:
      className - The name of the missing handler class.
      cause - The exception that this new exception is to + wrap.
      +
      + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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/server/exceptions/HandlerSetupFailureException.html b/doc/uk/org/ury/server/exceptions/HandlerSetupFailureException.html new file mode 100644 index 0000000..8b863f9 --- /dev/null +++ b/doc/uk/org/ury/server/exceptions/HandlerSetupFailureException.html @@ -0,0 +1,278 @@ + + + + + + +HandlerSetupFailureException + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.server.exceptions +
      +Class HandlerSetupFailureException

      +
      +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.server.exceptions.HandlingException
+              extended by uk.org.ury.server.exceptions.HandlerSetupFailureException
+
      +
      +
      All Implemented Interfaces:
      java.io.Serializable
      +
      +
      +
      +
      public class HandlerSetupFailureException
      extends HandlingException
      + + +

      +Exception thrown when the server request handler requested + by the client cannot be set up to process the request. +

      + +

      +

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

      + + + + + + + + + + + + + + +
      +Constructor Summary
      HandlerSetupFailureException() + +
      +          Construct a new HandlerNotFoundException with a + default reason.
      HandlerSetupFailureException(java.lang.String className, + java.lang.Throwable cause) + +
      +          Construct a new HandlerSetupFailureException with a class name + and chained exception.
      +  + + + + + + + +
      +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
      + +

      +HandlerSetupFailureException

      +
      +public HandlerSetupFailureException()
      +
      +
      Construct a new HandlerNotFoundException with a + default reason. +

      +

      +
      + +

      +HandlerSetupFailureException

      +
      +public HandlerSetupFailureException(java.lang.String className,
+                                    java.lang.Throwable cause)
      +
      +
      Construct a new HandlerSetupFailureException with a class name + and chained exception. + + Use this to hide exception specifics from higher abstraction + layers. +

      +

      +
      Parameters:
      className - The name of the failed handler class.
      cause - The exception that this new exception is to + wrap.
      +
      + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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/server/exceptions/HandlingException.html b/doc/uk/org/ury/server/exceptions/HandlingException.html new file mode 100644 index 0000000..3cc3042 --- /dev/null +++ b/doc/uk/org/ury/server/exceptions/HandlingException.html @@ -0,0 +1,275 @@ + + + + + + +HandlingException + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.server.exceptions +
      +Class HandlingException

      +
      +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.server.exceptions.HandlingException
+
      +
      +
      All Implemented Interfaces:
      java.io.Serializable
      +
      +
      +
      Direct Known Subclasses:
      BadRequestException, HandleFailureException, HandlerNotFoundException, HandlerSetupFailureException, NotAHandlerException
      +
      +
      +
      +
      public class HandlingException
      extends java.lang.Exception
      + + +

      +Generic exception thrown when the server cannot handle a request. +

      + +

      +

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

      + + + + + + + + + + + + + + +
      +Constructor Summary
      HandlingException(java.lang.String string) + +
      +          Construct a HandlingException with a reason.
      HandlingException(java.lang.String string, + java.lang.Throwable cause) + +
      +          Construct a HandlingException with a reason and a cause to + chain.
      +  + + + + + + + +
      +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
      + +

      +HandlingException

      +
      +public HandlingException(java.lang.String string)
      +
      +
      Construct a HandlingException with a reason. +

      +

      +
      Parameters:
      string - The reason to present.
      +
      +
      + +

      +HandlingException

      +
      +public HandlingException(java.lang.String string,
+                         java.lang.Throwable cause)
      +
      +
      Construct a HandlingException with a reason and a cause to + chain. +

      +

      +
      Parameters:
      string - The reason to present.
      cause - The thrown cause that this exception should wrap.
      +
      + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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/server/exceptions/NotAHandlerException.html b/doc/uk/org/ury/server/exceptions/NotAHandlerException.html new file mode 100644 index 0000000..bab0a9d --- /dev/null +++ b/doc/uk/org/ury/server/exceptions/NotAHandlerException.html @@ -0,0 +1,254 @@ + + + + + + +NotAHandlerException + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.server.exceptions +
      +Class NotAHandlerException

      +
      +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.server.exceptions.HandlingException
+              extended by uk.org.ury.server.exceptions.NotAHandlerException
+
      +
      +
      All Implemented Interfaces:
      java.io.Serializable
      +
      +
      +
      +
      public class NotAHandlerException
      extends HandlingException
      + + +

      +Exception thrown if the class requested as a handler by the client + is, in fact, not a handler (it does not implement RequestHandler). +

      + +

      +

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

      + + + + + + + + + + + +
      +Constructor Summary
      NotAHandlerException(java.lang.String className) + +
      +          Construct a NotAHandlerException with the name of the class that + is not a handler.
      +  + + + + + + + +
      +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
      + +

      +NotAHandlerException

      +
      +public NotAHandlerException(java.lang.String className)
      +
      +
      Construct a NotAHandlerException with the name of the class that + is not a handler. +

      +

      +
      Parameters:
      className - The name of the offending class.
      +
      + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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/server/exceptions/class-use/BadRequestException.html b/doc/uk/org/ury/server/exceptions/class-use/BadRequestException.html new file mode 100644 index 0000000..5b6157e --- /dev/null +++ b/doc/uk/org/ury/server/exceptions/class-use/BadRequestException.html @@ -0,0 +1,180 @@ + + + + + + +Uses of Class uk.org.ury.server.exceptions.BadRequestException + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +
      +

      +Uses of Class
      uk.org.ury.server.exceptions.BadRequestException

      +
      + + + + + + + + + +
      +Packages that use BadRequestException
      uk.org.ury.server  
      +  +

      + + + + + +
      +Uses of BadRequestException in uk.org.ury.server
      +  +

      + + + + + + + + + +
      Methods in uk.org.ury.server that throw BadRequestException
      + org.apache.http.HttpResponseServer.handleGet(java.util.List<java.lang.String> buffer) + +
      +          Handle a HTTP GET request.
      +  +

      +

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

      +Uses of Class
      uk.org.ury.server.exceptions.HandleFailureException

      +
      + + + + + + + + + + + + + +
      +Packages that use HandleFailureException
      uk.org.ury.library  
      uk.org.ury.server  
      +  +

      + + + + + +
      +Uses of HandleFailureException in uk.org.ury.library
      +  +

      + + + + + + + + + +
      Methods in uk.org.ury.library that throw HandleFailureException
      + java.util.Map<java.lang.String,java.lang.Object>LibraryRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, + Server server) + +
      +          Handle a server GET request (that is, a request for data + output).
      +  +

      + + + + + +
      +Uses of HandleFailureException in uk.org.ury.server
      +  +

      + + + + + + + + + + + + + + + + + +
      Methods in uk.org.ury.server that throw HandleFailureException
      + org.apache.http.HttpResponseServer.handleGet(java.util.List<java.lang.String> buffer) + +
      +          Handle a HTTP GET request.
      + java.util.Map<java.lang.String,java.lang.Object>ServerRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, + Server server) + +
      +          Handle a server GET request (that is, a request for data + output).
      + java.util.Map<java.lang.String,java.lang.Object>RequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, + Server server) + +
      +          Handle a server GET request (that is, a request for data + output).
      +  +

      +

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

      +Uses of Class
      uk.org.ury.server.exceptions.HandlerNotFoundException

      +
      + + + + + + + + + +
      +Packages that use HandlerNotFoundException
      uk.org.ury.server  
      +  +

      + + + + + +
      +Uses of HandlerNotFoundException in uk.org.ury.server
      +  +

      + + + + + + + + + +
      Methods in uk.org.ury.server that throw HandlerNotFoundException
      + org.apache.http.HttpResponseServer.handleGet(java.util.List<java.lang.String> buffer) + +
      +          Handle a HTTP GET request.
      +  +

      +

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

      +Uses of Class
      uk.org.ury.server.exceptions.HandlerSetupFailureException

      +
      + + + + + + + + + +
      +Packages that use HandlerSetupFailureException
      uk.org.ury.server  
      +  +

      + + + + + +
      +Uses of HandlerSetupFailureException in uk.org.ury.server
      +  +

      + + + + + + + + + +
      Methods in uk.org.ury.server that throw HandlerSetupFailureException
      + org.apache.http.HttpResponseServer.handleGet(java.util.List<java.lang.String> buffer) + +
      +          Handle a HTTP GET request.
      +  +

      +

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

      +Uses of Class
      uk.org.ury.server.exceptions.HandlingException

      +
      + + + + + + + + + +
      +Packages that use HandlingException
      uk.org.ury.server.exceptions  
      +  +

      + + + + + +
      +Uses of HandlingException in uk.org.ury.server.exceptions
      +  +

      + + + + + + + + + + + + + + + + + + + + + + + + + +
      Subclasses of HandlingException in uk.org.ury.server.exceptions
      + classBadRequestException + +
      +          Exception thrown when the server meets a malformed request, or + part of one.
      + classHandleFailureException + +
      +          Generic exception thrown when a server request handler fails to + handle a request.
      + classHandlerNotFoundException + +
      +          Exception thrown when the server request handler requested + by the client is not * found in the class space.
      + classHandlerSetupFailureException + +
      +          Exception thrown when the server request handler requested + by the client cannot be set up to process the request.
      + classNotAHandlerException + +
      +          Exception thrown if the class requested as a handler by the client + is, in fact, not a handler (it does not implement RequestHandler).
      +  +

      +

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

      +Uses of Class
      uk.org.ury.server.exceptions.NotAHandlerException

      +
      + + + + + + + + + +
      +Packages that use NotAHandlerException
      uk.org.ury.server  
      +  +

      + + + + + +
      +Uses of NotAHandlerException in uk.org.ury.server
      +  +

      + + + + + + + + + +
      Methods in uk.org.ury.server that throw NotAHandlerException
      + org.apache.http.HttpResponseServer.handleGet(java.util.List<java.lang.String> buffer) + +
      +          Handle a HTTP GET request.
      +  +

      +

      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/server/exceptions/package-frame.html b/doc/uk/org/ury/server/exceptions/package-frame.html new file mode 100644 index 0000000..4a740da --- /dev/null +++ b/doc/uk/org/ury/server/exceptions/package-frame.html @@ -0,0 +1,42 @@ + + + + + + +uk.org.ury.server.exceptions + + + + + + + + + + + +uk.org.ury.server.exceptions + + + + +
      +Exceptions  + +
      +BadRequestException +
      +HandleFailureException +
      +HandlerNotFoundException +
      +HandlerSetupFailureException +
      +HandlingException +
      +NotAHandlerException
      + + + + diff --git a/doc/uk/org/ury/server/exceptions/package-summary.html b/doc/uk/org/ury/server/exceptions/package-summary.html new file mode 100644 index 0000000..6687b8c --- /dev/null +++ b/doc/uk/org/ury/server/exceptions/package-summary.html @@ -0,0 +1,182 @@ + + + + + + +uk.org.ury.server.exceptions + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +

      +Package uk.org.ury.server.exceptions +

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +Exception Summary
      BadRequestExceptionException thrown when the server meets a malformed request, or + part of one.
      HandleFailureExceptionGeneric exception thrown when a server request handler fails to + handle a request.
      HandlerNotFoundExceptionException thrown when the server request handler requested + by the client is not * found in the class space.
      HandlerSetupFailureExceptionException thrown when the server request handler requested + by the client cannot be set up to process the request.
      HandlingExceptionGeneric exception thrown when the server cannot handle a request.
      NotAHandlerExceptionException thrown if the class requested as a handler by the client + is, in fact, not a handler (it does not implement RequestHandler).
      +  + +

      +

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

      +Hierarchy For Package uk.org.ury.server.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/server/exceptions/package-use.html b/doc/uk/org/ury/server/exceptions/package-use.html new file mode 100644 index 0000000..44ad46a --- /dev/null +++ b/doc/uk/org/ury/server/exceptions/package-use.html @@ -0,0 +1,238 @@ + + + + + + +Uses of Package uk.org.ury.server.exceptions + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +
      +

      +Uses of Package
      uk.org.ury.server.exceptions

      +
      + + + + + + + + + + + + + + + + + +
      +Packages that use uk.org.ury.server.exceptions
      uk.org.ury.library  
      uk.org.ury.server  
      uk.org.ury.server.exceptions  
      +  +

      + + + + + + + + +
      +Classes in uk.org.ury.server.exceptions used by uk.org.ury.library
      HandleFailureException + +
      +          Generic exception thrown when a server request handler fails to + handle a request.
      +  +

      + + + + + + + + + + + + + + + + + + + + +
      +Classes in uk.org.ury.server.exceptions used by uk.org.ury.server
      BadRequestException + +
      +          Exception thrown when the server meets a malformed request, or + part of one.
      HandleFailureException + +
      +          Generic exception thrown when a server request handler fails to + handle a request.
      HandlerNotFoundException + +
      +          Exception thrown when the server request handler requested + by the client is not * found in the class space.
      HandlerSetupFailureException + +
      +          Exception thrown when the server request handler requested + by the client cannot be set up to process the request.
      NotAHandlerException + +
      +          Exception thrown if the class requested as a handler by the client + is, in fact, not a handler (it does not implement RequestHandler).
      +  +

      + + + + + + + + +
      +Classes in uk.org.ury.server.exceptions used by uk.org.ury.server.exceptions
      HandlingException + +
      +          Generic exception thrown when the server cannot handle a request.
      +  +

      +

      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/server/package-frame.html b/doc/uk/org/ury/server/package-frame.html new file mode 100644 index 0000000..4385631 --- /dev/null +++ b/doc/uk/org/ury/server/package-frame.html @@ -0,0 +1,47 @@ + + + + + + +uk.org.ury.server + + + + + + + + + + + +uk.org.ury.server + + + + +
      +Interfaces  + +
      +RequestHandler
      + + + + + + +
      +Classes  + +
      +Server +
      +ServerProtocol +
      +ServerRequestHandler
      + + + + diff --git a/doc/uk/org/ury/server/package-summary.html b/doc/uk/org/ury/server/package-summary.html new file mode 100644 index 0000000..9c9a7e4 --- /dev/null +++ b/doc/uk/org/ury/server/package-summary.html @@ -0,0 +1,180 @@ + + + + + + +uk.org.ury.server + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +

      +Package uk.org.ury.server +

      + + + + + + + + + +
      +Interface Summary
      RequestHandlerInterface for classes that can handle requests addressed to their + class name from the main server.
      +  + +

      + + + + + + + + + + + + + + + + + +
      +Class Summary
      ServerThe unified URY server, accepting requests over HTTP.
      ServerProtocolThe BAPS server protocol (a minimal implementation of HTTP 1.1) handler.
      ServerRequestHandlerA request handler for server queries.
      +  + +

      +

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

      +Hierarchy For Package uk.org.ury.server +

      +
      +
      +
      Package Hierarchies:
      All Packages
      +
      +

      +Class Hierarchy +

      + +

      +Interface Hierarchy +

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

      +Uses of Package
      uk.org.ury.server

      +
      + + + + + + + + + + + + + +
      +Packages that use uk.org.ury.server
      uk.org.ury.library  
      uk.org.ury.server  
      +  +

      + + + + + + + + + + + +
      +Classes in uk.org.ury.server used by uk.org.ury.library
      RequestHandler + +
      +          Interface for classes that can handle requests addressed to their + class name from the main server.
      Server + +
      +          The unified URY server, accepting requests over HTTP.
      +  +

      + + + + + + + + + + + +
      +Classes in uk.org.ury.server used by uk.org.ury.server
      RequestHandler + +
      +          Interface for classes that can handle requests addressed to their + class name from the main server.
      Server + +
      +          The unified URY server, accepting requests over HTTP.
      +  +

      +

      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/show/ShowChannel.html b/doc/uk/org/ury/show/ShowChannel.html index 823b279..d04bb5f 100644 --- a/doc/uk/org/ury/show/ShowChannel.html +++ b/doc/uk/org/ury/show/ShowChannel.html @@ -2,12 +2,12 @@ - + ShowChannel - + @@ -56,7 +56,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS       FRAMES    NO FRAMES   @@ -144,8 +144,8 @@ A channel of ShowItems in a show.  void -add(int index, - ShowItem item) +add(int index, + ShowItem item)
                Add a new item to the channel. @@ -153,14 +153,14 @@ A channel of ShowItems in a show.  void -add(ShowItem item) +add(ShowItem item)
                Add a new item to the end of the channel. - ShowItem + ShowItem       get(int index)
      @@ -233,11 +233,11 @@ public ShowChannel() -

      +

      add

       public void add(int index,
-                ShowItem item)
      + ShowItem item)
      Add a new item to the channel.

      @@ -251,10 +251,10 @@ public void add(int index,

      -

      +

      add

      -public void add(ShowItem item)
      +public void add(ShowItem item)
      Add a new item to the end of the channel.

      @@ -267,7 +267,7 @@ public void add(

      get

      -public ShowItem get(int index)
      +public ShowItem get(int index)
      Retrieve an item from the channel.

      @@ -337,7 +337,7 @@ public int getSize()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/show/ShowUtils.html b/doc/uk/org/ury/show/ShowUtils.html index 67b3d0f..c4bd122 100644 --- a/doc/uk/org/ury/show/ShowUtils.html +++ b/doc/uk/org/ury/show/ShowUtils.html @@ -2,12 +2,12 @@ - + ShowUtils - + @@ -55,7 +55,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -157,7 +157,7 @@ A set of common utility routines to facilitate the extraction of -static java.util.List<ShowItem> +static java.util.List<ShowItem> getChannelList(DatabaseDriver db, int showID, int channel) @@ -263,7 +263,7 @@ public static java.util.List<java.lang.String> getPublicFolders(

      getChannelList

      -public static java.util.List<ShowItem> getChannelList(DatabaseDriver db,
+public static java.util.List<ShowItem> getChannelList(DatabaseDriver db,
                                                       int showID,
                                                       int channel)
                                                throws QueryFailureException
      @@ -315,7 +315,7 @@ public static java.util.List< - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   diff --git a/doc/uk/org/ury/show/class-use/ShowChannel.html b/doc/uk/org/ury/show/class-use/ShowChannel.html index 0a55ca7..bbf6194 100644 --- a/doc/uk/org/ury/show/class-use/ShowChannel.html +++ b/doc/uk/org/ury/show/class-use/ShowChannel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.ShowChannel - + diff --git a/doc/uk/org/ury/show/class-use/ShowUtils.html b/doc/uk/org/ury/show/class-use/ShowUtils.html index 729352d..8dc38f1 100644 --- a/doc/uk/org/ury/show/class-use/ShowUtils.html +++ b/doc/uk/org/ury/show/class-use/ShowUtils.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.ShowUtils - + diff --git a/doc/uk/org/ury/show/item/ShowItem.html b/doc/uk/org/ury/show/item/ShowItem.html new file mode 100644 index 0000000..5c48bf4 --- /dev/null +++ b/doc/uk/org/ury/show/item/ShowItem.html @@ -0,0 +1,278 @@ + + + + + + +ShowItem + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.show.item +
      +Class ShowItem

      +
      +java.lang.Object
+  extended by uk.org.ury.database.DatabaseItem<ShowItemProperty,java.lang.String>
+      extended by uk.org.ury.show.item.ShowItem
+
      +
      +
      +
      public class ShowItem
      extends DatabaseItem<ShowItemProperty,java.lang.String>
      + + +

      +An item in the show database. +

      + +

      +

      +
      Author:
      +
      Matt Windsor
      +
      +
      + +

      + + + + + + + + + + + +
      +Constructor Summary
      ShowItem(java.util.Map<ShowItemProperty,java.lang.String> properties) + +
      +          Construct a new ShowItem.
      +  + + + + + + + + + + + +
      +Method Summary
      + java.lang.StringtoString() + +
      +           
      +  + + + + + + + +
      Methods inherited from class uk.org.ury.database.DatabaseItem
      asResponse, get, has
      +  + + + + + + + +
      Methods inherited from class java.lang.Object
      equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
      +  +

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

      +ShowItem

      +
      +public ShowItem(java.util.Map<ShowItemProperty,java.lang.String> properties)
      +
      +
      Construct a new ShowItem. +

      +

      +
      Parameters:
      properties - The map of properties to store in the show item.
      +
      + + + + + + + + +
      +Method Detail
      + +

      +toString

      +
      +public java.lang.String toString()
      +
      +
      +
      Overrides:
      toString in class java.lang.Object
      +
      +
      + +
      Returns:
      a string representation of the ShowItem.
      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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/show/item/ShowItemProperty.html b/doc/uk/org/ury/show/item/ShowItemProperty.html new file mode 100644 index 0000000..35cb996 --- /dev/null +++ b/doc/uk/org/ury/show/item/ShowItemProperty.html @@ -0,0 +1,382 @@ + + + + + + +ShowItemProperty + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      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.show.item +
      +Enum ShowItemProperty

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

      +Enumeration of the parameters that are stored in a ShowItem. +

      + +

      +

      +
      Author:
      +
      Matt Windsor
      +
      +
      + +

      + + + + + + + + + + + + + + + + +
      +Enum Constant Summary
      NAME1 + +
      +           
      NAME2 + +
      +           
      POSITION + +
      +           
      +  + + + + + + + + + + +
      +Field Summary
      + java.lang.Stringsql + +
      +           
      +  + + + + + + + + + + + + + + + +
      +Method Summary
      +static ShowItemPropertyvalueOf(java.lang.String name) + +
      +          Returns the enum constant of this type with the specified name.
      +static ShowItemProperty[]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
      + +

      +NAME1

      +
      +public static final ShowItemProperty NAME1
      +
      +
      +
      +
      +
      + +

      +NAME2

      +
      +public static final ShowItemProperty NAME2
      +
      +
      +
      +
      +
      + +

      +POSITION

      +
      +public static final ShowItemProperty POSITION
      +
      +
      +
      +
      + + + + + + + + +
      +Field Detail
      + +

      +sql

      +
      +public final java.lang.String sql
      +
      +
      +
      +
      + + + + + + + + +
      +Method Detail
      + +

      +values

      +
      +public static ShowItemProperty[] 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 (ShowItemProperty c : ShowItemProperty.values())
+    System.out.println(c);
+
      +

      +

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

      +valueOf

      +
      +public static ShowItemProperty 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/show/item/class-use/ShowItem.html b/doc/uk/org/ury/show/item/class-use/ShowItem.html new file mode 100644 index 0000000..35b6def --- /dev/null +++ b/doc/uk/org/ury/show/item/class-use/ShowItem.html @@ -0,0 +1,224 @@ + + + + + + +Uses of Class uk.org.ury.show.item.ShowItem + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +
      +

      +Uses of Class
      uk.org.ury.show.item.ShowItem

      +
      + + + + + + + + + +
      +Packages that use ShowItem
      uk.org.ury.show  
      +  +

      + + + + + +
      +Uses of ShowItem in uk.org.ury.show
      +  +

      + + + + + + + + + +
      Methods in uk.org.ury.show that return ShowItem
      + ShowItemShowChannel.get(int index) + +
      +          Retrieve an item from the channel.
      +  +

      + + + + + + + + + +
      Methods in uk.org.ury.show that return types with arguments of type ShowItem
      +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.
      +  +

      + + + + + + + + + + + + + +
      Methods in uk.org.ury.show with parameters of type ShowItem
      + voidShowChannel.add(int index, + ShowItem item) + +
      +          Add a new item to the channel.
      + voidShowChannel.add(ShowItem item) + +
      +          Add a new item to the end of the channel.
      +  +

      +

      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/show/item/class-use/ShowItemProperty.html b/doc/uk/org/ury/show/item/class-use/ShowItemProperty.html new file mode 100644 index 0000000..66a0d20 --- /dev/null +++ b/doc/uk/org/ury/show/item/class-use/ShowItemProperty.html @@ -0,0 +1,203 @@ + + + + + + +Uses of Class uk.org.ury.show.item.ShowItemProperty + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +
      +

      +Uses of Class
      uk.org.ury.show.item.ShowItemProperty

      +
      + + + + + + + + + +
      +Packages that use ShowItemProperty
      uk.org.ury.show.item  
      +  +

      + + + + + +
      +Uses of ShowItemProperty in uk.org.ury.show.item
      +  +

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

      + + + + + + + + +
      Constructor parameters in uk.org.ury.show.item with type arguments of type ShowItemProperty
      ShowItem(java.util.Map<ShowItemProperty,java.lang.String> properties) + +
      +          Construct a new ShowItem.
      +  +

      +

      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/show/item/package-frame.html b/doc/uk/org/ury/show/item/package-frame.html new file mode 100644 index 0000000..9fe2752 --- /dev/null +++ b/doc/uk/org/ury/show/item/package-frame.html @@ -0,0 +1,43 @@ + + + + + + +uk.org.ury.show.item + + + + + + + + + + + +uk.org.ury.show.item + + + + +
      +Classes  + +
      +ShowItem
      + + + + + + +
      +Enums  + +
      +ShowItemProperty
      + + + + diff --git a/doc/uk/org/ury/show/item/package-summary.html b/doc/uk/org/ury/show/item/package-summary.html new file mode 100644 index 0000000..3207cb5 --- /dev/null +++ b/doc/uk/org/ury/show/item/package-summary.html @@ -0,0 +1,171 @@ + + + + + + +uk.org.ury.show.item + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +

      +Package uk.org.ury.show.item +

      + + + + + + + + + +
      +Class Summary
      ShowItemAn item in the show database.
      +  + +

      + + + + + + + + + +
      +Enum Summary
      ShowItemPropertyEnumeration of the parameters that are stored in a ShowItem.
      +  + +

      +

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

      +Hierarchy For Package uk.org.ury.show.item +

      +
      +
      +
      Package Hierarchies:
      All Packages
      +
      +

      +Class Hierarchy +

      + +

      +Enum Hierarchy +

      +
        +
      • java.lang.Object
          +
        • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        +
      +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/show/item/package-use.html b/doc/uk/org/ury/show/item/package-use.html new file mode 100644 index 0000000..adf545c --- /dev/null +++ b/doc/uk/org/ury/show/item/package-use.html @@ -0,0 +1,189 @@ + + + + + + +Uses of Package uk.org.ury.show.item + + + + + + + + + + + + +
      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      +
      +

      +Uses of Package
      uk.org.ury.show.item

      +
      + + + + + + + + + + + + + +
      +Packages that use uk.org.ury.show.item
      uk.org.ury.show  
      uk.org.ury.show.item  
      +  +

      + + + + + + + + +
      +Classes in uk.org.ury.show.item used by uk.org.ury.show
      ShowItem + +
      +          An item in the show database.
      +  +

      + + + + + + + + +
      +Classes in uk.org.ury.show.item used by uk.org.ury.show.item
      ShowItemProperty + +
      +          Enumeration of the parameters that are stored in a ShowItem.
      +  +

      +

      + + + + + + + + + + + + + + + +
      + + + + + + + + + + + + +
      Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
      +      		 + +
      + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
      + + + +
      + + + diff --git a/doc/uk/org/ury/show/package-frame.html b/doc/uk/org/ury/show/package-frame.html index 94c7b4d..716012e 100644 --- a/doc/uk/org/ury/show/package-frame.html +++ b/doc/uk/org/ury/show/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.show - + @@ -25,23 +25,10 @@ Classes       
      ShowChannel
      -ShowItem -
      ShowUtils       - - - - -
      -Enums  - -
      -ShowItemProperty
      - - diff --git a/doc/uk/org/ury/show/package-summary.html b/doc/uk/org/ury/show/package-summary.html index 4a77c20..239f944 100644 --- a/doc/uk/org/ury/show/package-summary.html +++ b/doc/uk/org/ury/show/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.show - + @@ -55,8 +55,8 @@ function windowTitle() - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE FRAMES    NO FRAMES   @@ -93,10 +93,6 @@ Package uk.org.ury.show A channel of ShowItems in a show. -ShowItem -An item in the show database. - - ShowUtils A set of common utility routines to facilitate the extraction of show items from the show storage areas of the URY database. @@ -104,20 +100,6 @@ Package uk.org.ury.show   -

      - - - - - - - - - -
      -Enum Summary
      ShowItemPropertyEnumeration of the parameters that are stored in a ShowItem.
      -  -

      @@ -151,8 +133,8 @@ Package uk.org.ury.show - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE       FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/show/package-tree.html b/doc/uk/org/ury/show/package-tree.html index b222998..7b1eafb 100644 --- a/doc/uk/org/ury/show/package-tree.html +++ b/doc/uk/org/ury/show/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.show Class Hierarchy - + @@ -55,8 +55,8 @@ function windowTitle() - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   @@ -95,20 +95,8 @@ Class Hierarchy
    • javax.swing.AbstractListModel (implements javax.swing.ListModel, java.io.Serializable) -
    • uk.org.ury.database.DatabaseItem<E,T>
    • uk.org.ury.show.ShowUtils
    -

    -Enum Hierarchy -

    -
      -
    • java.lang.Object
        -
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) - -
      -
    @@ -139,8 +127,8 @@ Enum Hierarchy - PREV  - NEXT + PREV  + NEXT     FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/show/package-use.html b/doc/uk/org/ury/show/package-use.html index adf8717..e6d9e71 100644 --- a/doc/uk/org/ury/show/package-use.html +++ b/doc/uk/org/ury/show/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.show - + @@ -90,37 +90,12 @@ function windowTitle() Packages that use uk.org.ury.show -uk.org.ury.show -   - - uk.org.ury.show.viewer     

    - - - - - - - - - - - -
    -Classes in uk.org.ury.show used by uk.org.ury.show
    ShowItem - -
    -          An item in the show database.
    ShowItemProperty - -
    -          Enumeration of the parameters that are stored in a ShowItem.
    -  -

    diff --git a/doc/uk/org/ury/show/viewer/ChannelPanel.html b/doc/uk/org/ury/show/viewer/ChannelPanel.html index 1ca879b..47a2da3 100644 --- a/doc/uk/org/ury/show/viewer/ChannelPanel.html +++ b/doc/uk/org/ury/show/viewer/ChannelPanel.html @@ -2,12 +2,12 @@ - + ChannelPanel - + @@ -76,7 +76,7 @@ function windowTitle() + SUMMARY: NESTED | FIELD | CONSTR | METHOD @@ -97,18 +97,19 @@ java.lang.Object extended by java.awt.Container extended by javax.swing.JComponent extended by javax.swing.JPanel - extended by uk.org.ury.show.viewer.ChannelPanel + extended by uk.org.ury.frontend.FrontendPanel + extended by uk.org.ury.show.viewer.ChannelPanel
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    -
    public class ChannelPanel
    extends javax.swing.JPanel
    +
    public class ChannelPanel
    extends FrontendPanel

    -A panel displaying channel informstion. +A panel displaying channel information.

    @@ -211,6 +212,15 @@ A panel displaying channel informstion. Method Summary

    - SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendPanel
    setMaster
      @@ -339,7 +349,7 @@ public ChannelPanel(int number, + SUMMARY: NESTED | FIELD | CONSTR | METHOD diff --git a/doc/uk/org/ury/show/viewer/LibraryControlPanel.html b/doc/uk/org/ury/show/viewer/LibraryControlPanel.html index ac29d4e..2bcd13e 100644 --- a/doc/uk/org/ury/show/viewer/LibraryControlPanel.html +++ b/doc/uk/org/ury/show/viewer/LibraryControlPanel.html @@ -2,12 +2,12 @@ - + LibraryControlPanel - + diff --git a/doc/uk/org/ury/show/viewer/ShowViewer.html b/doc/uk/org/ury/show/viewer/ShowViewer.html index 88e4fd6..23c2d4b 100644 --- a/doc/uk/org/ury/show/viewer/ShowViewer.html +++ b/doc/uk/org/ury/show/viewer/ShowViewer.html @@ -2,12 +2,12 @@ - + ShowViewer - + @@ -76,7 +76,7 @@ function windowTitle() + SUMMARY: NESTED | FIELD | CONSTR | METHOD @@ -93,16 +93,11 @@ uk.org.ury.show.viewer Class ShowViewer
     java.lang.Object
-  extended by java.awt.Component
-      extended by java.awt.Container
-          extended by java.awt.Panel
-              extended by java.applet.Applet
-                  extended by javax.swing.JApplet
-                      extended by uk.org.ury.frontend.AbstractFrontendModule
-                          extended by uk.org.ury.show.viewer.ShowViewer
+  extended by uk.org.ury.frontend.AbstractFrontendModule
+      extended by uk.org.ury.show.viewer.ShowViewer
    -
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, FrontendModule
    +
    All Implemented Interfaces:
    FrontendModule
    @@ -112,66 +107,19 @@ java.lang.Object

    Frontend module for viewing show details. - This serves as the base for the show playout and editor classes, - but can be used stand-alone as an (admittedly rather pointless) - module. + This serves as the base for the show playout and editor classes, but can be + used stand-alone as an (admittedly rather pointless) module.

    Author:
    Matt Windsor
    -
    See Also:
    Serialized Form
    +

    - - - -

    - SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
    - SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
    - - - -
    -Nested Class Summary
    -  - - - - - - - -
    Nested classes/interfaces inherited from class java.awt.Component
    java.awt.Component.BaselineResizeBehavior
    -  - - - - - - -
    -Field Summary
    -  - - - - - - - -
    Fields inherited from class java.awt.Component
    BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
    -  - - - - - - - -
    Fields inherited from interface java.awt.image.ImageObserver
    ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
    -  @@ -214,73 +162,12 @@ Frontend module for viewing show details. - void -init() - -
    -          Initialise the library viewer frontend as an applet. - - -  FrontendModulePanel runFrontend(FrontendMaster master)
              Run the library viewer frontend. - - - void -start() - -
    -          Run the library viewer frontend as an applet. - - -  - - - - - - - -
    Methods inherited from class javax.swing.JApplet
    getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, remove, repaint, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
    -  - - - - - - - -
    Methods inherited from class java.applet.Applet
    destroy, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus, stop
    -  - - - - - - - -
    Methods inherited from class java.awt.Panel
    addNotify
    -  - - - - - - - -
    Methods inherited from class java.awt.Container
    add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate
    -  - - - - - - -
    Methods inherited from class java.awt.Component
    action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
      @@ -288,7 +175,7 @@ Frontend module for viewing show details. - +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, wait, wait, waitequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      @@ -323,38 +210,6 @@ public ShowViewer() -

    -init

    -
    -public void init()
    -
    -
    Initialise the library viewer frontend as an applet. -

    -

    -
    Specified by:
    init in class AbstractFrontendModule
    -
    -
    -
    -
    -
    -
    - -

    -start

    -
    -public void start()
    -
    -
    Run the library viewer frontend as an applet. -

    -

    -
    Overrides:
    start in class java.applet.Applet
    -
    -
    -
    -
    -
    -
    -

    runFrontend

    @@ -392,8 +247,7 @@ public java.util.List<java.lang.String> getBins()
 
 
    Returns:
    the list of bin names.
 
    Throws:
-
    QueryFailureException - if the underlying database query
-          fails.
+
    QueryFailureException - if the underlying database query fails.
 
    
 
 
@@ -448,7 +302,7 @@ public java.util.List<java.lang.String> getBins()
 
 
 
-  SUMMARY: NESTED | FIELD | CONSTR | METHOD
+  SUMMARY: NESTED | FIELD | CONSTR | METHOD
 
 DETAIL: FIELD | CONSTR | METHOD
 
diff --git a/doc/uk/org/ury/show/viewer/ShowViewerPanel.html b/doc/uk/org/ury/show/viewer/ShowViewerPanel.html
index 93481b1..d94a1b2 100644
--- a/doc/uk/org/ury/show/viewer/ShowViewerPanel.html
+++ b/doc/uk/org/ury/show/viewer/ShowViewerPanel.html
@@ -2,12 +2,12 @@
 
 
 
-
+
 
 ShowViewerPanel
 
 
-
+
 
 
 
@@ -110,7 +110,10 @@ java.lang.Object

    -Frontend panel providing access to an underlying lshow viewer. +Frontend panel providing access to an underlying show viewer. + + The various show user interfaces (show editor, playout etc.) + are derived from this.

    @@ -215,7 +218,7 @@ Frontend panel providing access to an underlying lshow viewer.  java.lang.String -getName() +getModuleName()
                @@ -281,7 +284,7 @@ Frontend panel providing access to an underlying lshow viewer. Methods inherited from class java.awt.Component -action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle +action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle   @@ -314,6 +317,10 @@ public ShowViewerPanel(UICreationFailureException

    Construct a new ShowViewerPanel. + + The panel will interface with the given show viewer and is + expected to be placed as a sub-component in the given + FrontendMaster.

    Parameters:
    viewer - The ShowViewer controlling this LibraryViewerPanel.
    master - The FrontendMaster driving the frontend. @@ -331,17 +338,17 @@ public ShowViewerPanel(

    -getName

    +

    +getModuleName

    -public java.lang.String getName()
    +public java.lang.String getModuleName()
    -
    Specified by:
    getName in class FrontendModulePanel
    +
    Specified by:
    getModuleName in class FrontendModulePanel
    -
    Returns:
    the name of the panel.
    See Also:
    FrontendModulePanel.getName()
    +
    Returns:
    the name of the panel.
    See Also:
    FrontendModulePanel.getModuleName()
    diff --git a/doc/uk/org/ury/show/viewer/TrackBin.html b/doc/uk/org/ury/show/viewer/TrackBin.html index f641b35..9ff644d 100644 --- a/doc/uk/org/ury/show/viewer/TrackBin.html +++ b/doc/uk/org/ury/show/viewer/TrackBin.html @@ -2,12 +2,12 @@ - + TrackBin - + @@ -76,7 +76,7 @@ function windowTitle() - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD @@ -97,14 +97,15 @@ java.lang.Object extended by java.awt.Container extended by javax.swing.JComponent extended by javax.swing.JPanel - extended by uk.org.ury.show.viewer.TrackBin + extended by uk.org.ury.frontend.FrontendPanel + extended by uk.org.ury.show.viewer.TrackBin
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    -
    public class TrackBin
    extends javax.swing.JPanel
    +
    public class TrackBin
    extends FrontendPanel

    @@ -210,6 +211,15 @@ A panel displaying track bin contents. Method Summary +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendPanel
    setMaster
      @@ -339,7 +349,7 @@ public TrackBin(java.lang.String name) + SUMMARY: NESTED | FIELD | CONSTR | METHOD diff --git a/doc/uk/org/ury/show/viewer/class-use/ChannelPanel.html b/doc/uk/org/ury/show/viewer/class-use/ChannelPanel.html index d12b03c..b787161 100644 --- a/doc/uk/org/ury/show/viewer/class-use/ChannelPanel.html +++ b/doc/uk/org/ury/show/viewer/class-use/ChannelPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.viewer.ChannelPanel - + diff --git a/doc/uk/org/ury/show/viewer/class-use/LibraryControlPanel.html b/doc/uk/org/ury/show/viewer/class-use/LibraryControlPanel.html index f81e62b..4336617 100644 --- a/doc/uk/org/ury/show/viewer/class-use/LibraryControlPanel.html +++ b/doc/uk/org/ury/show/viewer/class-use/LibraryControlPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.viewer.LibraryControlPanel - + diff --git a/doc/uk/org/ury/show/viewer/class-use/ShowViewer.html b/doc/uk/org/ury/show/viewer/class-use/ShowViewer.html index 9942645..8c5bab3 100644 --- a/doc/uk/org/ury/show/viewer/class-use/ShowViewer.html +++ b/doc/uk/org/ury/show/viewer/class-use/ShowViewer.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.viewer.ShowViewer - + diff --git a/doc/uk/org/ury/show/viewer/class-use/ShowViewerPanel.html b/doc/uk/org/ury/show/viewer/class-use/ShowViewerPanel.html index 04b160f..faed83f 100644 --- a/doc/uk/org/ury/show/viewer/class-use/ShowViewerPanel.html +++ b/doc/uk/org/ury/show/viewer/class-use/ShowViewerPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.viewer.ShowViewerPanel - + diff --git a/doc/uk/org/ury/show/viewer/class-use/TrackBin.html b/doc/uk/org/ury/show/viewer/class-use/TrackBin.html index 983106d..679dd80 100644 --- a/doc/uk/org/ury/show/viewer/class-use/TrackBin.html +++ b/doc/uk/org/ury/show/viewer/class-use/TrackBin.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.viewer.TrackBin - + diff --git a/doc/uk/org/ury/show/viewer/package-frame.html b/doc/uk/org/ury/show/viewer/package-frame.html index f643d0c..456b466 100644 --- a/doc/uk/org/ury/show/viewer/package-frame.html +++ b/doc/uk/org/ury/show/viewer/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.show.viewer - + diff --git a/doc/uk/org/ury/show/viewer/package-summary.html b/doc/uk/org/ury/show/viewer/package-summary.html index 883975b..692da14 100644 --- a/doc/uk/org/ury/show/viewer/package-summary.html +++ b/doc/uk/org/ury/show/viewer/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.show.viewer - + @@ -55,7 +55,7 @@ function windowTitle() - + @@ -102,7 +102,7 @@ Package uk.org.ury.show.viewer - + @@ -144,7 +144,7 @@ Package uk.org.ury.show.viewer + SUMMARY: NESTED | FIELD | CONSTR | METHOD @@ -93,19 +93,15 @@ uk.org.ury.testrig Class DemoMenu
     java.lang.Object
-  extended by java.awt.Component
-      extended by java.awt.Container
-          extended by java.awt.Panel
-              extended by java.applet.Applet
-                  extended by javax.swing.JApplet
-                      extended by uk.org.ury.testrig.DemoMenu
+  extended by uk.org.ury.frontend.AbstractFrontendModule
+      extended by uk.org.ury.testrig.DemoMenu
    -
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer
    +
    All Implemented Interfaces:
    FrontendModule
    -
    public class DemoMenu
    extends javax.swing.JApplet
    +
    public class DemoMenu
    extends AbstractFrontendModule

    @@ -116,57 +112,11 @@ Application frontend, for testing early-stage frontend code.

    Author:
    Matt Windsor
    -
    See Also:
    Serialized Form
    +

    - - - -

    - SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
    - PREV PACKAGE  + PREV PACKAGE   NEXT PACKAGE FRAMES   @@ -90,7 +90,7 @@ Package uk.org.ury.show.viewer
    ChannelPanelA panel displaying channel informstion.A panel displaying channel information.
    LibraryControlPanel
    ShowViewerPanelFrontend panel providing access to an underlying lshow viewer.Frontend panel providing access to an underlying show viewer.
    TrackBin
    - PREV PACKAGE  + PREV PACKAGE   NEXT PACKAGE FRAMES   diff --git a/doc/uk/org/ury/show/viewer/package-tree.html b/doc/uk/org/ury/show/viewer/package-tree.html index d33ff4b..1194356 100644 --- a/doc/uk/org/ury/show/viewer/package-tree.html +++ b/doc/uk/org/ury/show/viewer/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.show.viewer Class Hierarchy - + @@ -55,7 +55,7 @@ function windowTitle()
    - PREV  + PREV   NEXT FRAMES   @@ -92,6 +92,9 @@ Class Hierarchy
    - PREV  + PREV   NEXT FRAMES   diff --git a/doc/uk/org/ury/show/viewer/package-use.html b/doc/uk/org/ury/show/viewer/package-use.html index eb15ba5..5d2a5c3 100644 --- a/doc/uk/org/ury/show/viewer/package-use.html +++ b/doc/uk/org/ury/show/viewer/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.show.viewer - + diff --git a/doc/uk/org/ury/testrig/ApplicationLauncher.html b/doc/uk/org/ury/testrig/ApplicationLauncher.html new file mode 100644 index 0000000..53b3516 --- /dev/null +++ b/doc/uk/org/ury/testrig/ApplicationLauncher.html @@ -0,0 +1,289 @@ + + + + + + +ApplicationLauncher + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.testrig +
    +Class ApplicationLauncher

    +
    +java.lang.Object
+  extended by uk.org.ury.testrig.ApplicationLauncher
+
    +
    +
    All Implemented Interfaces:
    Launcher
    +
    +
    +
    +
    public class ApplicationLauncher
    extends java.lang.Object
    implements Launcher
    + + +

    +An application-based entry point into the frontend. + + If provided with no arguments, this will launch the main menu. +

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from interface uk.org.ury.testrig.Launcher
    DEFAULT_MODULE_NAME
    +  + + + + + + + + + + +
    +Constructor Summary
    ApplicationLauncher() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    +static voidmain(java.lang.String[] args) + +
    +          Main method.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +ApplicationLauncher

    +
    +public ApplicationLauncher()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +main

    +
    +public static void main(java.lang.String[] args)
    +
    +
    Main method. +

    +

    +
    +
    +
    +
    Parameters:
    args - The command-line arguments to the program. These + will currently be ignored.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/testrig/DemoControlPanel.html b/doc/uk/org/ury/testrig/DemoControlPanel.html index 0ace755..c6a2724 100644 --- a/doc/uk/org/ury/testrig/DemoControlPanel.html +++ b/doc/uk/org/ury/testrig/DemoControlPanel.html @@ -2,12 +2,12 @@ - + DemoControlPanel - + @@ -55,7 +55,7 @@ function windowTitle()
    - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -362,7 +362,7 @@ public void back()
    - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   diff --git a/doc/uk/org/ury/testrig/DemoMenu.html b/doc/uk/org/ury/testrig/DemoMenu.html index ac1a762..33b290c 100644 --- a/doc/uk/org/ury/testrig/DemoMenu.html +++ b/doc/uk/org/ury/testrig/DemoMenu.html @@ -2,12 +2,12 @@ - + DemoMenu - + @@ -76,7 +76,7 @@ function windowTitle()
    - SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
    - - - -
    -Nested Class Summary
    -  - - - - - - - -
    Nested classes/interfaces inherited from class java.awt.Component
    java.awt.Component.BaselineResizeBehavior
    -  - - - - - - -
    -Field Summary
    -  - - - - - - - -
    Fields inherited from class java.awt.Component
    BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
    -  - - - - - - - -
    Fields inherited from interface java.awt.image.ImageObserver
    ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
    -  @@ -194,14 +144,6 @@ Application frontend, for testing early-stage frontend code.  void -init() - -
    -          Initialise the menu as an applet. - - - - void loadModule(java.lang.String module)
    @@ -209,64 +151,19 @@ Application frontend, for testing early-stage frontend code. -static void -main(java.lang.String[] args) - -
    -          Main method. - - -  void run()
              Run the demo menu, creating a user interface. - -  - - - - - - -
    Methods inherited from class javax.swing.JApplet
    getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, remove, repaint, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
    -  - - - - - - - -
    Methods inherited from class java.applet.Applet
    destroy, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus, start, stop
    -  - - - - - - - -
    Methods inherited from class java.awt.Panel
    addNotify
    -  - - - - - - - -
    Methods inherited from class java.awt.Container
    add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate
    -  - - - - - - + +
    Methods inherited from class java.awt.Component
    action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle + FrontendModulePanelrunFrontend(FrontendMaster master) + +
    +          Run the demo menu in frontend mode.
      @@ -275,7 +172,7 @@ Application frontend, for testing early-stage frontend code. Methods inherited from class java.lang.Object -equals, getClass, hashCode, notify, notifyAll, wait, wait, wait +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait   @@ -308,36 +205,6 @@ public DemoMenu() -

    -main

    -
    -public static void main(java.lang.String[] args)
    -
    -
    Main method. -

    -

    -
    Parameters:
    args - The command-line arguments to the program. These - will be ignored.
    -
    -
    -
    - -

    -init

    -
    -public void init()
    -
    -
    Initialise the menu as an applet. -

    -

    -
    Overrides:
    init in class java.applet.Applet
    -
    -
    -
    -
    -
    -
    -

    loadModule

    @@ -360,6 +227,21 @@ public void run()
    +
    + +

    +runFrontend

    +
    +public FrontendModulePanel runFrontend(FrontendMaster master)
    +
    +
    Run the demo menu in frontend mode. +

    +

    +
    Parameters:
    master - The FrontendMaster driving the frontend. +
    Returns:
    the frontend panel to insert into the + FrontendMaster.
    +
    +
    @@ -412,7 +294,7 @@ public void run() - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD diff --git a/doc/uk/org/ury/testrig/DemoMenuPanel.html b/doc/uk/org/ury/testrig/DemoMenuPanel.html index 52d2a0c..a197bb5 100644 --- a/doc/uk/org/ury/testrig/DemoMenuPanel.html +++ b/doc/uk/org/ury/testrig/DemoMenuPanel.html @@ -2,12 +2,12 @@ - + DemoMenuPanel - + @@ -56,7 +56,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -208,7 +208,7 @@ java.lang.Object  java.lang.String -getName() +getModuleName()
                @@ -265,7 +265,7 @@ java.lang.Object Methods inherited from class java.awt.Component -action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle +action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle   @@ -311,13 +311,13 @@ public DemoMenuPanel(

    -getName

    +

    +getModuleName

    -public java.lang.String getName()
    +public java.lang.String getModuleName()
    -
    Specified by:
    getName in class FrontendModulePanel
    +
    Specified by:
    getModuleName in class FrontendModulePanel
    @@ -356,7 +356,7 @@ public java.lang.String getName()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/testrig/Launcher.html b/doc/uk/org/ury/testrig/Launcher.html new file mode 100644 index 0000000..c8a673f --- /dev/null +++ b/doc/uk/org/ury/testrig/Launcher.html @@ -0,0 +1,215 @@ + + + + + + +Launcher + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.testrig +
    +Interface Launcher

    +
    +
    All Known Implementing Classes:
    ApplicationLauncher, FrontendApplet
    +
    +
    +
    +
    public interface Launcher
    + + +

    +Interface for entry points into the frontend. +

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringDEFAULT_MODULE_NAME + +
    +           
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +DEFAULT_MODULE_NAME

    +
    +static final java.lang.String DEFAULT_MODULE_NAME
    +
    +
    +
    See Also:
    Constant Field Values
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/testrig/class-use/ApplicationLauncher.html b/doc/uk/org/ury/testrig/class-use/ApplicationLauncher.html new file mode 100644 index 0000000..78d1ab2 --- /dev/null +++ b/doc/uk/org/ury/testrig/class-use/ApplicationLauncher.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.testrig.ApplicationLauncher + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.testrig.ApplicationLauncher

    +
    +No usage of uk.org.ury.testrig.ApplicationLauncher +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/testrig/class-use/DemoControlPanel.html b/doc/uk/org/ury/testrig/class-use/DemoControlPanel.html index 2ef2ceb..11a75bc 100644 --- a/doc/uk/org/ury/testrig/class-use/DemoControlPanel.html +++ b/doc/uk/org/ury/testrig/class-use/DemoControlPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.testrig.DemoControlPanel - + diff --git a/doc/uk/org/ury/testrig/class-use/DemoMenu.html b/doc/uk/org/ury/testrig/class-use/DemoMenu.html index 435069f..ff1bc13 100644 --- a/doc/uk/org/ury/testrig/class-use/DemoMenu.html +++ b/doc/uk/org/ury/testrig/class-use/DemoMenu.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.testrig.DemoMenu - + diff --git a/doc/uk/org/ury/testrig/class-use/DemoMenuPanel.html b/doc/uk/org/ury/testrig/class-use/DemoMenuPanel.html index 09ad243..dfff911 100644 --- a/doc/uk/org/ury/testrig/class-use/DemoMenuPanel.html +++ b/doc/uk/org/ury/testrig/class-use/DemoMenuPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.testrig.DemoMenuPanel - + diff --git a/doc/uk/org/ury/testrig/class-use/Launcher.html b/doc/uk/org/ury/testrig/class-use/Launcher.html new file mode 100644 index 0000000..38b34c1 --- /dev/null +++ b/doc/uk/org/ury/testrig/class-use/Launcher.html @@ -0,0 +1,210 @@ + + + + + + +Uses of Interface uk.org.ury.testrig.Launcher + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Interface
    uk.org.ury.testrig.Launcher

    +
    + + + + + + + + + + + + + +
    +Packages that use Launcher
    uk.org.ury.frontend  
    uk.org.ury.testrig  
    +  +

    + + + + + +
    +Uses of Launcher in uk.org.ury.frontend
    +  +

    + + + + + + + + + +
    Classes in uk.org.ury.frontend that implement Launcher
    + classFrontendApplet + +
    +          A frame that hosts a FrontendModulePanel, used for serving frontend panels in + a window (application mode).
    +  +

    + + + + + +
    +Uses of Launcher in uk.org.ury.testrig
    +  +

    + + + + + + + + + +
    Classes in uk.org.ury.testrig that implement Launcher
    + classApplicationLauncher + +
    +          An application-based entry point into the frontend.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/testrig/package-frame.html b/doc/uk/org/ury/testrig/package-frame.html index 48ffe63..b590174 100644 --- a/doc/uk/org/ury/testrig/package-frame.html +++ b/doc/uk/org/ury/testrig/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.testrig - + @@ -17,12 +17,25 @@ uk.org.ury.testrig uk.org.ury.testrig + + + + +
    +Interfaces  + +
    +Launcher
    + +
    Classes 
    +ApplicationLauncher +
    DemoControlPanel
    DemoMenu diff --git a/doc/uk/org/ury/testrig/package-summary.html b/doc/uk/org/ury/testrig/package-summary.html index eeb2333..1630fe3 100644 --- a/doc/uk/org/ury/testrig/package-summary.html +++ b/doc/uk/org/ury/testrig/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.testrig - + @@ -83,12 +83,30 @@ function windowTitle() Package uk.org.ury.testrig + + + + + + + + +
    +Interface Summary
    LauncherInterface for entry points into the frontend.
    +  + +

    + + + + + diff --git a/doc/uk/org/ury/testrig/package-tree.html b/doc/uk/org/ury/testrig/package-tree.html index dd0c35b..aee9f84 100644 --- a/doc/uk/org/ury/testrig/package-tree.html +++ b/doc/uk/org/ury/testrig/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.testrig Class Hierarchy - + @@ -92,6 +92,10 @@ Class Hierarchy
    • java.lang.Object
        +
      • uk.org.ury.frontend.AbstractFrontendModule (implements uk.org.ury.frontend.FrontendModule) + +
      • uk.org.ury.testrig.ApplicationLauncher (implements uk.org.ury.testrig.Launcher)
      • java.awt.Component (implements java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable)
        • java.awt.Container
            @@ -107,18 +111,15 @@ Class Hierarchy
      -
    • java.awt.Panel (implements javax.accessibility.Accessible) -
        -
      • java.applet.Applet
          -
        • javax.swing.JApplet (implements javax.accessibility.Accessible, javax.swing.RootPaneContainer) - -
        -
    +

    +Interface Hierarchy +

    +
    diff --git a/doc/uk/org/ury/testrig/package-use.html b/doc/uk/org/ury/testrig/package-use.html index db859b0..dced520 100644 --- a/doc/uk/org/ury/testrig/package-use.html +++ b/doc/uk/org/ury/testrig/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.testrig - + @@ -83,7 +83,52 @@ function windowTitle()

    Uses of Package
    uk.org.ury.testrig

    -No usage of uk.org.ury.testrig + +
    Class Summary
    ApplicationLauncherAn application-based entry point into the frontend.
    DemoControlPanel Control panel for the demo system.
    + + + + + + + + + + + +
    +Packages that use uk.org.ury.testrig
    uk.org.ury.frontend  
    uk.org.ury.testrig  
    +  +

    + + + + + + + + +
    +Classes in uk.org.ury.testrig used by uk.org.ury.frontend
    Launcher + +
    +          Interface for entry points into the frontend.
    +  +

    + + + + + + + + +
    +Classes in uk.org.ury.testrig used by uk.org.ury.testrig
    Launcher + +
    +          Interface for entry points into the frontend.
    + 

    -- cgit v1.2.3