From df7d7981b56a4560c95ea7e9b194080e93398ecf Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 21:54:31 +0000 Subject: GREAT PACKAGE RESHUFFLE: Everything is now organised into frontend, backend and common (to frontend and backend) packages. Things may have been broken. Doc refresh. --- doc/allclasses-frame.html | 108 ++-- doc/allclasses-noframe.html | 108 ++-- doc/constant-values.html | 30 +- doc/deprecated-list.html | 2 +- doc/help-doc.html | 2 +- doc/index-files/index-1.html | 30 +- doc/index-files/index-10.html | 40 +- doc/index-files/index-11.html | 30 +- doc/index-files/index-12.html | 12 +- doc/index-files/index-13.html | 8 +- doc/index-files/index-14.html | 12 +- doc/index-files/index-15.html | 35 +- doc/index-files/index-16.html | 62 +-- doc/index-files/index-17.html | 20 +- doc/index-files/index-18.html | 10 +- doc/index-files/index-19.html | 42 +- doc/index-files/index-2.html | 20 +- doc/index-files/index-3.html | 32 +- doc/index-files/index-4.html | 50 +- doc/index-files/index-5.html | 24 +- doc/index-files/index-6.html | 10 +- doc/index-files/index-7.html | 120 ++--- doc/index-files/index-8.html | 76 +-- doc/index-files/index-9.html | 12 +- doc/index.html | 2 +- doc/overview-frame.html | 48 +- doc/overview-summary.html | 66 ++- doc/overview-tree.html | 50 +- doc/package-list | 38 +- doc/serialized-form.html | 506 ++++++++--------- doc/uk/org/ury/backend/config/Auth.html | 291 ++++++++++ doc/uk/org/ury/backend/config/ConfigReader.html | 315 +++++++++++ doc/uk/org/ury/backend/config/Database.html | 315 +++++++++++ doc/uk/org/ury/backend/config/class-use/Auth.html | 188 +++++++ .../ury/backend/config/class-use/ConfigReader.html | 179 ++++++ .../org/ury/backend/config/class-use/Database.html | 180 +++++++ doc/uk/org/ury/backend/config/package-frame.html | 36 ++ doc/uk/org/ury/backend/config/package-summary.html | 165 ++++++ doc/uk/org/ury/backend/config/package-tree.html | 153 ++++++ doc/uk/org/ury/backend/config/package-use.html | 195 +++++++ .../org/ury/backend/database/DatabaseDriver.html | 317 +++++++++++ doc/uk/org/ury/backend/database/DatabaseItem.html | 320 +++++++++++ doc/uk/org/ury/backend/database/UserClass.html | 376 +++++++++++++ .../backend/database/class-use/DatabaseDriver.html | 250 +++++++++ .../backend/database/class-use/DatabaseItem.html | 209 +++++++ .../ury/backend/database/class-use/UserClass.html | 233 ++++++++ .../exceptions/ConnectionFailureException.html | 269 +++++++++ .../exceptions/MissingCredentialsException.html | 275 ++++++++++ .../exceptions/MissingPropertyException.html | 271 ++++++++++ .../database/exceptions/QueryFailureException.html | 269 +++++++++ .../class-use/ConnectionFailureException.html | 208 +++++++ .../class-use/MissingCredentialsException.html | 235 ++++++++ .../class-use/MissingPropertyException.html | 180 +++++++ .../class-use/QueryFailureException.html | 250 +++++++++ .../backend/database/exceptions/package-frame.html | 38 ++ .../database/exceptions/package-summary.html | 189 +++++++ .../backend/database/exceptions/package-tree.html | 158 ++++++ .../backend/database/exceptions/package-use.html | 295 ++++++++++ doc/uk/org/ury/backend/database/package-frame.html | 45 ++ .../org/ury/backend/database/package-summary.html | 196 +++++++ doc/uk/org/ury/backend/database/package-tree.html | 163 ++++++ doc/uk/org/ury/backend/database/package-use.html | 276 ++++++++++ .../backend/handlers/LibraryRequestHandler.html | 307 +++++++++++ .../handlers/class-use/LibraryRequestHandler.html | 144 +++++ doc/uk/org/ury/backend/handlers/package-frame.html | 32 ++ .../org/ury/backend/handlers/package-summary.html | 157 ++++++ doc/uk/org/ury/backend/handlers/package-tree.html | 156 ++++++ doc/uk/org/ury/backend/handlers/package-use.html | 144 +++++ .../ury/backend/server/AbstractRequestHandler.html | 290 ++++++++++ .../org/ury/backend/server/ApiRequestHandler.html | 238 ++++++++ doc/uk/org/ury/backend/server/HttpHandler.html | 309 +++++++++++ .../org/ury/backend/server/HttpListenerThread.html | 322 +++++++++++ .../org/ury/backend/server/HttpWorkerThread.html | 324 +++++++++++ doc/uk/org/ury/backend/server/Server.html | 384 +++++++++++++ .../ury/backend/server/ServerRequestHandler.html | 283 ++++++++++ .../server/class-use/AbstractRequestHandler.html | 209 +++++++ .../server/class-use/ApiRequestHandler.html | 180 +++++++ .../ury/backend/server/class-use/HttpHandler.html | 144 +++++ .../server/class-use/HttpListenerThread.html | 144 +++++ .../backend/server/class-use/HttpWorkerThread.html | 144 +++++ .../org/ury/backend/server/class-use/Server.html | 249 +++++++++ .../server/class-use/ServerRequestHandler.html | 144 +++++ .../server/exceptions/BadRequestException.html | 271 ++++++++++ .../server/exceptions/HandleFailureException.html | 270 ++++++++++ .../exceptions/HandlerNotFoundException.html | 275 ++++++++++ .../exceptions/HandlerSetupFailureException.html | 278 ++++++++++ .../server/exceptions/HandlingException.html | 275 ++++++++++ .../server/exceptions/NotAHandlerException.html | 254 +++++++++ .../exceptions/UnknownFunctionException.html | 252 +++++++++ .../exceptions/class-use/BadRequestException.html | 213 ++++++++ .../class-use/HandleFailureException.html | 233 ++++++++ .../class-use/HandlerNotFoundException.html | 213 ++++++++ .../class-use/HandlerSetupFailureException.html | 213 ++++++++ .../exceptions/class-use/HandlingException.html | 226 ++++++++ .../exceptions/class-use/NotAHandlerException.html | 213 ++++++++ .../class-use/UnknownFunctionException.html | 182 +++++++ .../backend/server/exceptions/package-frame.html | 44 ++ .../backend/server/exceptions/package-summary.html | 187 +++++++ .../backend/server/exceptions/package-tree.html | 160 ++++++ .../ury/backend/server/exceptions/package-use.html | 273 ++++++++++ doc/uk/org/ury/backend/server/package-frame.html | 53 ++ doc/uk/org/ury/backend/server/package-summary.html | 220 ++++++++ doc/uk/org/ury/backend/server/package-tree.html | 166 ++++++ doc/uk/org/ury/backend/server/package-use.html | 210 ++++++++ doc/uk/org/ury/common/library/LibraryUtils.html | 277 ++++++++++ .../ury/common/library/class-use/LibraryUtils.html | 144 +++++ .../library/exceptions/EmptySearchException.html | 272 ++++++++++ .../exceptions/class-use/EmptySearchException.html | 210 ++++++++ .../common/library/exceptions/package-frame.html | 32 ++ .../common/library/exceptions/package-summary.html | 158 ++++++ .../common/library/exceptions/package-tree.html | 158 ++++++ .../ury/common/library/exceptions/package-use.html | 191 +++++++ .../org/ury/common/library/item/LibraryItem.html | 242 +++++++++ .../common/library/item/LibraryItemProperty.html | 599 +++++++++++++++++++++ .../common/library/item/class-use/LibraryItem.html | 224 ++++++++ .../item/class-use/LibraryItemProperty.html | 211 ++++++++ .../org/ury/common/library/item/package-frame.html | 43 ++ .../ury/common/library/item/package-summary.html | 171 ++++++ .../org/ury/common/library/item/package-tree.html | 165 ++++++ .../org/ury/common/library/item/package-use.html | 208 +++++++ doc/uk/org/ury/common/library/package-frame.html | 32 ++ doc/uk/org/ury/common/library/package-summary.html | 158 ++++++ doc/uk/org/ury/common/library/package-tree.html | 153 ++++++ doc/uk/org/ury/common/library/package-use.html | 144 +++++ doc/uk/org/ury/common/protocol/Directive.html | 362 +++++++++++++ doc/uk/org/ury/common/protocol/ProtocolUtils.html | 322 +++++++++++ doc/uk/org/ury/common/protocol/Status.html | 330 ++++++++++++ .../ury/common/protocol/class-use/Directive.html | 189 +++++++ .../common/protocol/class-use/ProtocolUtils.html | 144 +++++ .../org/ury/common/protocol/class-use/Status.html | 189 +++++++ .../exceptions/DecodeFailureException.html | 250 +++++++++ .../exceptions/InvalidMessageException.html | 251 +++++++++ .../class-use/DecodeFailureException.html | 209 +++++++ .../class-use/InvalidMessageException.html | 209 +++++++ .../common/protocol/exceptions/package-frame.html | 34 ++ .../protocol/exceptions/package-summary.html | 162 ++++++ .../common/protocol/exceptions/package-tree.html | 158 ++++++ .../common/protocol/exceptions/package-use.html | 216 ++++++++ doc/uk/org/ury/common/protocol/package-frame.html | 45 ++ .../org/ury/common/protocol/package-summary.html | 176 ++++++ doc/uk/org/ury/common/protocol/package-tree.html | 163 ++++++ doc/uk/org/ury/common/protocol/package-use.html | 176 ++++++ doc/uk/org/ury/common/show/ShowChannel.html | 369 +++++++++++++ doc/uk/org/ury/common/show/ShowUtils.html | 345 ++++++++++++ .../org/ury/common/show/class-use/ShowChannel.html | 195 +++++++ .../org/ury/common/show/class-use/ShowUtils.html | 144 +++++ doc/uk/org/ury/common/show/item/ShowItem.html | 278 ++++++++++ .../org/ury/common/show/item/ShowItemProperty.html | 382 +++++++++++++ .../ury/common/show/item/class-use/ShowItem.html | 224 ++++++++ .../show/item/class-use/ShowItemProperty.html | 203 +++++++ doc/uk/org/ury/common/show/item/package-frame.html | 43 ++ .../org/ury/common/show/item/package-summary.html | 189 +++++++ doc/uk/org/ury/common/show/item/package-tree.html | 165 ++++++ doc/uk/org/ury/common/show/item/package-use.html | 189 +++++++ doc/uk/org/ury/common/show/package-frame.html | 34 ++ doc/uk/org/ury/common/show/package-summary.html | 162 ++++++ doc/uk/org/ury/common/show/package-tree.html | 156 ++++++ doc/uk/org/ury/common/show/package-use.html | 170 ++++++ .../org/ury/frontend/AbstractFrontendModule.html | 4 +- doc/uk/org/ury/frontend/FrontendApplet.html | 12 +- doc/uk/org/ury/frontend/FrontendBanner.html | 2 +- doc/uk/org/ury/frontend/FrontendControlPanel.html | 4 +- doc/uk/org/ury/frontend/FrontendError.html | 2 +- doc/uk/org/ury/frontend/FrontendFrame.html | 64 +-- doc/uk/org/ury/frontend/FrontendMaster.html | 2 +- doc/uk/org/ury/frontend/FrontendModule.html | 23 +- doc/uk/org/ury/frontend/FrontendModulePanel.html | 4 +- doc/uk/org/ury/frontend/FrontendPanel.html | 4 +- doc/uk/org/ury/frontend/FrontendSubBanner.html | 2 +- doc/uk/org/ury/frontend/HintField.html | 2 +- .../frontend/class-use/AbstractFrontendModule.html | 36 +- .../org/ury/frontend/class-use/FrontendApplet.html | 2 +- .../org/ury/frontend/class-use/FrontendBanner.html | 2 +- .../frontend/class-use/FrontendControlPanel.html | 25 +- .../org/ury/frontend/class-use/FrontendError.html | 2 +- .../org/ury/frontend/class-use/FrontendFrame.html | 2 +- .../org/ury/frontend/class-use/FrontendMaster.html | 58 +- .../org/ury/frontend/class-use/FrontendModule.html | 36 +- .../frontend/class-use/FrontendModulePanel.html | 55 +- .../org/ury/frontend/class-use/FrontendPanel.html | 104 ++-- .../ury/frontend/class-use/FrontendSubBanner.html | 2 +- doc/uk/org/ury/frontend/class-use/HintField.html | 2 +- doc/uk/org/ury/frontend/client/Client.html | 259 +++++++++ .../org/ury/frontend/client/class-use/Client.html | 144 +++++ doc/uk/org/ury/frontend/client/package-frame.html | 32 ++ .../org/ury/frontend/client/package-summary.html | 157 ++++++ doc/uk/org/ury/frontend/client/package-tree.html | 153 ++++++ doc/uk/org/ury/frontend/client/package-use.html | 144 +++++ .../org/ury/frontend/client/test/ClientTest.html | 306 +++++++++++ .../frontend/client/test/class-use/ClientTest.html | 144 +++++ .../ury/frontend/client/test/package-frame.html | 32 ++ .../ury/frontend/client/test/package-summary.html | 157 ++++++ .../org/ury/frontend/client/test/package-tree.html | 153 ++++++ .../org/ury/frontend/client/test/package-use.html | 144 +++++ .../frontend/cpanels/menu/DemoControlPanel.html | 397 ++++++++++++++ .../cpanels/menu/class-use/DemoControlPanel.html | 144 +++++ .../ury/frontend/cpanels/menu/package-frame.html | 32 ++ .../ury/frontend/cpanels/menu/package-summary.html | 157 ++++++ .../ury/frontend/cpanels/menu/package-tree.html | 168 ++++++ .../org/ury/frontend/cpanels/menu/package-use.html | 144 +++++ .../frontend/cpanels/show/LibraryControlPanel.html | 397 ++++++++++++++ .../show/class-use/LibraryControlPanel.html | 144 +++++ .../ury/frontend/cpanels/show/package-frame.html | 32 ++ .../ury/frontend/cpanels/show/package-summary.html | 157 ++++++ .../ury/frontend/cpanels/show/package-tree.html | 168 ++++++ .../org/ury/frontend/cpanels/show/package-use.html | 144 +++++ .../frontend/exceptions/LoadFailureException.html | 2 +- .../exceptions/UICreationFailureException.html | 2 +- .../exceptions/class-use/LoadFailureException.html | 6 +- .../class-use/UICreationFailureException.html | 87 +-- .../org/ury/frontend/exceptions/package-frame.html | 2 +- .../ury/frontend/exceptions/package-summary.html | 10 +- .../org/ury/frontend/exceptions/package-tree.html | 10 +- .../org/ury/frontend/exceptions/package-use.html | 45 +- .../modules/library/LibraryTableModel.html | 362 +++++++++++++ .../frontend/modules/library/LibraryViewer.html | 327 +++++++++++ .../modules/library/LibraryViewerPanel.html | 424 +++++++++++++++ .../library/class-use/LibraryTableModel.html | 144 +++++ .../modules/library/class-use/LibraryViewer.html | 179 ++++++ .../library/class-use/LibraryViewerPanel.html | 144 +++++ .../frontend/modules/library/package-frame.html | 36 ++ .../frontend/modules/library/package-summary.html | 165 ++++++ .../ury/frontend/modules/library/package-tree.html | 174 ++++++ .../ury/frontend/modules/library/package-use.html | 170 ++++++ doc/uk/org/ury/frontend/modules/menu/DemoMenu.html | 307 +++++++++++ .../ury/frontend/modules/menu/DemoMenuPanel.html | 390 ++++++++++++++ .../frontend/modules/menu/class-use/DemoMenu.html | 144 +++++ .../modules/menu/class-use/DemoMenuPanel.html | 144 +++++ .../ury/frontend/modules/menu/package-frame.html | 34 ++ .../ury/frontend/modules/menu/package-summary.html | 161 ++++++ .../ury/frontend/modules/menu/package-tree.html | 171 ++++++ .../org/ury/frontend/modules/menu/package-use.html | 144 +++++ .../ury/frontend/modules/show/ChannelPanel.html | 363 +++++++++++++ .../org/ury/frontend/modules/show/ShowViewer.html | 315 +++++++++++ .../ury/frontend/modules/show/ShowViewerPanel.html | 431 +++++++++++++++ doc/uk/org/ury/frontend/modules/show/TrackBin.html | 363 +++++++++++++ .../modules/show/class-use/ChannelPanel.html | 144 +++++ .../modules/show/class-use/ShowViewer.html | 179 ++++++ .../modules/show/class-use/ShowViewerPanel.html | 144 +++++ .../frontend/modules/show/class-use/TrackBin.html | 144 +++++ .../ury/frontend/modules/show/package-frame.html | 38 ++ .../ury/frontend/modules/show/package-summary.html | 169 ++++++ .../ury/frontend/modules/show/package-tree.html | 171 ++++++ .../org/ury/frontend/modules/show/package-use.html | 170 ++++++ doc/uk/org/ury/frontend/package-frame.html | 2 +- doc/uk/org/ury/frontend/package-summary.html | 18 +- doc/uk/org/ury/frontend/package-tree.html | 12 +- doc/uk/org/ury/frontend/package-use.html | 134 +++-- .../ury/frontend/testrig/ApplicationLauncher.html | 289 ++++++++++ doc/uk/org/ury/frontend/testrig/Launcher.html | 215 ++++++++ .../testrig/class-use/ApplicationLauncher.html | 144 +++++ .../ury/frontend/testrig/class-use/Launcher.html | 210 ++++++++ doc/uk/org/ury/frontend/testrig/package-frame.html | 43 ++ .../org/ury/frontend/testrig/package-summary.html | 171 ++++++ doc/uk/org/ury/frontend/testrig/package-tree.html | 159 ++++++ doc/uk/org/ury/frontend/testrig/package-use.html | 189 +++++++ src/uk/org/ury/backend/config/Auth.java | 36 ++ src/uk/org/ury/backend/config/ConfigReader.java | 115 ++++ src/uk/org/ury/backend/config/Database.java | 45 ++ .../org/ury/backend/database/DatabaseDriver.java | 166 ++++++ src/uk/org/ury/backend/database/DatabaseItem.java | 80 +++ src/uk/org/ury/backend/database/UserClass.java | 38 ++ .../exceptions/ConnectionFailureException.java | 44 ++ .../exceptions/MissingCredentialsException.java | 52 ++ .../exceptions/MissingPropertyException.java | 47 ++ .../database/exceptions/QueryFailureException.java | 45 ++ .../ury/backend/database/exceptions/package.html | 11 + src/uk/org/ury/backend/database/package.html | 15 + .../backend/handlers/LibraryRequestHandler.java | 189 +++++++ .../ury/backend/server/AbstractRequestHandler.java | 254 +++++++++ .../org/ury/backend/server/ApiRequestHandler.java | 42 ++ src/uk/org/ury/backend/server/HttpHandler.java | 205 +++++++ .../org/ury/backend/server/HttpListenerThread.java | 128 +++++ .../org/ury/backend/server/HttpWorkerThread.java | 104 ++++ src/uk/org/ury/backend/server/Server.java | 99 ++++ .../ury/backend/server/ServerRequestHandler.java | 95 ++++ .../server/exceptions/BadRequestException.java | 47 ++ .../server/exceptions/HandleFailureException.java | 46 ++ .../exceptions/HandlerNotFoundException.java | 51 ++ .../exceptions/HandlerSetupFailureException.java | 55 ++ .../server/exceptions/HandlingException.java | 48 ++ .../server/exceptions/NotAHandlerException.java | 34 ++ .../exceptions/UnknownFunctionException.java | 37 ++ src/uk/org/ury/backend/server/package.html | 23 + src/uk/org/ury/client/Client.java | 60 --- src/uk/org/ury/client/test/ClientTest.java | 57 -- src/uk/org/ury/common/library/LibraryUtils.java | 144 +++++ .../library/exceptions/EmptySearchException.java | 49 ++ .../org/ury/common/library/item/LibraryItem.java | 26 + .../common/library/item/LibraryItemProperty.java | 62 +++ src/uk/org/ury/common/protocol/Directive.java | 18 + src/uk/org/ury/common/protocol/ProtocolUtils.java | 85 +++ src/uk/org/ury/common/protocol/Status.java | 17 + .../exceptions/DecodeFailureException.java | 32 ++ .../exceptions/InvalidMessageException.java | 33 ++ src/uk/org/ury/common/show/ShowChannel.java | 120 +++++ src/uk/org/ury/common/show/ShowUtils.java | 190 +++++++ src/uk/org/ury/common/show/ShowUtils.properties | 4 + src/uk/org/ury/common/show/item/ShowItem.java | 68 +++ .../org/ury/common/show/item/ShowItemProperty.java | 26 + src/uk/org/ury/common/show/item/package.html | 14 + src/uk/org/ury/config/Auth.java | 36 -- src/uk/org/ury/config/ConfigReader.java | 115 ---- src/uk/org/ury/config/Database.java | 45 -- src/uk/org/ury/database/DatabaseDriver.java | 166 ------ src/uk/org/ury/database/DatabaseItem.java | 80 --- src/uk/org/ury/database/UserClass.java | 38 -- .../exceptions/ConnectionFailureException.java | 44 -- .../exceptions/MissingCredentialsException.java | 52 -- .../exceptions/MissingPropertyException.java | 47 -- .../database/exceptions/QueryFailureException.java | 45 -- src/uk/org/ury/database/exceptions/package.html | 11 - src/uk/org/ury/database/package.html | 15 - src/uk/org/ury/frontend/FrontendApplet.java | 2 +- src/uk/org/ury/frontend/FrontendFrame.java | 584 +++++++++----------- src/uk/org/ury/frontend/FrontendModule.java | 42 +- src/uk/org/ury/frontend/client/Client.java | 60 +++ .../org/ury/frontend/client/test/ClientTest.java | 57 ++ .../frontend/cpanels/menu/DemoControlPanel.java | 47 ++ .../frontend/cpanels/menu/demo_control_panel.xml | 7 + .../frontend/cpanels/show/LibraryControlPanel.java | 48 ++ .../cpanels/show/library_control_panel.xml | 9 + .../modules/library/LibraryTableModel.java | 184 +++++++ .../frontend/modules/library/LibraryViewer.java | 159 ++++++ .../modules/library/LibraryViewer.properties | 22 + .../modules/library/LibraryViewerPanel.java | 219 ++++++++ .../modules/library/library_viewer_gui.xml | 32 ++ src/uk/org/ury/frontend/modules/menu/DemoMenu.java | 64 +++ .../ury/frontend/modules/menu/DemoMenuPanel.java | 68 +++ .../ury/frontend/modules/show/ChannelPanel.java | 84 +++ .../org/ury/frontend/modules/show/ShowViewer.java | 118 ++++ .../ury/frontend/modules/show/ShowViewerPanel.java | 133 +++++ src/uk/org/ury/frontend/modules/show/TrackBin.java | 56 ++ .../ury/frontend/modules/show/channel_panel.xml | 36 ++ .../ury/frontend/modules/show/show_viewer_gui.xml | 43 ++ .../frontend/modules/show/show_viewer_gui_old.xml | 46 ++ .../modules/show/show_viewer_gui_panels.xml | 43 ++ src/uk/org/ury/frontend/modules/show/track_bin.xml | 10 + .../ury/frontend/testrig/ApplicationLauncher.java | 27 + src/uk/org/ury/frontend/testrig/Launcher.java | 17 + src/uk/org/ury/library/LibraryRequestHandler.java | 188 ------- src/uk/org/ury/library/LibraryUtils.java | 144 ----- .../library/exceptions/EmptySearchException.java | 49 -- src/uk/org/ury/library/item/LibraryItem.java | 26 - .../org/ury/library/item/LibraryItemProperty.java | 62 --- .../org/ury/library/viewer/LibraryTableModel.java | 184 ------- src/uk/org/ury/library/viewer/LibraryViewer.java | 159 ------ .../ury/library/viewer/LibraryViewer.properties | 22 - .../org/ury/library/viewer/LibraryViewerPanel.java | 218 -------- .../org/ury/library/viewer/library_viewer_gui.xml | 32 -- src/uk/org/ury/protocol/Directive.java | 18 - src/uk/org/ury/protocol/ProtocolUtils.java | 85 --- src/uk/org/ury/protocol/Status.java | 17 - .../exceptions/DecodeFailureException.java | 32 -- .../exceptions/InvalidMessageException.java | 33 -- src/uk/org/ury/server/AbstractRequestHandler.java | 254 --------- src/uk/org/ury/server/ApiRequestHandler.java | 42 -- src/uk/org/ury/server/HttpHandler.java | 205 ------- src/uk/org/ury/server/HttpListenerThread.java | 127 ----- src/uk/org/ury/server/HttpWorkerThread.java | 104 ---- src/uk/org/ury/server/Server.java | 99 ---- src/uk/org/ury/server/ServerRequestHandler.java | 95 ---- .../ury/server/exceptions/BadRequestException.java | 47 -- .../server/exceptions/HandleFailureException.java | 46 -- .../exceptions/HandlerNotFoundException.java | 51 -- .../exceptions/HandlerSetupFailureException.java | 55 -- .../ury/server/exceptions/HandlingException.java | 48 -- .../server/exceptions/NotAHandlerException.java | 34 -- .../exceptions/UnknownFunctionException.java | 37 -- src/uk/org/ury/server/package.html | 23 - src/uk/org/ury/show/ShowChannel.java | 120 ----- src/uk/org/ury/show/ShowUtils.java | 190 ------- src/uk/org/ury/show/ShowUtils.properties | 4 - src/uk/org/ury/show/item/ShowItem.java | 68 --- src/uk/org/ury/show/item/ShowItemProperty.java | 26 - src/uk/org/ury/show/item/package.html | 14 - src/uk/org/ury/show/viewer/ChannelPanel.java | 84 --- .../org/ury/show/viewer/LibraryControlPanel.java | 48 -- src/uk/org/ury/show/viewer/ShowViewer.java | 118 ---- src/uk/org/ury/show/viewer/ShowViewerPanel.java | 133 ----- src/uk/org/ury/show/viewer/TrackBin.java | 56 -- src/uk/org/ury/show/viewer/channel_panel.xml | 36 -- .../org/ury/show/viewer/library_control_panel.xml | 9 - src/uk/org/ury/show/viewer/show_viewer_gui.xml | 43 -- src/uk/org/ury/show/viewer/show_viewer_gui_old.xml | 46 -- .../org/ury/show/viewer/show_viewer_gui_panels.xml | 43 -- src/uk/org/ury/show/viewer/track_bin.xml | 10 - src/uk/org/ury/testrig/ApplicationLauncher.java | 32 -- src/uk/org/ury/testrig/DemoControlPanel.java | 47 -- src/uk/org/ury/testrig/DemoMenu.java | 64 --- src/uk/org/ury/testrig/DemoMenuPanel.java | 90 ---- src/uk/org/ury/testrig/Launcher.java | 17 - src/uk/org/ury/testrig/demo_control_panel.xml | 7 - 393 files changed, 44409 insertions(+), 6114 deletions(-) create mode 100644 doc/uk/org/ury/backend/config/Auth.html create mode 100644 doc/uk/org/ury/backend/config/ConfigReader.html create mode 100644 doc/uk/org/ury/backend/config/Database.html create mode 100644 doc/uk/org/ury/backend/config/class-use/Auth.html create mode 100644 doc/uk/org/ury/backend/config/class-use/ConfigReader.html create mode 100644 doc/uk/org/ury/backend/config/class-use/Database.html create mode 100644 doc/uk/org/ury/backend/config/package-frame.html create mode 100644 doc/uk/org/ury/backend/config/package-summary.html create mode 100644 doc/uk/org/ury/backend/config/package-tree.html create mode 100644 doc/uk/org/ury/backend/config/package-use.html create mode 100644 doc/uk/org/ury/backend/database/DatabaseDriver.html create mode 100644 doc/uk/org/ury/backend/database/DatabaseItem.html create mode 100644 doc/uk/org/ury/backend/database/UserClass.html create mode 100644 doc/uk/org/ury/backend/database/class-use/DatabaseDriver.html create mode 100644 doc/uk/org/ury/backend/database/class-use/DatabaseItem.html create mode 100644 doc/uk/org/ury/backend/database/class-use/UserClass.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/ConnectionFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/MissingCredentialsException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/MissingPropertyException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/QueryFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/ConnectionFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/MissingCredentialsException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/MissingPropertyException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/QueryFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-use.html create mode 100644 doc/uk/org/ury/backend/database/package-frame.html create mode 100644 doc/uk/org/ury/backend/database/package-summary.html create mode 100644 doc/uk/org/ury/backend/database/package-tree.html create mode 100644 doc/uk/org/ury/backend/database/package-use.html create mode 100644 doc/uk/org/ury/backend/handlers/LibraryRequestHandler.html create mode 100644 doc/uk/org/ury/backend/handlers/class-use/LibraryRequestHandler.html create mode 100644 doc/uk/org/ury/backend/handlers/package-frame.html create mode 100644 doc/uk/org/ury/backend/handlers/package-summary.html create mode 100644 doc/uk/org/ury/backend/handlers/package-tree.html create mode 100644 doc/uk/org/ury/backend/handlers/package-use.html create mode 100644 doc/uk/org/ury/backend/server/AbstractRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/ApiRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/HttpHandler.html create mode 100644 doc/uk/org/ury/backend/server/HttpListenerThread.html create mode 100644 doc/uk/org/ury/backend/server/HttpWorkerThread.html create mode 100644 doc/uk/org/ury/backend/server/Server.html create mode 100644 doc/uk/org/ury/backend/server/ServerRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/class-use/AbstractRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/class-use/ApiRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/class-use/HttpHandler.html create mode 100644 doc/uk/org/ury/backend/server/class-use/HttpListenerThread.html create mode 100644 doc/uk/org/ury/backend/server/class-use/HttpWorkerThread.html create mode 100644 doc/uk/org/ury/backend/server/class-use/Server.html create mode 100644 doc/uk/org/ury/backend/server/class-use/ServerRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/BadRequestException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/HandleFailureException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/HandlerNotFoundException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/HandlingException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/NotAHandlerException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/UnknownFunctionException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/BadRequestException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/HandleFailureException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/HandlerNotFoundException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/HandlerSetupFailureException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/HandlingException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/NotAHandlerException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/UnknownFunctionException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/package-use.html create mode 100644 doc/uk/org/ury/backend/server/package-frame.html create mode 100644 doc/uk/org/ury/backend/server/package-summary.html create mode 100644 doc/uk/org/ury/backend/server/package-tree.html create mode 100644 doc/uk/org/ury/backend/server/package-use.html create mode 100644 doc/uk/org/ury/common/library/LibraryUtils.html create mode 100644 doc/uk/org/ury/common/library/class-use/LibraryUtils.html create mode 100644 doc/uk/org/ury/common/library/exceptions/EmptySearchException.html create mode 100644 doc/uk/org/ury/common/library/exceptions/class-use/EmptySearchException.html create mode 100644 doc/uk/org/ury/common/library/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/common/library/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/common/library/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/common/library/exceptions/package-use.html create mode 100644 doc/uk/org/ury/common/library/item/LibraryItem.html create mode 100644 doc/uk/org/ury/common/library/item/LibraryItemProperty.html create mode 100644 doc/uk/org/ury/common/library/item/class-use/LibraryItem.html create mode 100644 doc/uk/org/ury/common/library/item/class-use/LibraryItemProperty.html create mode 100644 doc/uk/org/ury/common/library/item/package-frame.html create mode 100644 doc/uk/org/ury/common/library/item/package-summary.html create mode 100644 doc/uk/org/ury/common/library/item/package-tree.html create mode 100644 doc/uk/org/ury/common/library/item/package-use.html create mode 100644 doc/uk/org/ury/common/library/package-frame.html create mode 100644 doc/uk/org/ury/common/library/package-summary.html create mode 100644 doc/uk/org/ury/common/library/package-tree.html create mode 100644 doc/uk/org/ury/common/library/package-use.html create mode 100644 doc/uk/org/ury/common/protocol/Directive.html create mode 100644 doc/uk/org/ury/common/protocol/ProtocolUtils.html create mode 100644 doc/uk/org/ury/common/protocol/Status.html create mode 100644 doc/uk/org/ury/common/protocol/class-use/Directive.html create mode 100644 doc/uk/org/ury/common/protocol/class-use/ProtocolUtils.html create mode 100644 doc/uk/org/ury/common/protocol/class-use/Status.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/DecodeFailureException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/InvalidMessageException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/class-use/DecodeFailureException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/class-use/InvalidMessageException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/package-use.html create mode 100644 doc/uk/org/ury/common/protocol/package-frame.html create mode 100644 doc/uk/org/ury/common/protocol/package-summary.html create mode 100644 doc/uk/org/ury/common/protocol/package-tree.html create mode 100644 doc/uk/org/ury/common/protocol/package-use.html create mode 100644 doc/uk/org/ury/common/show/ShowChannel.html create mode 100644 doc/uk/org/ury/common/show/ShowUtils.html create mode 100644 doc/uk/org/ury/common/show/class-use/ShowChannel.html create mode 100644 doc/uk/org/ury/common/show/class-use/ShowUtils.html create mode 100644 doc/uk/org/ury/common/show/item/ShowItem.html create mode 100644 doc/uk/org/ury/common/show/item/ShowItemProperty.html create mode 100644 doc/uk/org/ury/common/show/item/class-use/ShowItem.html create mode 100644 doc/uk/org/ury/common/show/item/class-use/ShowItemProperty.html create mode 100644 doc/uk/org/ury/common/show/item/package-frame.html create mode 100644 doc/uk/org/ury/common/show/item/package-summary.html create mode 100644 doc/uk/org/ury/common/show/item/package-tree.html create mode 100644 doc/uk/org/ury/common/show/item/package-use.html create mode 100644 doc/uk/org/ury/common/show/package-frame.html create mode 100644 doc/uk/org/ury/common/show/package-summary.html create mode 100644 doc/uk/org/ury/common/show/package-tree.html create mode 100644 doc/uk/org/ury/common/show/package-use.html create mode 100644 doc/uk/org/ury/frontend/client/Client.html create mode 100644 doc/uk/org/ury/frontend/client/class-use/Client.html create mode 100644 doc/uk/org/ury/frontend/client/package-frame.html create mode 100644 doc/uk/org/ury/frontend/client/package-summary.html create mode 100644 doc/uk/org/ury/frontend/client/package-tree.html create mode 100644 doc/uk/org/ury/frontend/client/package-use.html create mode 100644 doc/uk/org/ury/frontend/client/test/ClientTest.html create mode 100644 doc/uk/org/ury/frontend/client/test/class-use/ClientTest.html create mode 100644 doc/uk/org/ury/frontend/client/test/package-frame.html create mode 100644 doc/uk/org/ury/frontend/client/test/package-summary.html create mode 100644 doc/uk/org/ury/frontend/client/test/package-tree.html create mode 100644 doc/uk/org/ury/frontend/client/test/package-use.html create mode 100644 doc/uk/org/ury/frontend/cpanels/menu/DemoControlPanel.html create mode 100644 doc/uk/org/ury/frontend/cpanels/menu/class-use/DemoControlPanel.html create mode 100644 doc/uk/org/ury/frontend/cpanels/menu/package-frame.html create mode 100644 doc/uk/org/ury/frontend/cpanels/menu/package-summary.html create mode 100644 doc/uk/org/ury/frontend/cpanels/menu/package-tree.html create mode 100644 doc/uk/org/ury/frontend/cpanels/menu/package-use.html create mode 100644 doc/uk/org/ury/frontend/cpanels/show/LibraryControlPanel.html create mode 100644 doc/uk/org/ury/frontend/cpanels/show/class-use/LibraryControlPanel.html create mode 100644 doc/uk/org/ury/frontend/cpanels/show/package-frame.html create mode 100644 doc/uk/org/ury/frontend/cpanels/show/package-summary.html create mode 100644 doc/uk/org/ury/frontend/cpanels/show/package-tree.html create mode 100644 doc/uk/org/ury/frontend/cpanels/show/package-use.html create mode 100644 doc/uk/org/ury/frontend/modules/library/LibraryTableModel.html create mode 100644 doc/uk/org/ury/frontend/modules/library/LibraryViewer.html create mode 100644 doc/uk/org/ury/frontend/modules/library/LibraryViewerPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/library/class-use/LibraryTableModel.html create mode 100644 doc/uk/org/ury/frontend/modules/library/class-use/LibraryViewer.html create mode 100644 doc/uk/org/ury/frontend/modules/library/class-use/LibraryViewerPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/library/package-frame.html create mode 100644 doc/uk/org/ury/frontend/modules/library/package-summary.html create mode 100644 doc/uk/org/ury/frontend/modules/library/package-tree.html create mode 100644 doc/uk/org/ury/frontend/modules/library/package-use.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/DemoMenu.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/DemoMenuPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/class-use/DemoMenu.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/class-use/DemoMenuPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/package-frame.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/package-summary.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/package-tree.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/package-use.html create mode 100644 doc/uk/org/ury/frontend/modules/show/ChannelPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/show/ShowViewer.html create mode 100644 doc/uk/org/ury/frontend/modules/show/ShowViewerPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/show/TrackBin.html create mode 100644 doc/uk/org/ury/frontend/modules/show/class-use/ChannelPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/show/class-use/ShowViewer.html create mode 100644 doc/uk/org/ury/frontend/modules/show/class-use/ShowViewerPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/show/class-use/TrackBin.html create mode 100644 doc/uk/org/ury/frontend/modules/show/package-frame.html create mode 100644 doc/uk/org/ury/frontend/modules/show/package-summary.html create mode 100644 doc/uk/org/ury/frontend/modules/show/package-tree.html create mode 100644 doc/uk/org/ury/frontend/modules/show/package-use.html create mode 100644 doc/uk/org/ury/frontend/testrig/ApplicationLauncher.html create mode 100644 doc/uk/org/ury/frontend/testrig/Launcher.html create mode 100644 doc/uk/org/ury/frontend/testrig/class-use/ApplicationLauncher.html create mode 100644 doc/uk/org/ury/frontend/testrig/class-use/Launcher.html create mode 100644 doc/uk/org/ury/frontend/testrig/package-frame.html create mode 100644 doc/uk/org/ury/frontend/testrig/package-summary.html create mode 100644 doc/uk/org/ury/frontend/testrig/package-tree.html create mode 100644 doc/uk/org/ury/frontend/testrig/package-use.html create mode 100644 src/uk/org/ury/backend/config/Auth.java create mode 100644 src/uk/org/ury/backend/config/ConfigReader.java create mode 100644 src/uk/org/ury/backend/config/Database.java create mode 100644 src/uk/org/ury/backend/database/DatabaseDriver.java create mode 100644 src/uk/org/ury/backend/database/DatabaseItem.java create mode 100644 src/uk/org/ury/backend/database/UserClass.java create mode 100644 src/uk/org/ury/backend/database/exceptions/ConnectionFailureException.java create mode 100644 src/uk/org/ury/backend/database/exceptions/MissingCredentialsException.java create mode 100644 src/uk/org/ury/backend/database/exceptions/MissingPropertyException.java create mode 100644 src/uk/org/ury/backend/database/exceptions/QueryFailureException.java create mode 100644 src/uk/org/ury/backend/database/exceptions/package.html create mode 100644 src/uk/org/ury/backend/database/package.html create mode 100644 src/uk/org/ury/backend/handlers/LibraryRequestHandler.java create mode 100644 src/uk/org/ury/backend/server/AbstractRequestHandler.java create mode 100644 src/uk/org/ury/backend/server/ApiRequestHandler.java create mode 100644 src/uk/org/ury/backend/server/HttpHandler.java create mode 100644 src/uk/org/ury/backend/server/HttpListenerThread.java create mode 100644 src/uk/org/ury/backend/server/HttpWorkerThread.java create mode 100644 src/uk/org/ury/backend/server/Server.java create mode 100644 src/uk/org/ury/backend/server/ServerRequestHandler.java create mode 100644 src/uk/org/ury/backend/server/exceptions/BadRequestException.java create mode 100644 src/uk/org/ury/backend/server/exceptions/HandleFailureException.java create mode 100644 src/uk/org/ury/backend/server/exceptions/HandlerNotFoundException.java create mode 100644 src/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.java create mode 100644 src/uk/org/ury/backend/server/exceptions/HandlingException.java create mode 100644 src/uk/org/ury/backend/server/exceptions/NotAHandlerException.java create mode 100644 src/uk/org/ury/backend/server/exceptions/UnknownFunctionException.java create mode 100644 src/uk/org/ury/backend/server/package.html delete mode 100644 src/uk/org/ury/client/Client.java delete mode 100644 src/uk/org/ury/client/test/ClientTest.java create mode 100644 src/uk/org/ury/common/library/LibraryUtils.java create mode 100644 src/uk/org/ury/common/library/exceptions/EmptySearchException.java create mode 100644 src/uk/org/ury/common/library/item/LibraryItem.java create mode 100644 src/uk/org/ury/common/library/item/LibraryItemProperty.java create mode 100644 src/uk/org/ury/common/protocol/Directive.java create mode 100644 src/uk/org/ury/common/protocol/ProtocolUtils.java create mode 100644 src/uk/org/ury/common/protocol/Status.java create mode 100644 src/uk/org/ury/common/protocol/exceptions/DecodeFailureException.java create mode 100644 src/uk/org/ury/common/protocol/exceptions/InvalidMessageException.java create mode 100644 src/uk/org/ury/common/show/ShowChannel.java create mode 100644 src/uk/org/ury/common/show/ShowUtils.java create mode 100644 src/uk/org/ury/common/show/ShowUtils.properties create mode 100644 src/uk/org/ury/common/show/item/ShowItem.java create mode 100644 src/uk/org/ury/common/show/item/ShowItemProperty.java create mode 100644 src/uk/org/ury/common/show/item/package.html delete mode 100644 src/uk/org/ury/config/Auth.java delete mode 100644 src/uk/org/ury/config/ConfigReader.java delete mode 100644 src/uk/org/ury/config/Database.java delete mode 100644 src/uk/org/ury/database/DatabaseDriver.java delete mode 100644 src/uk/org/ury/database/DatabaseItem.java delete mode 100644 src/uk/org/ury/database/UserClass.java delete mode 100644 src/uk/org/ury/database/exceptions/ConnectionFailureException.java delete mode 100644 src/uk/org/ury/database/exceptions/MissingCredentialsException.java delete mode 100644 src/uk/org/ury/database/exceptions/MissingPropertyException.java delete mode 100644 src/uk/org/ury/database/exceptions/QueryFailureException.java delete mode 100644 src/uk/org/ury/database/exceptions/package.html delete mode 100644 src/uk/org/ury/database/package.html create mode 100644 src/uk/org/ury/frontend/client/Client.java create mode 100644 src/uk/org/ury/frontend/client/test/ClientTest.java create mode 100644 src/uk/org/ury/frontend/cpanels/menu/DemoControlPanel.java create mode 100644 src/uk/org/ury/frontend/cpanels/menu/demo_control_panel.xml create mode 100644 src/uk/org/ury/frontend/cpanels/show/LibraryControlPanel.java create mode 100644 src/uk/org/ury/frontend/cpanels/show/library_control_panel.xml create mode 100644 src/uk/org/ury/frontend/modules/library/LibraryTableModel.java create mode 100644 src/uk/org/ury/frontend/modules/library/LibraryViewer.java create mode 100644 src/uk/org/ury/frontend/modules/library/LibraryViewer.properties create mode 100644 src/uk/org/ury/frontend/modules/library/LibraryViewerPanel.java create mode 100644 src/uk/org/ury/frontend/modules/library/library_viewer_gui.xml create mode 100644 src/uk/org/ury/frontend/modules/menu/DemoMenu.java create mode 100644 src/uk/org/ury/frontend/modules/menu/DemoMenuPanel.java create mode 100644 src/uk/org/ury/frontend/modules/show/ChannelPanel.java create mode 100644 src/uk/org/ury/frontend/modules/show/ShowViewer.java create mode 100644 src/uk/org/ury/frontend/modules/show/ShowViewerPanel.java create mode 100644 src/uk/org/ury/frontend/modules/show/TrackBin.java create mode 100644 src/uk/org/ury/frontend/modules/show/channel_panel.xml create mode 100644 src/uk/org/ury/frontend/modules/show/show_viewer_gui.xml create mode 100644 src/uk/org/ury/frontend/modules/show/show_viewer_gui_old.xml create mode 100644 src/uk/org/ury/frontend/modules/show/show_viewer_gui_panels.xml create mode 100644 src/uk/org/ury/frontend/modules/show/track_bin.xml create mode 100644 src/uk/org/ury/frontend/testrig/ApplicationLauncher.java create mode 100644 src/uk/org/ury/frontend/testrig/Launcher.java delete mode 100644 src/uk/org/ury/library/LibraryRequestHandler.java delete mode 100644 src/uk/org/ury/library/LibraryUtils.java delete mode 100644 src/uk/org/ury/library/exceptions/EmptySearchException.java delete mode 100644 src/uk/org/ury/library/item/LibraryItem.java delete mode 100644 src/uk/org/ury/library/item/LibraryItemProperty.java delete mode 100644 src/uk/org/ury/library/viewer/LibraryTableModel.java delete mode 100644 src/uk/org/ury/library/viewer/LibraryViewer.java delete mode 100644 src/uk/org/ury/library/viewer/LibraryViewer.properties delete mode 100644 src/uk/org/ury/library/viewer/LibraryViewerPanel.java delete mode 100644 src/uk/org/ury/library/viewer/library_viewer_gui.xml delete mode 100644 src/uk/org/ury/protocol/Directive.java delete mode 100644 src/uk/org/ury/protocol/ProtocolUtils.java delete mode 100644 src/uk/org/ury/protocol/Status.java delete mode 100644 src/uk/org/ury/protocol/exceptions/DecodeFailureException.java delete mode 100644 src/uk/org/ury/protocol/exceptions/InvalidMessageException.java delete mode 100644 src/uk/org/ury/server/AbstractRequestHandler.java delete mode 100644 src/uk/org/ury/server/ApiRequestHandler.java delete mode 100644 src/uk/org/ury/server/HttpHandler.java delete mode 100644 src/uk/org/ury/server/HttpListenerThread.java delete mode 100644 src/uk/org/ury/server/HttpWorkerThread.java delete mode 100644 src/uk/org/ury/server/Server.java delete mode 100644 src/uk/org/ury/server/ServerRequestHandler.java delete mode 100644 src/uk/org/ury/server/exceptions/BadRequestException.java delete mode 100644 src/uk/org/ury/server/exceptions/HandleFailureException.java delete mode 100644 src/uk/org/ury/server/exceptions/HandlerNotFoundException.java delete mode 100644 src/uk/org/ury/server/exceptions/HandlerSetupFailureException.java delete mode 100644 src/uk/org/ury/server/exceptions/HandlingException.java delete mode 100644 src/uk/org/ury/server/exceptions/NotAHandlerException.java delete mode 100644 src/uk/org/ury/server/exceptions/UnknownFunctionException.java delete mode 100644 src/uk/org/ury/server/package.html delete mode 100644 src/uk/org/ury/show/ShowChannel.java delete mode 100644 src/uk/org/ury/show/ShowUtils.java delete mode 100644 src/uk/org/ury/show/ShowUtils.properties delete mode 100644 src/uk/org/ury/show/item/ShowItem.java delete mode 100644 src/uk/org/ury/show/item/ShowItemProperty.java delete mode 100644 src/uk/org/ury/show/item/package.html delete mode 100644 src/uk/org/ury/show/viewer/ChannelPanel.java delete mode 100644 src/uk/org/ury/show/viewer/LibraryControlPanel.java delete mode 100644 src/uk/org/ury/show/viewer/ShowViewer.java delete mode 100644 src/uk/org/ury/show/viewer/ShowViewerPanel.java delete mode 100644 src/uk/org/ury/show/viewer/TrackBin.java delete mode 100644 src/uk/org/ury/show/viewer/channel_panel.xml delete mode 100644 src/uk/org/ury/show/viewer/library_control_panel.xml delete mode 100644 src/uk/org/ury/show/viewer/show_viewer_gui.xml delete mode 100644 src/uk/org/ury/show/viewer/show_viewer_gui_old.xml delete mode 100644 src/uk/org/ury/show/viewer/show_viewer_gui_panels.xml delete mode 100644 src/uk/org/ury/show/viewer/track_bin.xml delete mode 100644 src/uk/org/ury/testrig/ApplicationLauncher.java delete mode 100644 src/uk/org/ury/testrig/DemoControlPanel.java delete mode 100644 src/uk/org/ury/testrig/DemoMenu.java delete mode 100644 src/uk/org/ury/testrig/DemoMenuPanel.java delete mode 100644 src/uk/org/ury/testrig/Launcher.java delete mode 100644 src/uk/org/ury/testrig/demo_control_panel.xml diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html index e5749f5..3c145df 100644 --- a/doc/allclasses-frame.html +++ b/doc/allclasses-frame.html @@ -2,7 +2,7 @@ - + All Classes @@ -23,43 +23,43 @@ All Classes AbstractFrontendModule
-AbstractRequestHandler +AbstractRequestHandler
-ApiRequestHandler +ApiRequestHandler
-ApplicationLauncher +ApplicationLauncher
-Auth +Auth
-BadRequestException +BadRequestException
-ChannelPanel +ChannelPanel
-Client +Client
-ClientTest +ClientTest
-ConfigReader +ConfigReader
-ConnectionFailureException +ConnectionFailureException
-Database +Database
-DatabaseDriver +DatabaseDriver
-DatabaseItem +DatabaseItem
-DecodeFailureException +DecodeFailureException
-DemoControlPanel +DemoControlPanel
-DemoMenu +DemoMenu
-DemoMenuPanel +DemoMenuPanel
-Directive +Directive
-EmptySearchException +EmptySearchException
FrontendApplet
@@ -81,79 +81,79 @@ All Classes
FrontendSubBanner
-HandleFailureException +HandleFailureException
-HandlerNotFoundException +HandlerNotFoundException
-HandlerSetupFailureException +HandlerSetupFailureException
-HandlingException +HandlingException
HintField
-HttpHandler +HttpHandler
-HttpListenerThread +HttpListenerThread
-HttpWorkerThread +HttpWorkerThread
-InvalidMessageException +InvalidMessageException
-Launcher +Launcher
-LibraryControlPanel +LibraryControlPanel
-LibraryItem +LibraryItem
-LibraryItemProperty +LibraryItemProperty
-LibraryRequestHandler +LibraryRequestHandler
-LibraryTableModel +LibraryTableModel
-LibraryUtils +LibraryUtils
-LibraryViewer +LibraryViewer
-LibraryViewerPanel +LibraryViewerPanel
LoadFailureException
-MissingCredentialsException +MissingCredentialsException
-MissingPropertyException +MissingPropertyException
-NotAHandlerException +NotAHandlerException
-ProtocolUtils +ProtocolUtils
-QueryFailureException +QueryFailureException
-Server +Server
-ServerRequestHandler +ServerRequestHandler
-ShowChannel +ShowChannel
-ShowItem +ShowItem
-ShowItemProperty +ShowItemProperty
-ShowUtils +ShowUtils
-ShowViewer +ShowViewer
-ShowViewerPanel +ShowViewerPanel
-Status +Status
-TrackBin +TrackBin
UICreationFailureException
-UnknownFunctionException +UnknownFunctionException
-UserClass +UserClass
diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html index 1115f5e..e10982b 100644 --- a/doc/allclasses-noframe.html +++ b/doc/allclasses-noframe.html @@ -2,7 +2,7 @@ - + All Classes @@ -23,43 +23,43 @@ All Classes AbstractFrontendModule
-AbstractRequestHandler +AbstractRequestHandler
-ApiRequestHandler +ApiRequestHandler
-ApplicationLauncher +ApplicationLauncher
-Auth +Auth
-BadRequestException +BadRequestException
-ChannelPanel +ChannelPanel
-Client +Client
-ClientTest +ClientTest
-ConfigReader +ConfigReader
-ConnectionFailureException +ConnectionFailureException
-Database +Database
-DatabaseDriver +DatabaseDriver
-DatabaseItem +DatabaseItem
-DecodeFailureException +DecodeFailureException
-DemoControlPanel +DemoControlPanel
-DemoMenu +DemoMenu
-DemoMenuPanel +DemoMenuPanel
-Directive +Directive
-EmptySearchException +EmptySearchException
FrontendApplet
@@ -81,79 +81,79 @@ All Classes
FrontendSubBanner
-HandleFailureException +HandleFailureException
-HandlerNotFoundException +HandlerNotFoundException
-HandlerSetupFailureException +HandlerSetupFailureException
-HandlingException +HandlingException
HintField
-HttpHandler +HttpHandler
-HttpListenerThread +HttpListenerThread
-HttpWorkerThread +HttpWorkerThread
-InvalidMessageException +InvalidMessageException
-Launcher +Launcher
-LibraryControlPanel +LibraryControlPanel
-LibraryItem +LibraryItem
-LibraryItemProperty +LibraryItemProperty
-LibraryRequestHandler +LibraryRequestHandler
-LibraryTableModel +LibraryTableModel
-LibraryUtils +LibraryUtils
-LibraryViewer +LibraryViewer
-LibraryViewerPanel +LibraryViewerPanel
LoadFailureException
-MissingCredentialsException +MissingCredentialsException
-MissingPropertyException +MissingPropertyException
-NotAHandlerException +NotAHandlerException
-ProtocolUtils +ProtocolUtils
-QueryFailureException +QueryFailureException
-Server +Server
-ServerRequestHandler +ServerRequestHandler
-ShowChannel +ShowChannel
-ShowItem +ShowItem
-ShowItemProperty +ShowItemProperty
-ShowUtils +ShowUtils
-ShowViewer +ShowViewer
-ShowViewerPanel +ShowViewerPanel
-Status +Status
-TrackBin +TrackBin
UICreationFailureException
-UnknownFunctionException +UnknownFunctionException
-UserClass +UserClass
diff --git a/doc/constant-values.html b/doc/constant-values.html index 94d50b9..85766ab 100644 --- a/doc/constant-values.html +++ b/doc/constant-values.html @@ -2,7 +2,7 @@ - + Constant Field Values @@ -100,24 +100,24 @@ uk.org.* - + - - + - - + - - + @@ -130,12 +130,12 @@ uk.org.*
uk.org.ury.server.Serveruk.org.ury.backend.server.Server
+ public static final java.lang.StringDOCTYPEDOCTYPE "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\"http://www.w3.org/TR/html4/strict.dtd\">"
+ public static final java.lang.StringINDEX_HTMLINDEX_HTML "\n<html>\n <head>\n <title>SLUT 0.0</title>\n </head>\n <body>\n <h1>Welcome to the SLUT 0.0 server</h1>\n <p>This server exposes a class-based API for accessing\n the internals of the SLUT 0.0 system.</p>\n <p>See the documentation for details.</p>\n </body>\n</html>"
+ public static final java.lang.StringSERVER_VERSIONSERVER_VERSION "SLUT 0.0"
- + - - + @@ -148,13 +148,13 @@ uk.org.*
uk.org.ury.show.ShowUtilsuk.org.ury.common.show.ShowUtils
+ public static final intNUM_CHANNELSNUM_CHANNELS 3
- + - - - + + diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html index b585e26..6c8f3bc 100644 --- a/doc/deprecated-list.html +++ b/doc/deprecated-list.html @@ -2,7 +2,7 @@ - + Deprecated List diff --git a/doc/help-doc.html b/doc/help-doc.html index 5f7caeb..992a64f 100644 --- a/doc/help-doc.html +++ b/doc/help-doc.html @@ -2,7 +2,7 @@ - + API Help diff --git a/doc/index-files/index-1.html b/doc/index-files/index-1.html index eb48bf3..7bc89e8 100644 --- a/doc/index-files/index-1.html +++ b/doc/index-files/index-1.html @@ -2,7 +2,7 @@ - + A-Index @@ -85,25 +85,25 @@ function windowTitle()
AbstractFrontendModule - Class in uk.org.ury.frontend
An abstract implementation of the FrontendModule interface.
AbstractFrontendModule() - Constructor for class uk.org.ury.frontend.AbstractFrontendModule
  -
AbstractRequestHandler - Class in uk.org.ury.server
An abstract request handler for HttpCore, providing basic functionality such - as uniform error response.
AbstractRequestHandler(Server, String) - -Constructor for class uk.org.ury.server.AbstractRequestHandler +
AbstractRequestHandler - Class in uk.org.ury.backend.server
An abstract request handler for HttpCore, providing basic functionality such + as uniform error response.
AbstractRequestHandler(Server, String) - +Constructor for class uk.org.ury.backend.server.AbstractRequestHandler
Constructs a new AbstractRequestHandler. -
add(int, ShowItem) - -Method in class uk.org.ury.show.ShowChannel +
add(int, ShowItem) - +Method in class uk.org.ury.common.show.ShowChannel
Adds a new item to the channel. -
add(ShowItem) - -Method in class uk.org.ury.show.ShowChannel +
add(ShowItem) - +Method in class uk.org.ury.common.show.ShowChannel
Adds a new item to the end of the channel. -
ApiRequestHandler - Interface in uk.org.ury.server
Interface for classes that can handle requests addressed to their - class name from the main server.
ApplicationLauncher - Class in uk.org.ury.testrig
An application-based entry point into the frontend.
ApplicationLauncher() - -Constructor for class uk.org.ury.testrig.ApplicationLauncher +
ApiRequestHandler - Interface in uk.org.ury.backend.server
Interface for classes that can handle requests addressed to their + class name from the main server.
ApplicationLauncher - Class in uk.org.ury.frontend.testrig
An application-based entry point into the frontend.
ApplicationLauncher() - +Constructor for class uk.org.ury.frontend.testrig.ApplicationLauncher
  -
asResponse() - -Method in class uk.org.ury.database.DatabaseItem +
asResponse() - +Method in class uk.org.ury.backend.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 +
Auth - Class in uk.org.ury.backend.config
A login authorisation configuration
Auth(String, String) - +Constructor for class uk.org.ury.backend.config.Auth
Create a login auth object
diff --git a/doc/index-files/index-10.html b/doc/index-files/index-10.html index d093928..4ffcadd 100644 --- a/doc/index-files/index-10.html +++ b/doc/index-files/index-10.html @@ -2,7 +2,7 @@ - + L-Index @@ -82,27 +82,27 @@ function windowTitle()

L

-
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 +
Launcher - Interface in uk.org.ury.frontend.testrig
Interface for entry points into the frontend.
LibraryControlPanel - Class in uk.org.ury.frontend.cpanels.show
Control panel for the demo system.
LibraryControlPanel() - +Constructor for class uk.org.ury.frontend.cpanels.show.LibraryControlPanel
Construct a new LibraryControlPanel. -
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 +
LibraryItem - Class in uk.org.ury.common.library.item
An item in the URY library.
LibraryItem(Map<LibraryItemProperty, String>) - +Constructor for class uk.org.ury.common.library.item.LibraryItem
  -
LibraryItemProperty - Enum in uk.org.ury.library.item
The parameters that are stored in the LibraryItem.
LibraryRequestHandler - Class in uk.org.ury.library
A request handler for library queries.
LibraryRequestHandler(Server, String) - -Constructor for class uk.org.ury.library.LibraryRequestHandler +
LibraryItemProperty - Enum in uk.org.ury.common.library.item
The parameters that are stored in the LibraryItem.
LibraryRequestHandler - Class in uk.org.ury.backend.handlers
A request handler for library queries.
LibraryRequestHandler(Server, String) - +Constructor for class uk.org.ury.backend.handlers.LibraryRequestHandler
Construct a new LibraryRequestHandler. -
LibraryTableModel - Class in uk.org.ury.library.viewer
A table model for the library viewer.
LibraryTableModel(List<LibraryItem>) - -Constructor for class uk.org.ury.library.viewer.LibraryTableModel +
LibraryTableModel - Class in uk.org.ury.frontend.modules.library
A table model for the library viewer.
LibraryTableModel(List<LibraryItem>) - +Constructor for class uk.org.ury.frontend.modules.library.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 +
LibraryUtils - Class in uk.org.ury.common.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.common.library.LibraryUtils
  -
LibraryViewer - Class in uk.org.ury.library.viewer
Module for investigating the track library.
LibraryViewer() - -Constructor for class uk.org.ury.library.viewer.LibraryViewer +
LibraryViewer - Class in uk.org.ury.frontend.modules.library
Module for investigating the track library.
LibraryViewer() - +Constructor for class uk.org.ury.frontend.modules.library.LibraryViewer
Constructs a new LibraryViewer as a frontend object. -
LibraryViewerPanel - Class in uk.org.ury.library.viewer
Frontend panel providing access to an underlying library viewer.
LibraryViewerPanel(LibraryViewer, FrontendMaster) - -Constructor for class uk.org.ury.library.viewer.LibraryViewerPanel +
LibraryViewerPanel - Class in uk.org.ury.frontend.modules.library
Frontend panel providing access to an underlying library viewer.
LibraryViewerPanel(LibraryViewer, FrontendMaster) - +Constructor for class uk.org.ury.frontend.modules.library.LibraryViewerPanel
Construct a new LibraryViewerPanel.
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 @@ -123,8 +123,8 @@ Method in class uk.org.ury.frontend.loadModule(String, String) - Method in class uk.org.ury.frontend.FrontendFrame -
Load a module into the frontend frame, additionally installing - a control panel to communicate with the previous module. +
Load a module into the frontend frame, additionally installing a control + panel to communicate with the previous module.
loadModule(String) - Method in interface uk.org.ury.frontend.FrontendMaster
Load a module into the frontend frame. @@ -132,8 +132,8 @@ Method in interface uk.org.ury.frontend.FrontendMaster
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.testrig.DemoMenu +
loadModule(String) - +Method in class uk.org.ury.frontend.modules.menu.DemoMenu
 
diff --git a/doc/index-files/index-11.html b/doc/index-files/index-11.html index b738199..acb0647 100644 --- a/doc/index-files/index-11.html +++ b/doc/index-files/index-11.html @@ -2,7 +2,7 @@ - + M-Index @@ -82,28 +82,28 @@ function windowTitle()

M

-
main(String[]) - -Static method in class uk.org.ury.server.Server +
main(String[]) - +Static method in class uk.org.ury.backend.server.Server
The main method, which serves to create a server. -
main(String[]) - -Static method in class uk.org.ury.testrig.ApplicationLauncher +
main(String[]) - +Static method in class uk.org.ury.frontend.testrig.ApplicationLauncher
Main method. -
MissingCredentialsException - Exception in uk.org.ury.database.exceptions
Exception thrown when the database credentials required to +
MissingCredentialsException - Exception in uk.org.ury.backend.database.exceptions
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.
MissingCredentialsException() - -Constructor for exception uk.org.ury.database.exceptions.MissingCredentialsException + and thus the log-in cannot continue.
MissingCredentialsException() - +Constructor for exception uk.org.ury.backend.database.exceptions.MissingCredentialsException
Construct a new MissingCredentialsException with a default reason. -
MissingCredentialsException(String) - -Constructor for exception uk.org.ury.database.exceptions.MissingCredentialsException +
MissingCredentialsException(String) - +Constructor for exception uk.org.ury.backend.database.exceptions.MissingCredentialsException
Construct a new MissingCredentialsException. -
MissingPropertyException - Exception in uk.org.ury.database.exceptions
Exception thrown when a DatabaseItem is queried for a property - that does not exist.
MissingPropertyException() - -Constructor for exception uk.org.ury.database.exceptions.MissingPropertyException +
MissingPropertyException - Exception in uk.org.ury.backend.database.exceptions
Exception thrown when a DatabaseItem is queried for a property + that does not exist.
MissingPropertyException() - +Constructor for exception uk.org.ury.backend.database.exceptions.MissingPropertyException
Construct a new MissingPropertyException with a default reason. -
MissingPropertyException(String) - -Constructor for exception uk.org.ury.database.exceptions.MissingPropertyException +
MissingPropertyException(String) - +Constructor for exception uk.org.ury.backend.database.exceptions.MissingPropertyException
Construct a new MissingPropertyException.
diff --git a/doc/index-files/index-12.html b/doc/index-files/index-12.html index b877693..8994069 100644 --- a/doc/index-files/index-12.html +++ b/doc/index-files/index-12.html @@ -2,7 +2,7 @@ - + N-Index @@ -82,13 +82,13 @@ function windowTitle()

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 +
NotAHandlerException - Exception in uk.org.ury.backend.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.backend.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 +
NUM_CHANNELS - +Static variable in class uk.org.ury.common.show.ShowUtils
The number of channels reserved for show items.
diff --git a/doc/index-files/index-13.html b/doc/index-files/index-13.html index 49ff9e4..4aa6f32 100644 --- a/doc/index-files/index-13.html +++ b/doc/index-files/index-13.html @@ -2,7 +2,7 @@ - + P-Index @@ -82,9 +82,9 @@ function windowTitle()

P

-
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 +
ProtocolUtils - Class in uk.org.ury.common.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.common.protocol.ProtocolUtils
 
diff --git a/doc/index-files/index-14.html b/doc/index-files/index-14.html index a57941e..820f066 100644 --- a/doc/index-files/index-14.html +++ b/doc/index-files/index-14.html @@ -2,7 +2,7 @@ - + Q-Index @@ -82,13 +82,13 @@ function windowTitle()

Q

-
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 +
QueryFailureException - Exception in uk.org.ury.backend.database.exceptions
Exception thrown when the database backend fails to execute + a query.
QueryFailureException() - +Constructor for exception uk.org.ury.backend.database.exceptions.QueryFailureException
Construct a new QueryFailureException with a default reason. -
QueryFailureException(String) - -Constructor for exception uk.org.ury.database.exceptions.QueryFailureException +
QueryFailureException(String) - +Constructor for exception uk.org.ury.backend.database.exceptions.QueryFailureException
Construct a new QueryFailureException.
diff --git a/doc/index-files/index-15.html b/doc/index-files/index-15.html index 66f3b7a..6694a37 100644 --- a/doc/index-files/index-15.html +++ b/doc/index-files/index-15.html @@ -2,7 +2,7 @@ - + R-Index @@ -88,41 +88,40 @@ Static method in class uk.org.ury.frontend.reportFatal(String, FrontendApplet) - Static method in class uk.org.ury.frontend.FrontendError
  -
responseIsOK(Map<?, ?>) - -Static method in class uk.org.ury.protocol.ProtocolUtils +
responseIsOK(Map<?, ?>) - +Static method in class uk.org.ury.common.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. +
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.server.HttpListenerThread +
run() - +Method in class uk.org.ury.backend.server.HttpListenerThread
Thread execution body. -
run() - -Method in class uk.org.ury.server.HttpWorkerThread +
run() - +Method in class uk.org.ury.backend.server.HttpWorkerThread
Thread execution body. -
run() - -Method in class uk.org.ury.testrig.DemoMenu +
run() - +Method in class uk.org.ury.frontend.modules.menu.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 +
runFrontend(FrontendMaster) - +Method in class uk.org.ury.frontend.modules.library.LibraryViewer
Runs the library viewer frontend. -
runFrontend(FrontendMaster) - -Method in class uk.org.ury.show.viewer.ShowViewer -
Run the library viewer frontend. -
runFrontend(FrontendMaster) - -Method in class uk.org.ury.testrig.DemoMenu +
runFrontend(FrontendMaster) - +Method in class uk.org.ury.frontend.modules.menu.DemoMenu
Run the demo menu in frontend mode. +
runFrontend(FrontendMaster) - +Method in class uk.org.ury.frontend.modules.show.ShowViewer +
Run the library viewer frontend.
diff --git a/doc/index-files/index-16.html b/doc/index-files/index-16.html index 2f1a287..257bd5b 100644 --- a/doc/index-files/index-16.html +++ b/doc/index-files/index-16.html @@ -2,7 +2,7 @@ - + S-Index @@ -82,25 +82,25 @@ function windowTitle()

S

-
search(DatabaseDriver, String) - -Static method in class uk.org.ury.library.LibraryUtils +
search(DatabaseDriver, String) - +Static method in class uk.org.ury.common.library.LibraryUtils
Perform a library search. -
search() - -Method in class uk.org.ury.library.viewer.LibraryViewerPanel +
search() - +Method in class uk.org.ury.frontend.modules.library.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 +
search() - +Method in class uk.org.ury.frontend.modules.show.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 +
Server - Class in uk.org.ury.backend.server
The unified URY server, accepting requests over HTTP.
Server() - +Constructor for class uk.org.ury.backend.server.Server
  -
SERVER_VERSION - -Static variable in class uk.org.ury.server.Server +
SERVER_VERSION - +Static variable in class uk.org.ury.backend.server.Server
  -
ServerRequestHandler - Class in uk.org.ury.server
A request handler for server queries.
ServerRequestHandler() - -Constructor for class uk.org.ury.server.ServerRequestHandler +
ServerRequestHandler - Class in uk.org.ury.backend.server
A request handler for server queries.
ServerRequestHandler() - +Constructor for class uk.org.ury.backend.server.ServerRequestHandler
 
setMaster(FrontendMaster) - Method in class uk.org.ury.frontend.FrontendPanel @@ -120,8 +120,8 @@ Method in class uk.org.ury.frontend.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 +
setUp() - +Method in class uk.org.ury.frontend.client.test.ClientTest
 
setupUI() - Method in class uk.org.ury.frontend.FrontendApplet @@ -132,29 +132,29 @@ Method in class uk.org.ury.frontend.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 +
ShowChannel - Class in uk.org.ury.common.show
A channel of ShowItems in a show.
ShowChannel() - +Constructor for class uk.org.ury.common.show.ShowChannel
Constructs a new, empty channel. -
ShowItem - Class in uk.org.ury.show.item
An item in the show database.
ShowItem(Map<ShowItemProperty, String>) - -Constructor for class uk.org.ury.show.item.ShowItem +
ShowItem - Class in uk.org.ury.common.show.item
An item in the show database.
ShowItem(Map<ShowItemProperty, String>) - +Constructor for class uk.org.ury.common.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 +
ShowItemProperty - Enum in uk.org.ury.common.show.item
Enumeration of the parameters that are stored in a ShowItem.
ShowUtils - Class in uk.org.ury.common.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.common.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 +
ShowViewer - Class in uk.org.ury.frontend.modules.show
Frontend module for viewing show details.
ShowViewer() - +Constructor for class uk.org.ury.frontend.modules.show.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 +
ShowViewerPanel - Class in uk.org.ury.frontend.modules.show
Frontend panel providing access to an underlying show viewer.
ShowViewerPanel(ShowViewer, FrontendMaster) - +Constructor for class uk.org.ury.frontend.modules.show.ShowViewerPanel
Construct a new ShowViewerPanel. -
sql - -Variable in enum uk.org.ury.library.item.LibraryItemProperty +
sql - +Variable in enum uk.org.ury.common.library.item.LibraryItemProperty
  -
sql - -Variable in enum uk.org.ury.show.item.ShowItemProperty +
sql - +Variable in enum uk.org.ury.common.show.item.ShowItemProperty
  -
Status - Enum in uk.org.ury.protocol
Statuses that can follow the STATUS directory.
+
Status - Enum in uk.org.ury.common.protocol
Statuses that can follow the STATUS directory.
diff --git a/doc/index-files/index-17.html b/doc/index-files/index-17.html index e288e13..6541ba6 100644 --- a/doc/index-files/index-17.html +++ b/doc/index-files/index-17.html @@ -2,7 +2,7 @@ - + T-Index @@ -82,17 +82,17 @@ function windowTitle()

T

-
tearDown() - -Method in class uk.org.ury.client.test.ClientTest +
tearDown() - +Method in class uk.org.ury.frontend.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 +
testGet() - +Method in class uk.org.ury.frontend.client.test.ClientTest +
Test method for Client.get(java.lang.String). +
toString() - +Method in class uk.org.ury.common.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 +
TrackBin - Class in uk.org.ury.frontend.modules.show
A panel displaying track bin contents.
TrackBin(String) - +Constructor for class uk.org.ury.frontend.modules.show.TrackBin
Construct a new TrackBin.
diff --git a/doc/index-files/index-18.html b/doc/index-files/index-18.html index 4fe25ef..da1d16f 100644 --- a/doc/index-files/index-18.html +++ b/doc/index-files/index-18.html @@ -2,7 +2,7 @@ - + U-Index @@ -89,11 +89,11 @@ Constructor for exception uk.org.ury.frontend.exceptions.UICreationFailureException(String) - Constructor for exception uk.org.ury.frontend.exceptions.UICreationFailureException
Construct a new UICreationFailureException. -
uk.org.ury.client - package uk.org.ury.client
 
uk.org.ury.client.test - package uk.org.ury.client.test
 
uk.org.ury.config - package uk.org.ury.config
 
uk.org.ury.database - package uk.org.ury.database
Database services for the URY Presenter Suite.
uk.org.ury.database.exceptions - package uk.org.ury.database.exceptions
Exceptions thrown by the database services classes.
uk.org.ury.frontend - package uk.org.ury.frontend
 
uk.org.ury.frontend.exceptions - package uk.org.ury.frontend.exceptions
 
uk.org.ury.library - package uk.org.ury.library
 
uk.org.ury.library.exceptions - package uk.org.ury.library.exceptions
 
uk.org.ury.library.item - package uk.org.ury.library.item
 
uk.org.ury.library.viewer - package uk.org.ury.library.viewer
 
uk.org.ury.protocol - package uk.org.ury.protocol
 
uk.org.ury.protocol.exceptions - package uk.org.ury.protocol.exceptions
 
uk.org.ury.server - package uk.org.ury.server
The URY Server kernel.
uk.org.ury.server.exceptions - package uk.org.ury.server.exceptions
 
uk.org.ury.show - package uk.org.ury.show
 
uk.org.ury.show.item - package uk.org.ury.show.item
The show item class and related properties.
uk.org.ury.show.viewer - package uk.org.ury.show.viewer
 
uk.org.ury.testrig - package uk.org.ury.testrig
 
UnknownFunctionException - Exception in uk.org.ury.server.exceptions
Exception thrown when a handler receives a request for a path that does not - correspond to one of its functions.
UnknownFunctionException(String) - -Constructor for exception uk.org.ury.server.exceptions.UnknownFunctionException +
uk.org.ury.backend.config - package uk.org.ury.backend.config
 
uk.org.ury.backend.database - package uk.org.ury.backend.database
Database services for the URY Presenter Suite.
uk.org.ury.backend.database.exceptions - package uk.org.ury.backend.database.exceptions
Exceptions thrown by the database services classes.
uk.org.ury.backend.handlers - package uk.org.ury.backend.handlers
 
uk.org.ury.backend.server - package uk.org.ury.backend.server
The URY Server kernel.
uk.org.ury.backend.server.exceptions - package uk.org.ury.backend.server.exceptions
 
uk.org.ury.common.library - package uk.org.ury.common.library
 
uk.org.ury.common.library.exceptions - package uk.org.ury.common.library.exceptions
 
uk.org.ury.common.library.item - package uk.org.ury.common.library.item
 
uk.org.ury.common.protocol - package uk.org.ury.common.protocol
 
uk.org.ury.common.protocol.exceptions - package uk.org.ury.common.protocol.exceptions
 
uk.org.ury.common.show - package uk.org.ury.common.show
 
uk.org.ury.common.show.item - package uk.org.ury.common.show.item
The show item class and related properties.
uk.org.ury.frontend - package uk.org.ury.frontend
 
uk.org.ury.frontend.client - package uk.org.ury.frontend.client
 
uk.org.ury.frontend.client.test - package uk.org.ury.frontend.client.test
 
uk.org.ury.frontend.cpanels.menu - package uk.org.ury.frontend.cpanels.menu
 
uk.org.ury.frontend.cpanels.show - package uk.org.ury.frontend.cpanels.show
 
uk.org.ury.frontend.exceptions - package uk.org.ury.frontend.exceptions
 
uk.org.ury.frontend.modules.library - package uk.org.ury.frontend.modules.library
 
uk.org.ury.frontend.modules.menu - package uk.org.ury.frontend.modules.menu
 
uk.org.ury.frontend.modules.show - package uk.org.ury.frontend.modules.show
 
uk.org.ury.frontend.testrig - package uk.org.ury.frontend.testrig
 
UnknownFunctionException - Exception in uk.org.ury.backend.server.exceptions
Exception thrown when a handler receives a request for a path that does not + correspond to one of its functions.
UnknownFunctionException(String) - +Constructor for exception uk.org.ury.backend.server.exceptions.UnknownFunctionException
Construct a new UnknownFunctionException. -
UserClass - Enum in uk.org.ury.database
The various user classes of the database driver. +
UserClass - Enum in uk.org.ury.backend.database
The various user classes of the database driver.
diff --git a/doc/index-files/index-19.html b/doc/index-files/index-19.html index 9a8c337..8034b56 100644 --- a/doc/index-files/index-19.html +++ b/doc/index-files/index-19.html @@ -2,7 +2,7 @@ - + V-Index @@ -82,39 +82,39 @@ function windowTitle()

V

-
valueOf(String) - -Static method in enum uk.org.ury.database.UserClass +
valueOf(String) - +Static method in enum uk.org.ury.backend.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 +
valueOf(String) - +Static method in enum uk.org.ury.common.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 +
valueOf(String) - +Static method in enum uk.org.ury.common.protocol.Directive
Returns the enum constant of this type with the specified name. -
valueOf(String) - -Static method in enum uk.org.ury.protocol.Status +
valueOf(String) - +Static method in enum uk.org.ury.common.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 +
valueOf(String) - +Static method in enum uk.org.ury.common.show.item.ShowItemProperty
Returns the enum constant of this type with the specified name. -
values() - -Static method in enum uk.org.ury.database.UserClass +
values() - +Static method in enum uk.org.ury.backend.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 +
values() - +Static method in enum uk.org.ury.common.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 +
values() - +Static method in enum uk.org.ury.common.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 +
values() - +Static method in enum uk.org.ury.common.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 +
values() - +Static method in enum uk.org.ury.common.show.item.ShowItemProperty
Returns an array containing the constants of this enum type, in the order they are declared.
diff --git a/doc/index-files/index-2.html b/doc/index-files/index-2.html index dd331cb..c5d6a9d 100644 --- a/doc/index-files/index-2.html +++ b/doc/index-files/index-2.html @@ -2,7 +2,7 @@ - + B-Index @@ -82,18 +82,18 @@ function windowTitle()

B

-
back() - -Method in class uk.org.ury.show.viewer.LibraryControlPanel +
back() - +Method in class uk.org.ury.frontend.cpanels.menu.DemoControlPanel
Go back to the previous module. -
back() - -Method in class uk.org.ury.testrig.DemoControlPanel +
back() - +Method in class uk.org.ury.frontend.cpanels.show.LibraryControlPanel
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 +
BadRequestException - Exception in uk.org.ury.backend.server.exceptions
Exception thrown when the server meets a malformed request, or + part of one.
BadRequestException() - +Constructor for exception uk.org.ury.backend.server.exceptions.BadRequestException
Construct a new BadRequestException with a default reason. -
BadRequestException(Throwable) - -Constructor for exception uk.org.ury.server.exceptions.BadRequestException +
BadRequestException(Throwable) - +Constructor for exception uk.org.ury.backend.server.exceptions.BadRequestException
Construct a new HandlerNotFoundException with a chained exception.
diff --git a/doc/index-files/index-3.html b/doc/index-files/index-3.html index 73b5ed5..bb4d97e 100644 --- a/doc/index-files/index-3.html +++ b/doc/index-files/index-3.html @@ -2,7 +2,7 @@ - + C-Index @@ -82,29 +82,29 @@ function windowTitle()

C

-
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 +
ChannelPanel - Class in uk.org.ury.frontend.modules.show
A panel displaying channel information.
ChannelPanel(int, ShowChannel) - +Constructor for class uk.org.ury.frontend.modules.show.ChannelPanel
Construct a new ChannelPanel. -
Client - Class in uk.org.ury.client
 
Client() - -Constructor for class uk.org.ury.client.Client +
Client - Class in uk.org.ury.frontend.client
 
Client() - +Constructor for class uk.org.ury.frontend.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 +
ClientTest - Class in uk.org.ury.frontend.client.test
JUnit test for the low-level client logic.
ClientTest() - +Constructor for class uk.org.ury.frontend.client.test.ClientTest
  -
configName - -Variable in enum uk.org.ury.database.UserClass +
configName - +Variable in enum uk.org.ury.backend.database.UserClass
The name of the tag in the configuration file that contains the credentials for this user class. -
ConfigReader - Class in uk.org.ury.config
Reads in an XML config file and creates config objects
ConfigReader(String) - -Constructor for class uk.org.ury.config.ConfigReader +
ConfigReader - Class in uk.org.ury.backend.config
Reads in an XML config file and creates config objects
ConfigReader(String) - +Constructor for class uk.org.ury.backend.config.ConfigReader
Read in the config file and create the Database and Auth configuration objects. -
ConnectionFailureException - Exception in uk.org.ury.database.exceptions
Exception thrown when the database backend fails to connect to - the database server, in absence of a more specific exception.
ConnectionFailureException() - -Constructor for exception uk.org.ury.database.exceptions.ConnectionFailureException +
ConnectionFailureException - Exception in uk.org.ury.backend.database.exceptions
Exception thrown when the database backend fails to connect to + the database server, in absence of a more specific exception.
ConnectionFailureException() - +Constructor for exception uk.org.ury.backend.database.exceptions.ConnectionFailureException
Construct a new ConnectionFailureException with a default reason. -
ConnectionFailureException(String) - -Constructor for exception uk.org.ury.database.exceptions.ConnectionFailureException +
ConnectionFailureException(String) - +Constructor for exception uk.org.ury.backend.database.exceptions.ConnectionFailureException
Construct a new ConnectionFailureException.
diff --git a/doc/index-files/index-4.html b/doc/index-files/index-4.html index bee8054..6fae14d 100644 --- a/doc/index-files/index-4.html +++ b/doc/index-files/index-4.html @@ -2,7 +2,7 @@ - + D-Index @@ -82,40 +82,40 @@ function windowTitle()

D

-
Database - Class in uk.org.ury.config
A Database Server configuration
Database(String, int, String) - -Constructor for class uk.org.ury.config.Database +
Database - Class in uk.org.ury.backend.config
A Database Server configuration
Database(String, int, String) - +Constructor for class uk.org.ury.backend.config.Database
Create a database object -
DatabaseDriver - Class in uk.org.ury.database
A database connection manager that connects to the URY databases using - suitably privileged accounts, and handles the processing of SQL queries.
DatabaseDriver(ConfigReader, UserClass) - -Constructor for class uk.org.ury.database.DatabaseDriver +
DatabaseDriver - Class in uk.org.ury.backend.database
A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.
DatabaseDriver(ConfigReader, UserClass) - +Constructor for class uk.org.ury.backend.database.DatabaseDriver
Construct a new DatabaseDriver with the given user class. -
DatabaseItem<E,T> - Class in uk.org.ury.database
An abstract class presenting a template for objects serving as a data - structure for collections of properties retrieved from a SQL database.
DatabaseItem(Map<E, T>) - -Constructor for class uk.org.ury.database.DatabaseItem +
DatabaseItem<E,T> - Class in uk.org.ury.backend.database
An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.
DatabaseItem(Map<E, T>) - +Constructor for class uk.org.ury.backend.database.DatabaseItem
Construct a new item from an existing list of properties. -
decode(String) - -Static method in class uk.org.ury.protocol.ProtocolUtils +
decode(String) - +Static method in class uk.org.ury.common.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 +
DecodeFailureException - Exception in uk.org.ury.common.protocol.exceptions
Exception thrown when the protocol decoder fails.
DecodeFailureException(String) - +Constructor for exception uk.org.ury.common.protocol.exceptions.DecodeFailureException
Construct a new DecodeFailureException with a reason. -
DEFAULT_MODULE_NAME - -Static variable in interface uk.org.ury.testrig.Launcher +
DEFAULT_MODULE_NAME - +Static variable in interface uk.org.ury.frontend.testrig.Launcher
  -
DemoControlPanel - Class in uk.org.ury.testrig
Control panel for the demo system.
DemoControlPanel() - -Constructor for class uk.org.ury.testrig.DemoControlPanel +
DemoControlPanel - Class in uk.org.ury.frontend.cpanels.menu
Control panel for the demo system.
DemoControlPanel() - +Constructor for class uk.org.ury.frontend.cpanels.menu.DemoControlPanel
Constructs a new DemoControlPanel. -
DemoMenu - Class in uk.org.ury.testrig
Application frontend, for testing early-stage frontend code.
DemoMenu() - -Constructor for class uk.org.ury.testrig.DemoMenu +
DemoMenu - Class in uk.org.ury.frontend.modules.menu
Application frontend, for testing early-stage frontend code.
DemoMenu() - +Constructor for class uk.org.ury.frontend.modules.menu.DemoMenu
  -
DemoMenuPanel - Class in uk.org.ury.testrig
 
DemoMenuPanel(FrontendMaster) - -Constructor for class uk.org.ury.testrig.DemoMenuPanel +
DemoMenuPanel - Class in uk.org.ury.frontend.modules.menu
 
DemoMenuPanel(FrontendMaster) - +Constructor for class uk.org.ury.frontend.modules.menu.DemoMenuPanel
Construct a new DemoMenuPanel. -
Directive - Enum in uk.org.ury.protocol
Directives supported by the protocol.
DOCTYPE - -Static variable in class uk.org.ury.server.Server +
Directive - Enum in uk.org.ury.common.protocol
Directives supported by the protocol.
DOCTYPE - +Static variable in class uk.org.ury.backend.server.Server
  -
doSearch(String) - -Method in class uk.org.ury.library.viewer.LibraryViewer +
doSearch(String) - +Method in class uk.org.ury.frontend.modules.library.LibraryViewer
Does a library search.
diff --git a/doc/index-files/index-5.html b/doc/index-files/index-5.html index fb8364f..0065688 100644 --- a/doc/index-files/index-5.html +++ b/doc/index-files/index-5.html @@ -2,7 +2,7 @@ - + E-Index @@ -82,22 +82,22 @@ function windowTitle()

E

-
EmptySearchException - Exception in uk.org.ury.library.exceptions
Exception thrown when a library search is initiated - in which the query string is null.
EmptySearchException() - -Constructor for exception uk.org.ury.library.exceptions.EmptySearchException +
EmptySearchException - Exception in uk.org.ury.common.library.exceptions
Exception thrown when a library search is initiated + in which the query string is null.
EmptySearchException() - +Constructor for exception uk.org.ury.common.library.exceptions.EmptySearchException
Construct a new EmptySearchException with a default reason. -
EmptySearchException(String) - -Constructor for exception uk.org.ury.library.exceptions.EmptySearchException +
EmptySearchException(String) - +Constructor for exception uk.org.ury.common.library.exceptions.EmptySearchException
Construct a new EmptySearchException. -
encode(Map<String, Object>) - -Static method in class uk.org.ury.protocol.ProtocolUtils +
encode(Map<String, Object>) - +Static method in class uk.org.ury.common.protocol.ProtocolUtils
Encode a key-value map into a protocol string. -
executeQuery(String, int) - -Method in class uk.org.ury.database.DatabaseDriver +
executeQuery(String, int) - +Method in class uk.org.ury.backend.database.DatabaseDriver
Execute an unprepared SQL statement with no arguments. -
executeQuery(String, Object[], int) - -Method in class uk.org.ury.database.DatabaseDriver +
executeQuery(String, Object[], int) - +Method in class uk.org.ury.backend.database.DatabaseDriver
Perform a SQL statement with arguments.
diff --git a/doc/index-files/index-6.html b/doc/index-files/index-6.html index 706c871..ada9f0b 100644 --- a/doc/index-files/index-6.html +++ b/doc/index-files/index-6.html @@ -2,7 +2,7 @@ - + F-Index @@ -106,13 +106,13 @@ Constructor for class uk.org.ury.frontend.FrontendError - Class in uk.org.ury.frontend
Factory for descriptive error dialogues.
FrontendError() - 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(String) - +
FrontendFrame - Class in uk.org.ury.frontend
A frame that hosts a FrontendModulePanel, used for serving frontend 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) - + 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) - Constructor for class uk.org.ury.frontend.FrontendModulePanel
Construct a new, blank FrontendModulePanel.
FrontendModulePanel(FrontendModule, String, FrontendMaster) - diff --git a/doc/index-files/index-7.html b/doc/index-files/index-7.html index 46b54f2..211e9d8 100644 --- a/doc/index-files/index-7.html +++ b/doc/index-files/index-7.html @@ -2,7 +2,7 @@ - + G-Index @@ -82,54 +82,54 @@ function windowTitle()

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 +
get(E) - +Method in class uk.org.ury.backend.database.DatabaseItem
Query this item for a property. -
get(int) - -Method in class uk.org.ury.show.ShowChannel +
get(int) - +Method in class uk.org.ury.common.show.ShowChannel
Retrieves an item from the channel. -
getBins() - -Method in class uk.org.ury.show.viewer.ShowViewer +
get(String) - +Method in class uk.org.ury.frontend.client.Client +
Get a raw response from the server. +
getBins() - +Method in class uk.org.ury.frontend.modules.show.ShowViewer
  -
getChannelList(DatabaseDriver, int, int) - -Static method in class uk.org.ury.show.ShowUtils +
getChannelList(DatabaseDriver, int, int) - +Static method in class uk.org.ury.common.show.ShowUtils
Given a show and a channel, retrieve a list of all show items bound to that channel for the show. -
getChannels() - -Method in class uk.org.ury.show.viewer.ShowViewer +
getChannels() - +Method in class uk.org.ury.frontend.modules.show.ShowViewer
  -
getColumnClass(int) - -Method in class uk.org.ury.library.viewer.LibraryTableModel +
getColumnClass(int) - +Method in class uk.org.ury.frontend.modules.library.LibraryTableModel
  -
getColumnCount() - -Method in class uk.org.ury.library.viewer.LibraryTableModel +
getColumnCount() - +Method in class uk.org.ury.frontend.modules.library.LibraryTableModel
  -
getColumnName(int) - -Method in class uk.org.ury.library.viewer.LibraryTableModel +
getColumnName(int) - +Method in class uk.org.ury.frontend.modules.library.LibraryTableModel
  -
getDatabase() - -Method in class uk.org.ury.config.ConfigReader +
getDatabase() - +Method in class uk.org.ury.backend.config.ConfigReader
Get the database configuration -
getDatabaseConnection(UserClass) - -Method in class uk.org.ury.server.Server +
getDatabaseConnection(UserClass) - +Method in class uk.org.ury.backend.server.Server
Gets a database connection using the given user class. -
getDb() - -Method in class uk.org.ury.config.Database +
getDb() - +Method in class uk.org.ury.backend.config.Database
Get the name of the database -
getElementAt(int) - -Method in class uk.org.ury.show.ShowChannel +
getElementAt(int) - +Method in class uk.org.ury.common.show.ShowChannel
List model retrieval wrapper for get. -
getFromSQL(String) - -Static method in enum uk.org.ury.library.item.LibraryItemProperty +
getFromSQL(String) - +Static method in enum uk.org.ury.common.library.item.LibraryItemProperty
Retrieve a LibraryItemProperty given its SQL identifier. -
getHost() - -Method in class uk.org.ury.config.Database +
getHost() - +Method in class uk.org.ury.backend.config.Database
Get the hostname of the database server -
getLibraryList() - -Method in class uk.org.ury.library.viewer.LibraryViewer +
getLibraryList() - +Method in class uk.org.ury.frontend.modules.library.LibraryViewer
 
getModule() - Method in class uk.org.ury.frontend.FrontendModulePanel @@ -137,23 +137,23 @@ Method in class uk.org.ury.frontend.getModuleName() - Method in class uk.org.ury.frontend.FrontendModulePanel
  -
getModuleName() - -Method in class uk.org.ury.library.viewer.LibraryViewerPanel +
getModuleName() - +Method in class uk.org.ury.frontend.modules.library.LibraryViewerPanel
  -
getModuleName() - -Method in class uk.org.ury.show.viewer.ShowViewerPanel +
getModuleName() - +Method in class uk.org.ury.frontend.modules.menu.DemoMenuPanel
  -
getModuleName() - -Method in class uk.org.ury.testrig.DemoMenuPanel +
getModuleName() - +Method in class uk.org.ury.frontend.modules.show.ShowViewerPanel
  -
getPass() - -Method in class uk.org.ury.config.Auth +
getPass() - +Method in class uk.org.ury.backend.config.Auth
Get the password of the login -
getPort() - -Method in class uk.org.ury.config.Database +
getPort() - +Method in class uk.org.ury.backend.config.Database
Get the port the database server is running on -
getPublicFolders(DatabaseDriver) - -Static method in class uk.org.ury.show.ShowUtils +
getPublicFolders(DatabaseDriver) - +Static method in class uk.org.ury.common.show.ShowUtils
Return the names of the public track folders, or "bins".
getResourceDirectory() - Method in class uk.org.ury.frontend.FrontendApplet @@ -164,26 +164,26 @@ Method in class uk.org.ury.frontend.getResourceDirectory() - Method in interface uk.org.ury.frontend.FrontendMaster
  -
getRoAuth() - -Method in class uk.org.ury.config.ConfigReader +
getRoAuth() - +Method in class uk.org.ury.backend.config.ConfigReader
Get the read only login auth configuration -
getRowCount() - -Method in class uk.org.ury.library.viewer.LibraryTableModel +
getRowCount() - +Method in class uk.org.ury.frontend.modules.library.LibraryTableModel
  -
getRwAuth() - -Method in class uk.org.ury.config.ConfigReader +
getRwAuth() - +Method in class uk.org.ury.backend.config.ConfigReader
Get the read write login auth configuration -
getSize() - -Method in class uk.org.ury.show.ShowChannel +
getSize() - +Method in class uk.org.ury.common.show.ShowChannel
  -
getUser() - -Method in class uk.org.ury.config.Auth +
getUser() - +Method in class uk.org.ury.backend.config.Auth
Get the username of the login -
getValueAt(int, int) - -Method in class uk.org.ury.library.viewer.LibraryTableModel +
getValueAt(int, int) - +Method in class uk.org.ury.frontend.modules.library.LibraryTableModel
  -
getVersion() - -Method in class uk.org.ury.server.Server +
getVersion() - +Method in class uk.org.ury.backend.server.Server
 
diff --git a/doc/index-files/index-8.html b/doc/index-files/index-8.html index 2af44bd..5a08bae 100644 --- a/doc/index-files/index-8.html +++ b/doc/index-files/index-8.html @@ -2,7 +2,7 @@ - + H-Index @@ -82,58 +82,58 @@ function windowTitle()

H

-
handle(HttpRequest, HttpResponse, HttpContext) - -Method in class uk.org.ury.server.AbstractRequestHandler +
handle(HttpRequest, HttpResponse, HttpContext) - +Method in class uk.org.ury.backend.server.AbstractRequestHandler
Begins handling of a HTTP request. -
HandleFailureException - Exception in uk.org.ury.server.exceptions
Generic exception thrown when a server request handler fails to - handle a request.
HandleFailureException() - -Constructor for exception uk.org.ury.server.exceptions.HandleFailureException +
HandleFailureException - Exception in uk.org.ury.backend.server.exceptions
Generic exception thrown when a server request handler fails to + handle a request.
HandleFailureException() - +Constructor for exception uk.org.ury.backend.server.exceptions.HandleFailureException
Construct a new HandleFailureException with a default reason. -
HandleFailureException(String) - -Constructor for exception uk.org.ury.server.exceptions.HandleFailureException +
HandleFailureException(String) - +Constructor for exception uk.org.ury.backend.server.exceptions.HandleFailureException
Construct a new HandleFailureException. -
handleGet(HttpRequest, HttpResponse, HttpContext) - -Method in class uk.org.ury.library.LibraryRequestHandler +
handleGet(HttpRequest, HttpResponse, HttpContext) - +Method in class uk.org.ury.backend.handlers.LibraryRequestHandler
Handle a HTTP GET request. -
handleGet(HttpRequest, HttpResponse, HttpContext) - -Method in class uk.org.ury.server.HttpHandler +
handleGet(HttpRequest, HttpResponse, HttpContext) - +Method in class uk.org.ury.backend.server.HttpHandler
Handle a HTTP GET request. -
handleGetRequest(Map<String, String>, Server) - -Method in interface uk.org.ury.server.ApiRequestHandler +
handleGetRequest(Map<String, String>, Server) - +Method in interface uk.org.ury.backend.server.ApiRequestHandler
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 +
handleGetRequest(Map<String, String>, Server) - +Method in class uk.org.ury.backend.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 +
HandlerNotFoundException - Exception in uk.org.ury.backend.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.backend.server.exceptions.HandlerNotFoundException
Construct a new HandlerNotFoundException with a default reason. -
HandlerNotFoundException(String, Throwable) - -Constructor for exception uk.org.ury.server.exceptions.HandlerNotFoundException +
HandlerNotFoundException(String, Throwable) - +Constructor for exception uk.org.ury.backend.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 +
HandlerSetupFailureException - Exception in uk.org.ury.backend.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.backend.server.exceptions.HandlerSetupFailureException
Construct a new HandlerNotFoundException with a default reason. -
HandlerSetupFailureException(String, Throwable) - -Constructor for exception uk.org.ury.server.exceptions.HandlerSetupFailureException +
HandlerSetupFailureException(String, Throwable) - +Constructor for exception uk.org.ury.backend.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 +
HandlingException - Exception in uk.org.ury.backend.server.exceptions
Generic exception thrown when the server cannot handle a request.
HandlingException(String) - +Constructor for exception uk.org.ury.backend.server.exceptions.HandlingException
Construct a HandlingException with a reason. -
HandlingException(String, Throwable) - -Constructor for exception uk.org.ury.server.exceptions.HandlingException +
HandlingException(String, Throwable) - +Constructor for exception uk.org.ury.backend.server.exceptions.HandlingException
Construct a HandlingException with a reason and a cause to chain. -
has(E) - -Method in class uk.org.ury.database.DatabaseItem +
has(E) - +Method in class uk.org.ury.backend.database.DatabaseItem
Check whether a property has been set in the item.
HintField - Class in uk.org.ury.frontend
A non-editable text area displaying a hint about how to use a frontend screen.
HintField() - @@ -142,14 +142,14 @@ Constructor for class uk.org.ury.frontend.HintField(String) - Constructor for class uk.org.ury.frontend.HintField
Construct a new HintField. -
HttpHandler - Class in uk.org.ury.server
 
HttpHandler(Server, String) - -Constructor for class uk.org.ury.server.HttpHandler +
HttpHandler - Class in uk.org.ury.backend.server
 
HttpHandler(Server, String) - +Constructor for class uk.org.ury.backend.server.HttpHandler
Construct a new HttpHandler. -
HttpListenerThread - Class in uk.org.ury.server
Listener thread for the URY server HTTP interface.
HttpListenerThread(int, Server) - -Constructor for class uk.org.ury.server.HttpListenerThread +
HttpListenerThread - Class in uk.org.ury.backend.server
Listener thread for the URY server HTTP interface.
HttpListenerThread(int, Server) - +Constructor for class uk.org.ury.backend.server.HttpListenerThread
  -
HttpWorkerThread - Class in uk.org.ury.server
A worker thread in the server HTTP interface.
HttpWorkerThread(HttpService, HttpServerConnection) - -Constructor for class uk.org.ury.server.HttpWorkerThread +
HttpWorkerThread - Class in uk.org.ury.backend.server
A worker thread in the server HTTP interface.
HttpWorkerThread(HttpService, HttpServerConnection) - +Constructor for class uk.org.ury.backend.server.HttpWorkerThread
Construct a new HttpWorkerThread.
diff --git a/doc/index-files/index-9.html b/doc/index-files/index-9.html index 78d445b..214f655 100644 --- a/doc/index-files/index-9.html +++ b/doc/index-files/index-9.html @@ -2,7 +2,7 @@ - + I-Index @@ -82,15 +82,15 @@ function windowTitle()

I

-
INDEX_HTML - -Static variable in class uk.org.ury.server.Server +
INDEX_HTML - +Static variable in class uk.org.ury.backend.server.Server
 
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 +
InvalidMessageException - Exception in uk.org.ury.common.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.common.protocol.exceptions.InvalidMessageException
Construct a new InvalidMessageException with a reason.
diff --git a/doc/index.html b/doc/index.html index 4ab3057..1abeb32 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 0f01024..3e43045 100644 --- a/doc/overview-frame.html +++ b/doc/overview-frame.html @@ -2,7 +2,7 @@ - + Overview List @@ -30,43 +30,51 @@ Overview List Packages
-uk.org.ury.client +uk.org.ury.backend.config
-uk.org.ury.client.test +uk.org.ury.backend.database
-uk.org.ury.config +uk.org.ury.backend.database.exceptions
-uk.org.ury.database +uk.org.ury.backend.handlers
-uk.org.ury.database.exceptions +uk.org.ury.backend.server
-uk.org.ury.frontend +uk.org.ury.backend.server.exceptions
-uk.org.ury.frontend.exceptions +uk.org.ury.common.library +
+uk.org.ury.common.library.exceptions +
+uk.org.ury.common.library.item
-uk.org.ury.library +uk.org.ury.common.protocol
-uk.org.ury.library.exceptions +uk.org.ury.common.protocol.exceptions
-uk.org.ury.library.item +uk.org.ury.common.show
-uk.org.ury.library.viewer +uk.org.ury.common.show.item
-uk.org.ury.protocol +uk.org.ury.frontend +
+uk.org.ury.frontend.client
-uk.org.ury.protocol.exceptions +uk.org.ury.frontend.client.test
-uk.org.ury.server +uk.org.ury.frontend.cpanels.menu
-uk.org.ury.server.exceptions +uk.org.ury.frontend.cpanels.show +
+uk.org.ury.frontend.exceptions
-uk.org.ury.show +uk.org.ury.frontend.modules.library
-uk.org.ury.show.item +uk.org.ury.frontend.modules.menu
-uk.org.ury.show.viewer +uk.org.ury.frontend.modules.show
-uk.org.ury.testrig +uk.org.ury.frontend.testrig
diff --git a/doc/overview-summary.html b/doc/overview-summary.html index 813d6aa..7280bac 100644 --- a/doc/overview-summary.html +++ b/doc/overview-summary.html @@ -2,7 +2,7 @@ - + Overview @@ -92,79 +92,95 @@ The URY broadcasting and presentation suite. Packages
- + - + + + + + + + + + - + + + + + - - + + - - + + - + - + - + - + - + + + + + - + - + - + - - + + - + - + - - + + - + - +
uk.org.ury.testrig.Launcheruk.org.ury.frontend.testrig.Launcher
+ public static final java.lang.StringDEFAULT_MODULE_NAME"testrig.DemoMenu"DEFAULT_MODULE_NAME"menu.DemoMenu"
uk.org.ury.clientuk.org.ury.backend.config  
uk.org.ury.client.testuk.org.ury.backend.databaseDatabase services for the URY Presenter Suite.
uk.org.ury.backend.database.exceptionsExceptions thrown by the database services classes.
uk.org.ury.backend.handlers  
uk.org.ury.configuk.org.ury.backend.serverThe URY Server kernel.
uk.org.ury.backend.server.exceptions  
uk.org.ury.databaseDatabase services for the URY Presenter Suite.uk.org.ury.common.library 
uk.org.ury.database.exceptionsExceptions thrown by the database services classes.uk.org.ury.common.library.exceptions 
uk.org.ury.frontenduk.org.ury.common.library.item  
uk.org.ury.frontend.exceptionsuk.org.ury.common.protocol  
uk.org.ury.libraryuk.org.ury.common.protocol.exceptions  
uk.org.ury.library.exceptionsuk.org.ury.common.show  
uk.org.ury.library.itemuk.org.ury.common.show.itemThe show item class and related properties.
uk.org.ury.frontend  
uk.org.ury.library.vieweruk.org.ury.frontend.client  
uk.org.ury.protocoluk.org.ury.frontend.client.test  
uk.org.ury.protocol.exceptionsuk.org.ury.frontend.cpanels.menu  
uk.org.ury.serverThe URY Server kernel.uk.org.ury.frontend.cpanels.show 
uk.org.ury.server.exceptionsuk.org.ury.frontend.exceptions  
uk.org.ury.showuk.org.ury.frontend.modules.library  
uk.org.ury.show.itemThe show item class and related properties.uk.org.ury.frontend.modules.menu 
uk.org.ury.show.vieweruk.org.ury.frontend.modules.show  
uk.org.ury.testriguk.org.ury.frontend.testrig  
@@ -189,6 +205,8 @@ The URY broadcasting and presentation suite. for use by both server and client implementation;
  • Documentation for the above.
    • +

    Organisation

    +

    The system is organised as followed.

    diff --git a/doc/overview-tree.html b/doc/overview-tree.html index c72579a..403232f 100644 --- a/doc/overview-tree.html +++ b/doc/overview-tree.html @@ -2,7 +2,7 @@ - + Class Hierarchy @@ -84,7 +84,7 @@ function windowTitle() Hierarchy For All Packages

    -
    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
    +
    Package Hierarchies:
    uk.org.ury.backend.config, uk.org.ury.backend.database, uk.org.ury.backend.database.exceptions, uk.org.ury.backend.handlers, uk.org.ury.backend.server, uk.org.ury.backend.server.exceptions, uk.org.ury.common.library, uk.org.ury.common.library.exceptions, uk.org.ury.common.library.item, uk.org.ury.common.protocol, uk.org.ury.common.protocol.exceptions, uk.org.ury.common.show, uk.org.ury.common.show.item, uk.org.ury.frontend, uk.org.ury.frontend.client, uk.org.ury.frontend.client.test, uk.org.ury.frontend.cpanels.menu, uk.org.ury.frontend.cpanels.show, uk.org.ury.frontend.exceptions, uk.org.ury.frontend.modules.library, uk.org.ury.frontend.modules.menu, uk.org.ury.frontend.modules.show, uk.org.ury.frontend.testrig

    Class Hierarchy @@ -93,19 +93,19 @@ Class Hierarchy
  • java.lang.Object
  • javax.swing.AbstractListModel (implements javax.swing.ListModel, java.io.Serializable) -
  • uk.org.ury.server.AbstractRequestHandler (implements org.apache.http.protocol.HttpRequestHandler) +
  • uk.org.ury.common.show.ShowChannel +
  • uk.org.ury.backend.server.AbstractRequestHandler (implements org.apache.http.protocol.HttpRequestHandler) +
  • uk.org.ury.backend.server.HttpHandler (implements org.apache.http.protocol.HttpRequestHandler) +
  • uk.org.ury.backend.handlers.LibraryRequestHandler
  • javax.swing.table.AbstractTableModel (implements java.io.Serializable, javax.swing.table.TableModel) -
  • uk.org.ury.testrig.ApplicationLauncher (implements uk.org.ury.testrig.Launcher) -
  • uk.org.ury.config.Auth
  • uk.org.ury.client.Client
  • uk.org.ury.client.test.ClientTest
  • java.awt.Component (implements java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable) +
  • uk.org.ury.frontend.modules.library.LibraryTableModel +
  • uk.org.ury.frontend.testrig.ApplicationLauncher (implements uk.org.ury.frontend.testrig.Launcher) +
  • uk.org.ury.backend.config.Auth
  • uk.org.ury.frontend.client.Client
  • uk.org.ury.frontend.client.test.ClientTest
  • java.awt.Component (implements java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable)
  • javax.swing.text.JTextComponent (implements javax.accessibility.Accessible, javax.swing.Scrollable)
      @@ -133,7 +133,7 @@ Class Hierarchy
    • java.applet.Applet
    @@ -149,18 +149,18 @@ Class Hierarchy -
  • uk.org.ury.config.ConfigReader
  • uk.org.ury.config.Database
  • uk.org.ury.database.DatabaseDriver
  • uk.org.ury.database.DatabaseItem<E,T> -
  • uk.org.ury.frontend.FrontendError
  • uk.org.ury.library.LibraryUtils
  • uk.org.ury.protocol.ProtocolUtils
  • uk.org.ury.server.Server
  • uk.org.ury.server.ServerRequestHandler (implements uk.org.ury.server.ApiRequestHandler) -
  • uk.org.ury.show.ShowUtils
  • java.lang.Thread (implements java.lang.Runnable) +
  • uk.org.ury.backend.config.ConfigReader
  • uk.org.ury.backend.config.Database
  • uk.org.ury.backend.database.DatabaseDriver
  • uk.org.ury.backend.database.DatabaseItem<E,T> +
  • uk.org.ury.frontend.FrontendError
  • uk.org.ury.common.library.LibraryUtils
  • uk.org.ury.common.protocol.ProtocolUtils
  • uk.org.ury.backend.server.Server
  • uk.org.ury.backend.server.ServerRequestHandler (implements uk.org.ury.backend.server.ApiRequestHandler) +
  • uk.org.ury.common.show.ShowUtils
  • java.lang.Thread (implements java.lang.Runnable) +
  • uk.org.ury.backend.server.HttpListenerThread
  • uk.org.ury.backend.server.HttpWorkerThread
  • java.lang.Throwable (implements java.io.Serializable) @@ -168,7 +168,7 @@ Class Hierarchy Interface Hierarchy

    • +
  • uk.org.ury.backend.server.ApiRequestHandler
  • uk.org.ury.frontend.FrontendMaster
  • uk.org.ury.frontend.FrontendModule
  • uk.org.ury.frontend.testrig.Launcher

    Enum Hierarchy

    @@ -176,7 +176,7 @@ Enum Hierarchy
  • java.lang.Object
    diff --git a/doc/package-list b/doc/package-list index 1d2873c..86294f9 100644 --- a/doc/package-list +++ b/doc/package-list @@ -1,19 +1,23 @@ -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.backend.config +uk.org.ury.backend.database +uk.org.ury.backend.database.exceptions +uk.org.ury.backend.handlers +uk.org.ury.backend.server +uk.org.ury.backend.server.exceptions +uk.org.ury.common.library +uk.org.ury.common.library.exceptions +uk.org.ury.common.library.item +uk.org.ury.common.protocol +uk.org.ury.common.protocol.exceptions +uk.org.ury.common.show +uk.org.ury.common.show.item uk.org.ury.frontend +uk.org.ury.frontend.client +uk.org.ury.frontend.client.test +uk.org.ury.frontend.cpanels.menu +uk.org.ury.frontend.cpanels.show 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 +uk.org.ury.frontend.modules.library +uk.org.ury.frontend.modules.menu +uk.org.ury.frontend.modules.show +uk.org.ury.frontend.testrig diff --git a/doc/serialized-form.html b/doc/serialized-form.html index a9a17a3..6bedf5f 100644 --- a/doc/serialized-form.html +++ b/doc/serialized-form.html @@ -2,7 +2,7 @@ - + Serialized Form @@ -88,16 +88,16 @@ Serialized Form +Packageuk.org.ury.backend.database.exceptions
    -Package uk.org.ury.database.exceptions

    - + +Class uk.org.ury.backend.database.exceptions.ConnectionFailureException extends java.lang.Exception implements Serializable
    -Class uk.org.ury.database.exceptions.ConnectionFailureException extends java.lang.Exception implements Serializable
    @@ -107,11 +107,11 @@ Serialized Form

    - + +Class uk.org.ury.backend.database.exceptions.MissingCredentialsException extends java.lang.Exception implements Serializable
    -Class uk.org.ury.database.exceptions.MissingCredentialsException extends java.lang.Exception implements Serializable
    @@ -121,11 +121,11 @@ Serialized Form

    - + +Class uk.org.ury.backend.database.exceptions.MissingPropertyException extends java.lang.Exception implements Serializable
    -Class uk.org.ury.database.exceptions.MissingPropertyException extends java.lang.Exception implements Serializable
    @@ -135,11 +135,11 @@ Serialized Form

    - + +Class uk.org.ury.backend.database.exceptions.QueryFailureException extends java.lang.Exception implements Serializable
    -Class uk.org.ury.database.exceptions.QueryFailureException extends java.lang.Exception implements Serializable
    @@ -149,6 +149,208 @@ Serialized Form

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

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

    +serialVersionUID: 1825771401085225357L + +

    + +

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

    +serialVersionUID: -397479334359858162L + +

    + +

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

    +serialVersionUID: -397479334359858162L + +

    + +

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

    +serialVersionUID: -397479334359858162L + +

    + +

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

    +serialVersionUID: -397479334359858162L + +

    + +

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

    +serialVersionUID: -7268289187311868036L + +

    + +

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

    +serialVersionUID: -7557785978712465975L + +

    +

    + + + + + +
    +Package uk.org.ury.common.library.exceptions
    + +

    + + + + + +
    +Class uk.org.ury.common.library.exceptions.EmptySearchException extends java.lang.Exception implements Serializable
    + +

    +serialVersionUID: -397479334359858162L + +

    +

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

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

    +serialVersionUID: -3972492943653273528L + +

    + +

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

    +serialVersionUID: -3972492943653273528L + +

    +

    + + + + + +
    +Package uk.org.ury.common.show
    + +

    + + + + + +
    +Class uk.org.ury.common.show.ShowChannel extends javax.swing.AbstractListModel implements Serializable
    + +

    +serialVersionUID: -4651104185166068150L + +

    + + + + + +
    +Serialized Fields
    + +

    +items

    +
    +java.util.List<E> items
    +
    +
    +
    +
    +
    +
    @@ -413,35 +615,43 @@ master +Packageuk.org.ury.frontend.cpanels.menu
    -Package uk.org.ury.frontend.exceptions

    - + +Class uk.org.ury.frontend.cpanels.menu.DemoControlPanel extends FrontendControlPanel implements Serializable
    -Class uk.org.ury.frontend.exceptions.LoadFailureException extends java.lang.Exception implements Serializable

    -serialVersionUID: -7353531873142099828L +serialVersionUID: 7558888612002013312L

    +

    + + + + + +
    +Package uk.org.ury.frontend.cpanels.show

    - + +Class uk.org.ury.frontend.cpanels.show.LibraryControlPanel extends FrontendControlPanel implements Serializable
    -Class uk.org.ury.frontend.exceptions.UICreationFailureException extends java.lang.Exception implements Serializable

    -serialVersionUID: -7353531873142099828L +serialVersionUID: -4260057656619439704L

    @@ -449,21 +659,35 @@ master +Packageuk.org.ury.frontend.exceptions
    -Package uk.org.ury.library.exceptions

    - + +Class uk.org.ury.frontend.exceptions.LoadFailureException extends java.lang.Exception implements Serializable
    -Class uk.org.ury.library.exceptions.EmptySearchException extends java.lang.Exception implements Serializable

    -serialVersionUID: -397479334359858162L +serialVersionUID: -7353531873142099828L + +

    + +

    + + + + + +
    +Class uk.org.ury.frontend.exceptions.UICreationFailureException extends java.lang.Exception implements Serializable
    + +

    +serialVersionUID: -7353531873142099828L

    @@ -471,16 +695,16 @@ master +Packageuk.org.ury.frontend.modules.library
    -Package uk.org.ury.library.viewer

    - + +Class uk.org.ury.frontend.modules.library.LibraryTableModel extends javax.swing.table.AbstractTableModel implements Serializable
    -Class uk.org.ury.library.viewer.LibraryTableModel extends javax.swing.table.AbstractTableModel implements Serializable
    @@ -506,11 +730,11 @@ java.util.List<E> data

    - + +Class uk.org.ury.frontend.modules.library.LibraryViewerPanel extends FrontendModulePanel implements Serializable
    -Class uk.org.ury.library.viewer.LibraryViewerPanel extends FrontendModulePanel implements Serializable
    @@ -638,196 +862,38 @@ 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 - -

    -

    - - - - +Packageuk.org.ury.frontend.modules.menu
    -Package uk.org.ury.server.exceptions

    - + +Class uk.org.ury.frontend.modules.menu.DemoMenuPanel extends FrontendModulePanel implements Serializable
    -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 - -

    - -

    - - - - - -
    -Class uk.org.ury.server.exceptions.UnknownFunctionException extends HandlingException implements Serializable
    - -

    -serialVersionUID: -7557785978712465975L - -

    -

    - - - - - -
    -Package uk.org.ury.show
    - -

    - - - - - -
    -Class uk.org.ury.show.ShowChannel extends javax.swing.AbstractListModel implements Serializable
    - -

    -serialVersionUID: -4651104185166068150L +serialVersionUID: 5268978856289909262L

    - - - - - -
    -Serialized Fields
    - -

    -items

    -
    -java.util.List<E> items
    -
    -
    -
    -
    +Packageuk.org.ury.frontend.modules.show
    -Package uk.org.ury.show.viewer

    - + +Class uk.org.ury.frontend.modules.show.ChannelPanel extends FrontendPanel implements Serializable
    -Class uk.org.ury.show.viewer.ChannelPanel extends FrontendPanel implements Serializable
    @@ -889,25 +955,11 @@ javax.swing.JButton stopButton

    - + - -
    -Class uk.org.ury.show.viewer.LibraryControlPanel extends FrontendControlPanel implements Serializable
    - -

    -serialVersionUID: -4260057656619439704L - -

    - -

    - - - - +Class uk.org.ury.frontend.modules.show.ShowViewerPanel extends FrontendModulePanel implements Serializable
    -Class uk.org.ury.show.viewer.ShowViewerPanel extends FrontendModulePanel implements Serializable
    @@ -942,11 +994,11 @@ javax.swing.JPanel binGroupPanel

    - + +Class uk.org.ury.frontend.modules.show.TrackBin extends FrontendPanel implements Serializable
    -Class uk.org.ury.show.viewer.TrackBin extends FrontendPanel implements Serializable
    @@ -970,42 +1022,6 @@ javax.swing.JLabel binName

    -
    - - - - - -
    -Package uk.org.ury.testrig
    - -

    - - - - - -
    -Class uk.org.ury.testrig.DemoControlPanel extends FrontendControlPanel implements Serializable
    - -

    -serialVersionUID: 7558888612002013312L - -

    - -

    - - - - - -
    -Class uk.org.ury.testrig.DemoMenuPanel extends FrontendModulePanel implements Serializable
    - -

    -serialVersionUID: 5268978856289909262L - -

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

    + +uk.org.ury.backend.config +
    +Class Auth

    +
    +java.lang.Object
+  extended by uk.org.ury.backend.config.Auth
+
    +
    +
    +
    public class Auth
    extends java.lang.Object
    + + +

    +A login authorisation configuration +

    + +

    +

    +
    Author:
    +
    Nathan Lasseter
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Auth(java.lang.String user, + java.lang.String pass) + +
    +          Create a login auth object
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetPass() + +
    +          Get the password of the login
    + java.lang.StringgetUser() + +
    +          Get the username of the login
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +Auth

    +
    +public Auth(java.lang.String user,
+            java.lang.String pass)
    +
    +
    Create a login auth object +

    +

    +
    Parameters:
    user - The username for the login
    pass - The password for the login
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getUser

    +
    +public java.lang.String getUser()
    +
    +
    Get the username of the login +

    +

    + +
    Returns:
    String username
    +
    +
    +
    + +

    +getPass

    +
    +public java.lang.String getPass()
    +
    +
    Get the password of the login +

    +

    + +
    Returns:
    String password
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/uk/org/ury/backend/config/ConfigReader.html b/doc/uk/org/ury/backend/config/ConfigReader.html new file mode 100644 index 0000000..8a3a618 --- /dev/null +++ b/doc/uk/org/ury/backend/config/ConfigReader.html @@ -0,0 +1,315 @@ + + + + + + +ConfigReader + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +uk.org.ury.backend.config +
    +Class ConfigReader

    +
    +java.lang.Object
+  extended by uk.org.ury.backend.config.ConfigReader
+
    +
    +
    +
    public class ConfigReader
    extends java.lang.Object
    + + +

    +Reads in an XML config file and creates config objects +

    + +

    +

    +
    Author:
    +
    Nathan Lasseter
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ConfigReader(java.lang.String configFile) + +
    +          Read in the config file and create the Database and Auth configuration objects.
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + DatabasegetDatabase() + +
    +          Get the database configuration
    + AuthgetRoAuth() + +
    +          Get the read only login auth configuration
    + AuthgetRwAuth() + +
    +          Get the read write login auth configuration
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +ConfigReader

    +
    +public ConfigReader(java.lang.String configFile)
+             throws MissingCredentialsException
    +
    +
    Read in the config file and create the Database and Auth configuration objects. + Specify a config file. +

    +

    + +
    Throws: +
    MissingCredentialsException
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getDatabase

    +
    +public Database getDatabase()
    +
    +
    Get the database configuration +

    +

    + +
    Returns:
    Database database
    +
    +
    +
    + +

    +getRoAuth

    +
    +public Auth getRoAuth()
    +
    +
    Get the read only login auth configuration +

    +

    + +
    Returns:
    Auth roAauth
    +
    +
    +
    + +

    +getRwAuth

    +
    +public Auth getRwAuth()
    +
    +
    Get the read write login auth configuration +

    +

    + +
    Returns:
    Auth rwAauth
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/uk/org/ury/backend/config/Database.html b/doc/uk/org/ury/backend/config/Database.html new file mode 100644 index 0000000..ec0f77c --- /dev/null +++ b/doc/uk/org/ury/backend/config/Database.html @@ -0,0 +1,315 @@ + + + + + + +Database + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +uk.org.ury.backend.config +
    +Class Database

    +
    +java.lang.Object
+  extended by uk.org.ury.backend.config.Database
+
    +
    +
    +
    public class Database
    extends java.lang.Object
    + + +

    +A Database Server configuration +

    + +

    +

    +
    Author:
    +
    Nathan Lasseter
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Database(java.lang.String host, + int port, + java.lang.String db) + +
    +          Create a database object
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetDb() + +
    +          Get the name of the database
    + java.lang.StringgetHost() + +
    +          Get the hostname of the database server
    + intgetPort() + +
    +          Get the port the database server is running on
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +Database

    +
    +public Database(java.lang.String host,
+                int port,
+                java.lang.String db)
    +
    +
    Create a database object +

    +

    +
    Parameters:
    host - The hostname of the database server
    port - The port that the database server listens on
    db - The name of the database on the server
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getHost

    +
    +public java.lang.String getHost()
    +
    +
    Get the hostname of the database server +

    +

    + +
    Returns:
    String hostname
    +
    +
    +
    + +

    +getPort

    +
    +public int getPort()
    +
    +
    Get the port the database server is running on +

    +

    + +
    Returns:
    int port
    +
    +
    +
    + +

    +getDb

    +
    +public java.lang.String getDb()
    +
    +
    Get the name of the database +

    +

    + +
    Returns:
    String database name
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/uk/org/ury/backend/config/class-use/Auth.html b/doc/uk/org/ury/backend/config/class-use/Auth.html new file mode 100644 index 0000000..9292ac4 --- /dev/null +++ b/doc/uk/org/ury/backend/config/class-use/Auth.html @@ -0,0 +1,188 @@ + + + + + + +Uses of Class uk.org.ury.backend.config.Auth + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.backend.config.Auth

    +
    + + + + + + + + + +
    +Packages that use Auth
    uk.org.ury.backend.config  
    +  +

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

    + + + + + + + + + + + + + +
    Methods in uk.org.ury.backend.config that return Auth
    + AuthConfigReader.getRoAuth() + +
    +          Get the read only login auth configuration
    + AuthConfigReader.getRwAuth() + +
    +          Get the read write login auth configuration
    +  +

    +

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

    +Uses of Class
    uk.org.ury.backend.config.ConfigReader

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

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

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

    +

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

    +Uses of Class
    uk.org.ury.backend.config.Database

    +
    + + + + + + + + + +
    +Packages that use Database
    uk.org.ury.backend.config  
    +  +

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

    + + + + + + + + + +
    Methods in uk.org.ury.backend.config that return Database
    + DatabaseConfigReader.getDatabase() + +
    +          Get the database configuration
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/backend/config/package-frame.html b/doc/uk/org/ury/backend/config/package-frame.html new file mode 100644 index 0000000..082e1a1 --- /dev/null +++ b/doc/uk/org/ury/backend/config/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +uk.org.ury.backend.config + + + + + + + + + + + +uk.org.ury.backend.config + + + + +
    +Classes  + +
    +Auth +
    +ConfigReader +
    +Database
    + + + + diff --git a/doc/uk/org/ury/backend/config/package-summary.html b/doc/uk/org/ury/backend/config/package-summary.html new file mode 100644 index 0000000..2130ac0 --- /dev/null +++ b/doc/uk/org/ury/backend/config/package-summary.html @@ -0,0 +1,165 @@ + + + + + + +uk.org.ury.backend.config + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.backend.config +

    + + + + + + + + + + + + + + + + + +
    +Class Summary
    AuthA login authorisation configuration
    ConfigReaderReads in an XML config file and creates config objects
    DatabaseA Database Server configuration
    +  + +

    +

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

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

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

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

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

    + + + + + + + + + + + +
    +Classes in uk.org.ury.backend.config used by uk.org.ury.backend.config
    Auth + +
    +          A login authorisation configuration
    Database + +
    +          A Database Server configuration
    +  +

    + + + + + + + + +
    +Classes in uk.org.ury.backend.config used by uk.org.ury.backend.database
    ConfigReader + +
    +          Reads in an XML config file and creates config objects
    +  +

    +

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

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

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

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

    + +

    +

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

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

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

    +DatabaseDriver

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

    +

    +
    Parameters:
    config - The config with login details.
    type - The user class to log in to the database with. +
    Throws: +
    java.lang.IllegalArgumentException - if the user class is not supported (this should not happen). +
    MissingCredentialsException - if the user class login credentials could not be loaded. +
    ConnectionFailureException - if the database backend failed to connect to the database + server.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +executeQuery

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

    +

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

    +executeQuery

    +
    +public java.sql.ResultSet executeQuery(java.lang.String sql,
+                                       java.lang.Object[] params,
+                                       int fetchSize)
+                                throws java.sql.SQLException
    +
    +
    Perform a SQL statement with arguments. + + This accepts an array of parameter objects, which must each either be + String or Integer objects. The objects will be used sequentially to fill + in '?' placeholders in the query text. +

    +

    +
    Parameters:
    sql - The SQL statement to execute.
    params - A list of parameter objects.
    fetchSize - The maximum number of query rows to return. +
    Returns:
    the set of results from the query. +
    Throws: +
    java.lang.IllegalArgumentException - if any of the parameters is unsupported by the database as a + statement parameter. +
    java.sql.SQLException - if a SQL error occurs.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/uk/org/ury/backend/database/DatabaseItem.html b/doc/uk/org/ury/backend/database/DatabaseItem.html new file mode 100644 index 0000000..1d98e28 --- /dev/null +++ b/doc/uk/org/ury/backend/database/DatabaseItem.html @@ -0,0 +1,320 @@ + + + + + + +DatabaseItem + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

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

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

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

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

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

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

    +DatabaseItem

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

    +

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

    +has

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

    +

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

    +get

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

    +

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

    +asResponse

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

    +

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

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

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

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

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

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

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

    +READ_ONLY

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

    +READ_WRITE

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

    +configName

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

    +

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

    +values

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

    +

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

    +valueOf

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

    +

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

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

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

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

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

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

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

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

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

    +

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

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

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

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

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

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

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

    +

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

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

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

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

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

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

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

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

    +

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

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

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

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

    + +

    +

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

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

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

    +ConnectionFailureException

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

    +

    +
    + +

    +ConnectionFailureException

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

    +

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

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

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

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

    + +

    +

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

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

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

    +MissingCredentialsException

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

    +

    +
    + +

    +MissingCredentialsException

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

    +

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

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

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

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

    + +

    +

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

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

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

    +MissingPropertyException

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

    +

    +
    + +

    +MissingPropertyException

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

    +

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

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

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

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

    + +

    +

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

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

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

    +QueryFailureException

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

    +

    +
    + +

    +QueryFailureException

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

    +

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

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

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

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

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

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

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

    +

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

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

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

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

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

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

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

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

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

    +

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

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

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

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

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

    +

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

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

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

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

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

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

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

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

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

    +

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

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

    +Exceptions thrown by the database services classes. +

    +See: +
    +          Description +

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

    +

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

    + +

    +

    Exceptions thrown by the database services classes.

    +

    + +

    +

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

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

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

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

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

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

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

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

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

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

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

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

    +

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

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

    +Database services for the URY Presenter Suite. +

    +See: +
    +          Description +

    + + + + + + + + + + + + + +
    +Class Summary
    DatabaseDriverA database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.
    DatabaseItem<E,T>An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.
    +  + +

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

    +

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

    + +

    +

    Database services for the URY Presenter Suite.

    +

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

    +

    + +

    +

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

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

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +

    +Enum Hierarchy +

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

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

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

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

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

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

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

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

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

    +

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

    +
    +java.lang.Object
+  extended by uk.org.ury.backend.server.AbstractRequestHandler
+      extended by uk.org.ury.backend.handlers.LibraryRequestHandler
+
    +
    +
    All Implemented Interfaces:
    org.apache.http.protocol.HttpRequestHandler
    +
    +
    +
    +
    public class LibraryRequestHandler
    extends AbstractRequestHandler
    + + +

    +A request handler for library queries. +

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    LibraryRequestHandler(Server server, + java.lang.String mount) + +
    +          Construct a new LibraryRequestHandler.
    +  + + + + + + + + + + + +
    +Method Summary
    + voidhandleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          Handle a HTTP GET request.
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.backend.server.AbstractRequestHandler
    handle
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +LibraryRequestHandler

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

    +

    +
    Parameters:
    server - The instance of the URY server responsible for the request.
    mount - The directory to which this handler is to be mounted.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +handleGet

    +
    +public void handleGet(org.apache.http.HttpRequest request,
+                      org.apache.http.HttpResponse response,
+                      org.apache.http.protocol.HttpContext context)
+               throws HandlerNotFoundException,
+                      HandlerSetupFailureException,
+                      HandleFailureException,
+                      BadRequestException,
+                      NotAHandlerException,
+                      UnknownFunctionException
    +
    +
    Handle a HTTP GET request. +

    +

    +
    +
    +
    +
    Parameters:
    request - The HTTP request.
    response - The response that the handler will populate during the + handling of the request.
    context - The HTTP context. +
    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. +
    UnknownFunctionException - if the request is for a path that does not correspond to one + of this handler's functions.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/uk/org/ury/backend/handlers/class-use/LibraryRequestHandler.html b/doc/uk/org/ury/backend/handlers/class-use/LibraryRequestHandler.html new file mode 100644 index 0000000..7b0212b --- /dev/null +++ b/doc/uk/org/ury/backend/handlers/class-use/LibraryRequestHandler.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.backend.handlers.LibraryRequestHandler + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.backend.handlers.LibraryRequestHandler

    +
    +No usage of uk.org.ury.backend.handlers.LibraryRequestHandler +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/backend/handlers/package-frame.html b/doc/uk/org/ury/backend/handlers/package-frame.html new file mode 100644 index 0000000..3bbf29b --- /dev/null +++ b/doc/uk/org/ury/backend/handlers/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +uk.org.ury.backend.handlers + + + + + + + + + + + +uk.org.ury.backend.handlers + + + + +
    +Classes  + +
    +LibraryRequestHandler
    + + + + diff --git a/doc/uk/org/ury/backend/handlers/package-summary.html b/doc/uk/org/ury/backend/handlers/package-summary.html new file mode 100644 index 0000000..00a4779 --- /dev/null +++ b/doc/uk/org/ury/backend/handlers/package-summary.html @@ -0,0 +1,157 @@ + + + + + + +uk.org.ury.backend.handlers + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.backend.handlers +

    + + + + + + + + + +
    +Class Summary
    LibraryRequestHandlerA request handler for library queries.
    +  + +

    +

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

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

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

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

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

    +
    +No usage of uk.org.ury.backend.handlers +

    +

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

    + +uk.org.ury.backend.server +
    +Class AbstractRequestHandler

    +
    +java.lang.Object
+  extended by uk.org.ury.backend.server.AbstractRequestHandler
+
    +
    +
    All Implemented Interfaces:
    org.apache.http.protocol.HttpRequestHandler
    +
    +
    +
    Direct Known Subclasses:
    HttpHandler, LibraryRequestHandler
    +
    +
    +
    +
    public abstract class AbstractRequestHandler
    extends java.lang.Object
    implements org.apache.http.protocol.HttpRequestHandler
    + + +

    +An abstract request handler for HttpCore, providing basic functionality such + as uniform error response. +

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    AbstractRequestHandler(Server server, + java.lang.String mount) + +
    +          Constructs a new AbstractRequestHandler.
    +  + + + + + + + + + + + +
    +Method Summary
    + voidhandle(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          Begins handling of a HTTP request.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +AbstractRequestHandler

    +
    +public AbstractRequestHandler(Server server,
+                              java.lang.String mount)
    +
    +
    Constructs a new AbstractRequestHandler. + + Obviously, this class cannot be instantiated directly. +

    +

    +
    Parameters:
    server - The instance of the URY server responsible for the request.
    mount - The directory to which this handler is to be mounted.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +handle

    +
    +public void handle(org.apache.http.HttpRequest request,
+                   org.apache.http.HttpResponse response,
+                   org.apache.http.protocol.HttpContext context)
+            throws org.apache.http.HttpException,
+                   java.io.IOException
    +
    +
    Begins handling of a HTTP request. +

    +

    +
    Specified by:
    handle in interface org.apache.http.protocol.HttpRequestHandler
    +
    +
    +
    Parameters:
    request - The HTTP request.
    response - The response that the handler will populate during the + handling of the request.
    context - The HTTP context. +
    Throws: +
    org.apache.http.HttpException +
    java.io.IOException
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/uk/org/ury/backend/server/ApiRequestHandler.html b/doc/uk/org/ury/backend/server/ApiRequestHandler.html new file mode 100644 index 0000000..7f3b44c --- /dev/null +++ b/doc/uk/org/ury/backend/server/ApiRequestHandler.html @@ -0,0 +1,238 @@ + + + + + + +ApiRequestHandler + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +uk.org.ury.backend.server +
    +Interface ApiRequestHandler

    +
    +
    All Known Implementing Classes:
    ServerRequestHandler
    +
    +
    +
    +
    public interface ApiRequestHandler
    + + +

    +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/backend/server/HttpHandler.html b/doc/uk/org/ury/backend/server/HttpHandler.html new file mode 100644 index 0000000..3417051 --- /dev/null +++ b/doc/uk/org/ury/backend/server/HttpHandler.html @@ -0,0 +1,309 @@ + + + + + + +HttpHandler + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +uk.org.ury.backend.server +
    +Class HttpHandler

    +
    +java.lang.Object
+  extended by uk.org.ury.backend.server.AbstractRequestHandler
+      extended by uk.org.ury.backend.server.HttpHandler
+
    +
    +
    All Implemented Interfaces:
    org.apache.http.protocol.HttpRequestHandler
    +
    +
    +
    +
    public class HttpHandler
    extends AbstractRequestHandler
    implements org.apache.http.protocol.HttpRequestHandler
    + + +

    +

    +
    Author:
    +
    Matt Windsor, Apache Software Foundation
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    HttpHandler(Server server, + java.lang.String mount) + +
    +          Construct a new HttpHandler.
    +  + + + + + + + + + + + +
    +Method Summary
    + voidhandleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          Handle a HTTP GET request.
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.backend.server.AbstractRequestHandler
    handle
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  + + + + + + + +
    Methods inherited from interface org.apache.http.protocol.HttpRequestHandler
    handle
    +  +

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

    +HttpHandler

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

    +

    +
    Parameters:
    server - The instance of the URY server responsible for the request.
    mount - The directory to which this handler is to be mounted.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +handleGet

    +
    +public void handleGet(org.apache.http.HttpRequest request,
+                      org.apache.http.HttpResponse response,
+                      org.apache.http.protocol.HttpContext context)
+               throws HandlerNotFoundException,
+                      HandlerSetupFailureException,
+                      HandleFailureException,
+                      BadRequestException,
+                      NotAHandlerException
    +
    +
    Handle a HTTP GET request. +

    +

    +
    +
    +
    +
    Parameters:
    request - The HTTP request.
    response - The response that the handler will populate during the + handling of the request.
    context - The HTTP context. +
    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.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/uk/org/ury/backend/server/HttpListenerThread.html b/doc/uk/org/ury/backend/server/HttpListenerThread.html new file mode 100644 index 0000000..18c5b3f --- /dev/null +++ b/doc/uk/org/ury/backend/server/HttpListenerThread.html @@ -0,0 +1,322 @@ + + + + + + +HttpListenerThread + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +uk.org.ury.backend.server +
    +Class HttpListenerThread

    +
    +java.lang.Object
+  extended by java.lang.Thread
+      extended by uk.org.ury.backend.server.HttpListenerThread
+
    +
    +
    All Implemented Interfaces:
    java.lang.Runnable
    +
    +
    +
    +
    public class HttpListenerThread
    extends java.lang.Thread
    + + +

    +Listener thread for the URY server HTTP interface. +

    + +

    +

    +
    Author:
    +
    Matt Windsor, Apache Software Foundation
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class java.lang.Thread
    java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.lang.Thread
    MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
    +  + + + + + + + + + + +
    +Constructor Summary
    HttpListenerThread(int port, + Server server) + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + voidrun() + +
    +          Thread execution body.
    +  + + + + + + + +
    Methods inherited from class java.lang.Thread
    activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +HttpListenerThread

    +
    +public HttpListenerThread(int port,
+                          Server server)
+                   throws java.io.IOException
    +
    +
    + +
    Throws: +
    java.io.IOException
    +
    + + + + + + + + +
    +Method Detail
    + +

    +run

    +
    +public void run()
    +
    +
    Thread execution body. +

    +

    +
    Specified by:
    run in interface java.lang.Runnable
    Overrides:
    run in class java.lang.Thread
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/uk/org/ury/backend/server/HttpWorkerThread.html b/doc/uk/org/ury/backend/server/HttpWorkerThread.html new file mode 100644 index 0000000..8d8db00 --- /dev/null +++ b/doc/uk/org/ury/backend/server/HttpWorkerThread.html @@ -0,0 +1,324 @@ + + + + + + +HttpWorkerThread + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +uk.org.ury.backend.server +
    +Class HttpWorkerThread

    +
    +java.lang.Object
+  extended by java.lang.Thread
+      extended by uk.org.ury.backend.server.HttpWorkerThread
+
    +
    +
    All Implemented Interfaces:
    java.lang.Runnable
    +
    +
    +
    +
    public class HttpWorkerThread
    extends java.lang.Thread
    + + +

    +A worker thread in the server HTTP interface. + + This thread handles requests from the connected client, passing them to the + request handler(s). +

    + +

    +

    +
    Author:
    +
    Matt Windsor, Apache Software Foundation
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class java.lang.Thread
    java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.lang.Thread
    MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
    +  + + + + + + + + + + +
    +Constructor Summary
    HttpWorkerThread(org.apache.http.protocol.HttpService service, + org.apache.http.HttpServerConnection conn) + +
    +          Construct a new HttpWorkerThread.
    +  + + + + + + + + + + + +
    +Method Summary
    + voidrun() + +
    +          Thread execution body.
    +  + + + + + + + +
    Methods inherited from class java.lang.Thread
    activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +HttpWorkerThread

    +
    +public HttpWorkerThread(org.apache.http.protocol.HttpService service,
+                        org.apache.http.HttpServerConnection conn)
    +
    +
    Construct a new HttpWorkerThread. +

    +

    +
    Parameters:
    service - The HTTP service the thread is working for.
    conn - The connection the thread is listening on.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +run

    +
    +public void run()
    +
    +
    Thread execution body. +

    +

    +
    Specified by:
    run in interface java.lang.Runnable
    Overrides:
    run in class java.lang.Thread
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/uk/org/ury/backend/server/Server.html b/doc/uk/org/ury/backend/server/Server.html new file mode 100644 index 0000000..afdc004 --- /dev/null +++ b/doc/uk/org/ury/backend/server/Server.html @@ -0,0 +1,384 @@ + + + + + + +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.backend.server +
    +Class Server

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

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

    + +

    +

    +
    Version:
    +
    2011.0320
    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringDOCTYPE + +
    +           
    +static java.lang.StringINDEX_HTML + +
    +           
    +static java.lang.StringSERVER_VERSION + +
    +           
    +  + + + + + + + + + + +
    +Constructor Summary
    Server() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + DatabaseDrivergetDatabaseConnection(UserClass userClass) + +
    +          Gets a database connection using the given user class.
    + java.lang.StringgetVersion() + +
    +           
    +static voidmain(java.lang.String[] args) + +
    +          The main method, which serves to create a server.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +SERVER_VERSION

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

    +DOCTYPE

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

    +INDEX_HTML

    +
    +public static final java.lang.String INDEX_HTML
    +
    +
    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +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.
    +
    +
    +
    + +

    +getDatabaseConnection

    +
    +public DatabaseDriver getDatabaseConnection(UserClass userClass)
+                                     throws MissingCredentialsException,
+                                            ConnectionFailureException
    +
    +
    Gets 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/backend/server/ServerRequestHandler.html b/doc/uk/org/ury/backend/server/ServerRequestHandler.html new file mode 100644 index 0000000..217821e --- /dev/null +++ b/doc/uk/org/ury/backend/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.backend.server +
    +Class ServerRequestHandler

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

    +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 ApiRequestHandler
    +
    +
    +
    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/backend/server/class-use/AbstractRequestHandler.html b/doc/uk/org/ury/backend/server/class-use/AbstractRequestHandler.html new file mode 100644 index 0000000..bcd6183 --- /dev/null +++ b/doc/uk/org/ury/backend/server/class-use/AbstractRequestHandler.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.AbstractRequestHandler + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.backend.server.AbstractRequestHandler

    +
    + + + + + + + + + + + + + +
    +Packages that use AbstractRequestHandler
    uk.org.ury.backend.handlers  
    uk.org.ury.backend.serverThe URY Server kernel. 
    +  +

    + + + + + +
    +Uses of AbstractRequestHandler in uk.org.ury.backend.handlers
    +  +

    + + + + + + + + + +
    Subclasses of AbstractRequestHandler in uk.org.ury.backend.handlers
    + classLibraryRequestHandler + +
    +          A request handler for library queries.
    +  +

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

    + + + + + + + + + +
    Subclasses of AbstractRequestHandler in uk.org.ury.backend.server
    + classHttpHandler + +
    +           
    +  +

    +

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

    +Uses of Interface
    uk.org.ury.backend.server.ApiRequestHandler

    +
    + + + + + + + + + +
    +Packages that use ApiRequestHandler
    uk.org.ury.backend.serverThe URY Server kernel. 
    +  +

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

    + + + + + + + + + +
    Classes in uk.org.ury.backend.server that implement ApiRequestHandler
    + 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/backend/server/class-use/HttpHandler.html b/doc/uk/org/ury/backend/server/class-use/HttpHandler.html new file mode 100644 index 0000000..a64ac0d --- /dev/null +++ b/doc/uk/org/ury/backend/server/class-use/HttpHandler.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.HttpHandler + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.backend.server.HttpHandler

    +
    +No usage of uk.org.ury.backend.server.HttpHandler +

    +

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

    +Uses of Class
    uk.org.ury.backend.server.HttpListenerThread

    +
    +No usage of uk.org.ury.backend.server.HttpListenerThread +

    +

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

    +Uses of Class
    uk.org.ury.backend.server.HttpWorkerThread

    +
    +No usage of uk.org.ury.backend.server.HttpWorkerThread +

    +

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

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

    +
    + + + + + + + + + + + + + +
    +Packages that use Server
    uk.org.ury.backend.handlers  
    uk.org.ury.backend.serverThe URY Server kernel. 
    +  +

    + + + + + +
    +Uses of Server in uk.org.ury.backend.handlers
    +  +

    + + + + + + + + +
    Constructors in uk.org.ury.backend.handlers with parameters of type Server
    LibraryRequestHandler(Server server, + java.lang.String mount) + +
    +          Construct a new LibraryRequestHandler.
    +  +

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

    + + + + + + + + + + + + + +
    Methods in uk.org.ury.backend.server with parameters of type Server
    + java.util.Map<java.lang.String,java.lang.Object>ApiRequestHandler.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>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).
    +  +

    + + + + + + + + + + + + + + +
    Constructors in uk.org.ury.backend.server with parameters of type Server
    AbstractRequestHandler(Server server, + java.lang.String mount) + +
    +          Constructs a new AbstractRequestHandler.
    HttpHandler(Server server, + java.lang.String mount) + +
    +          Construct a new HttpHandler.
    HttpListenerThread(int port, + Server server) + +
    +           
    +  +

    +

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

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

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

    +

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

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.backend.server.exceptions.HandlingException
+              extended by uk.org.ury.backend.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/backend/server/exceptions/HandleFailureException.html b/doc/uk/org/ury/backend/server/exceptions/HandleFailureException.html new file mode 100644 index 0000000..1c5629f --- /dev/null +++ b/doc/uk/org/ury/backend/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.backend.server.exceptions +
    +Class HandleFailureException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.backend.server.exceptions.HandlingException
+              extended by uk.org.ury.backend.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/backend/server/exceptions/HandlerNotFoundException.html b/doc/uk/org/ury/backend/server/exceptions/HandlerNotFoundException.html new file mode 100644 index 0000000..78aef35 --- /dev/null +++ b/doc/uk/org/ury/backend/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.backend.server.exceptions +
    +Class HandlerNotFoundException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.backend.server.exceptions.HandlingException
+              extended by uk.org.ury.backend.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/backend/server/exceptions/HandlerSetupFailureException.html b/doc/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.html new file mode 100644 index 0000000..6820215 --- /dev/null +++ b/doc/uk/org/ury/backend/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.backend.server.exceptions +
    +Class HandlerSetupFailureException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.backend.server.exceptions.HandlingException
+              extended by uk.org.ury.backend.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/backend/server/exceptions/HandlingException.html b/doc/uk/org/ury/backend/server/exceptions/HandlingException.html new file mode 100644 index 0000000..04ea1db --- /dev/null +++ b/doc/uk/org/ury/backend/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.backend.server.exceptions +
    +Class HandlingException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.backend.server.exceptions.HandlingException
+
    +
    +
    All Implemented Interfaces:
    java.io.Serializable
    +
    +
    +
    Direct Known Subclasses:
    BadRequestException, HandleFailureException, HandlerNotFoundException, HandlerSetupFailureException, NotAHandlerException, UnknownFunctionException
    +
    +
    +
    +
    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/backend/server/exceptions/NotAHandlerException.html b/doc/uk/org/ury/backend/server/exceptions/NotAHandlerException.html new file mode 100644 index 0000000..bec4181 --- /dev/null +++ b/doc/uk/org/ury/backend/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.backend.server.exceptions +
    +Class NotAHandlerException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.backend.server.exceptions.HandlingException
+              extended by uk.org.ury.backend.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/backend/server/exceptions/UnknownFunctionException.html b/doc/uk/org/ury/backend/server/exceptions/UnknownFunctionException.html new file mode 100644 index 0000000..29c6529 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/UnknownFunctionException.html @@ -0,0 +1,252 @@ + + + + + + +UnknownFunctionException + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +uk.org.ury.backend.server.exceptions +
    +Class UnknownFunctionException

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

    +Exception thrown when a handler receives a request for a path that does not + correspond to one of its functions. +

    + +

    +

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

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

    +UnknownFunctionException

    +
    +public UnknownFunctionException(java.lang.String path)
    +
    +
    Construct a new UnknownFunctionException. +

    +

    +
    Parameters:
    path - The path that was requested.
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/uk/org/ury/backend/server/exceptions/class-use/BadRequestException.html b/doc/uk/org/ury/backend/server/exceptions/class-use/BadRequestException.html new file mode 100644 index 0000000..0a06f90 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/class-use/BadRequestException.html @@ -0,0 +1,213 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.exceptions.BadRequestException + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

    +
    + + + + + + + + + + + + + +
    +Packages that use BadRequestException
    uk.org.ury.backend.handlers  
    uk.org.ury.backend.serverThe URY Server kernel. 
    +  +

    + + + + + +
    +Uses of BadRequestException in uk.org.ury.backend.handlers
    +  +

    + + + + + + + + + +
    Methods in uk.org.ury.backend.handlers that throw BadRequestException
    + voidLibraryRequestHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          Handle a HTTP GET request.
    +  +

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

    + + + + + + + + + +
    Methods in uk.org.ury.backend.server that throw BadRequestException
    + voidHttpHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          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/backend/server/exceptions/class-use/HandleFailureException.html b/doc/uk/org/ury/backend/server/exceptions/class-use/HandleFailureException.html new file mode 100644 index 0000000..2429bc2 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/class-use/HandleFailureException.html @@ -0,0 +1,233 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.exceptions.HandleFailureException + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

    +
    + + + + + + + + + + + + + +
    +Packages that use HandleFailureException
    uk.org.ury.backend.handlers  
    uk.org.ury.backend.serverThe URY Server kernel. 
    +  +

    + + + + + +
    +Uses of HandleFailureException in uk.org.ury.backend.handlers
    +  +

    + + + + + + + + + +
    Methods in uk.org.ury.backend.handlers that throw HandleFailureException
    + voidLibraryRequestHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          Handle a HTTP GET request.
    +  +

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

    + + + + + + + + + + + + + + + + + +
    Methods in uk.org.ury.backend.server that throw HandleFailureException
    + voidHttpHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          Handle a HTTP GET request.
    + java.util.Map<java.lang.String,java.lang.Object>ApiRequestHandler.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>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).
    +  +

    +

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

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

    +
    + + + + + + + + + + + + + +
    +Packages that use HandlerNotFoundException
    uk.org.ury.backend.handlers  
    uk.org.ury.backend.serverThe URY Server kernel. 
    +  +

    + + + + + +
    +Uses of HandlerNotFoundException in uk.org.ury.backend.handlers
    +  +

    + + + + + + + + + +
    Methods in uk.org.ury.backend.handlers that throw HandlerNotFoundException
    + voidLibraryRequestHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          Handle a HTTP GET request.
    +  +

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

    + + + + + + + + + +
    Methods in uk.org.ury.backend.server that throw HandlerNotFoundException
    + voidHttpHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          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/backend/server/exceptions/class-use/HandlerSetupFailureException.html b/doc/uk/org/ury/backend/server/exceptions/class-use/HandlerSetupFailureException.html new file mode 100644 index 0000000..74df677 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/class-use/HandlerSetupFailureException.html @@ -0,0 +1,213 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.exceptions.HandlerSetupFailureException + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

    +
    + + + + + + + + + + + + + +
    +Packages that use HandlerSetupFailureException
    uk.org.ury.backend.handlers  
    uk.org.ury.backend.serverThe URY Server kernel. 
    +  +

    + + + + + +
    +Uses of HandlerSetupFailureException in uk.org.ury.backend.handlers
    +  +

    + + + + + + + + + +
    Methods in uk.org.ury.backend.handlers that throw HandlerSetupFailureException
    + voidLibraryRequestHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          Handle a HTTP GET request.
    +  +

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

    + + + + + + + + + +
    Methods in uk.org.ury.backend.server that throw HandlerSetupFailureException
    + voidHttpHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          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/backend/server/exceptions/class-use/HandlingException.html b/doc/uk/org/ury/backend/server/exceptions/class-use/HandlingException.html new file mode 100644 index 0000000..de0bffa --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/class-use/HandlingException.html @@ -0,0 +1,226 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.exceptions.HandlingException + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

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

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Subclasses of HandlingException in uk.org.ury.backend.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).
    + classUnknownFunctionException + +
    +          Exception thrown when a handler receives a request for a path that does not + correspond to one of its functions.
    +  +

    +

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

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

    +
    + + + + + + + + + + + + + +
    +Packages that use NotAHandlerException
    uk.org.ury.backend.handlers  
    uk.org.ury.backend.serverThe URY Server kernel. 
    +  +

    + + + + + +
    +Uses of NotAHandlerException in uk.org.ury.backend.handlers
    +  +

    + + + + + + + + + +
    Methods in uk.org.ury.backend.handlers that throw NotAHandlerException
    + voidLibraryRequestHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          Handle a HTTP GET request.
    +  +

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

    + + + + + + + + + +
    Methods in uk.org.ury.backend.server that throw NotAHandlerException
    + voidHttpHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          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/backend/server/exceptions/class-use/UnknownFunctionException.html b/doc/uk/org/ury/backend/server/exceptions/class-use/UnknownFunctionException.html new file mode 100644 index 0000000..2de3a73 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/class-use/UnknownFunctionException.html @@ -0,0 +1,182 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.exceptions.UnknownFunctionException + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.backend.server.exceptions.UnknownFunctionException

    +
    + + + + + + + + + +
    +Packages that use UnknownFunctionException
    uk.org.ury.backend.handlers  
    +  +

    + + + + + +
    +Uses of UnknownFunctionException in uk.org.ury.backend.handlers
    +  +

    + + + + + + + + + +
    Methods in uk.org.ury.backend.handlers that throw UnknownFunctionException
    + voidLibraryRequestHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
    +          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/backend/server/exceptions/package-frame.html b/doc/uk/org/ury/backend/server/exceptions/package-frame.html new file mode 100644 index 0000000..b480516 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/package-frame.html @@ -0,0 +1,44 @@ + + + + + + +uk.org.ury.backend.server.exceptions + + + + + + + + + + + +uk.org.ury.backend.server.exceptions + + + + +
    +Exceptions  + +
    +BadRequestException +
    +HandleFailureException +
    +HandlerNotFoundException +
    +HandlerSetupFailureException +
    +HandlingException +
    +NotAHandlerException +
    +UnknownFunctionException
    + + + + diff --git a/doc/uk/org/ury/backend/server/exceptions/package-summary.html b/doc/uk/org/ury/backend/server/exceptions/package-summary.html new file mode 100644 index 0000000..eef32f9 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/package-summary.html @@ -0,0 +1,187 @@ + + + + + + +uk.org.ury.backend.server.exceptions + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.backend.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).
    UnknownFunctionExceptionException thrown when a handler receives a request for a path that does not + correspond to one of its functions.
    +  + +

    +

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

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

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

    +
    + + + + + + + + + + + + + + + + + +
    +Packages that use uk.org.ury.backend.server.exceptions
    uk.org.ury.backend.handlers  
    uk.org.ury.backend.serverThe URY Server kernel. 
    uk.org.ury.backend.server.exceptions  
    +  +

    + + + + + + + + + + + + + + + + + + + + + + + +
    +Classes in uk.org.ury.backend.server.exceptions used by uk.org.ury.backend.handlers
    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).
    UnknownFunctionException + +
    +          Exception thrown when a handler receives a request for a path that does not + correspond to one of its functions.
    +  +

    + + + + + + + + + + + + + + + + + + + + +
    +Classes in uk.org.ury.backend.server.exceptions used by uk.org.ury.backend.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.backend.server.exceptions used by uk.org.ury.backend.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/backend/server/package-frame.html b/doc/uk/org/ury/backend/server/package-frame.html new file mode 100644 index 0000000..2bb20e0 --- /dev/null +++ b/doc/uk/org/ury/backend/server/package-frame.html @@ -0,0 +1,53 @@ + + + + + + +uk.org.ury.backend.server + + + + + + + + + + + +uk.org.ury.backend.server + + + + +
    +Interfaces  + +
    +ApiRequestHandler
    + + + + + + +
    +Classes  + +
    +AbstractRequestHandler +
    +HttpHandler +
    +HttpListenerThread +
    +HttpWorkerThread +
    +Server +
    +ServerRequestHandler
    + + + + diff --git a/doc/uk/org/ury/backend/server/package-summary.html b/doc/uk/org/ury/backend/server/package-summary.html new file mode 100644 index 0000000..71b017e --- /dev/null +++ b/doc/uk/org/ury/backend/server/package-summary.html @@ -0,0 +1,220 @@ + + + + + + +uk.org.ury.backend.server + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.backend.server +

    +The URY Server kernel. +

    +See: +
    +          Description +

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

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    AbstractRequestHandlerAn abstract request handler for HttpCore, providing basic functionality such + as uniform error response.
    HttpHandler 
    HttpListenerThreadListener thread for the URY server HTTP interface.
    HttpWorkerThreadA worker thread in the server HTTP interface.
    ServerThe unified URY server, accepting requests over HTTP.
    ServerRequestHandlerA request handler for server queries.
    +  + +

    +

    +Package uk.org.ury.backend.server Description +

    + +

    +

    The URY Server kernel.

    +

    The URY Server provides high-level access to the assets + (database, files and sound playback) available on the computer + systems of a radio station, exposing an intuitive application + programming interface using standard formats.

    +

    The server kernel consists of an Apache HttpCore-based HTTP + server implementation, which serves the high-level interface + to the server, code for managing the external modules that make + up the URY backend, and a common provider of objects useful to + server-level modules.

    +

    Though designed and built to replace the systems in place + at University Radio York, it is hoped that the URY Server will + be of use +

    + +

    +

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

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

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

    +
    + + + + + + + + + + + + + +
    +Packages that use uk.org.ury.backend.server
    uk.org.ury.backend.handlers  
    uk.org.ury.backend.serverThe URY Server kernel. 
    +  +

    + + + + + + + + + + + +
    +Classes in uk.org.ury.backend.server used by uk.org.ury.backend.handlers
    AbstractRequestHandler + +
    +          An abstract request handler for HttpCore, providing basic functionality such + as uniform error response.
    Server + +
    +          The unified URY server, accepting requests over HTTP.
    +  +

    + + + + + + + + + + + + + + +
    +Classes in uk.org.ury.backend.server used by uk.org.ury.backend.server
    AbstractRequestHandler + +
    +          An abstract request handler for HttpCore, providing basic functionality such + as uniform error response.
    ApiRequestHandler + +
    +          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/common/library/LibraryUtils.html b/doc/uk/org/ury/common/library/LibraryUtils.html new file mode 100644 index 0000000..4ecd225 --- /dev/null +++ b/doc/uk/org/ury/common/library/LibraryUtils.html @@ -0,0 +1,277 @@ + + + + + + +LibraryUtils + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.common.library +
    +Class LibraryUtils

    +
    +java.lang.Object
+  extended by uk.org.ury.common.library.LibraryUtils
+
    +
    +
    +
    public class LibraryUtils
    extends java.lang.Object
    + + +

    +A set of common utility routines to facilitate the extraction of + library items from the library areas of the URY database. +

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    LibraryUtils() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    +static java.util.List<LibraryItem>search(DatabaseDriver db, + java.lang.String search) + +
    +          Perform a library search.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +LibraryUtils

    +
    +public LibraryUtils()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +search

    +
    +public static java.util.List<LibraryItem> search(DatabaseDriver db,
+                                                 java.lang.String search)
+                                          throws QueryFailureException,
+                                                 EmptySearchException
    +
    +
    Perform a library search. +

    +

    +
    Parameters:
    db - The database to query.
    search - The search fragment to include in the search. + Can be empty or null. +
    Returns:
    a list of LibraryItems matching the search terms. +
    Throws: +
    java.lang.IllegalArgumentException - if the search term is + are null. +
    QueryFailureException - if the database backend + yielded an error while executing the search + query. +
    EmptySearchException - if the search term is + empty (to be handled as a user error).
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/common/library/class-use/LibraryUtils.html b/doc/uk/org/ury/common/library/class-use/LibraryUtils.html new file mode 100644 index 0000000..b90b1d9 --- /dev/null +++ b/doc/uk/org/ury/common/library/class-use/LibraryUtils.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.common.library.LibraryUtils + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.common.library.LibraryUtils

    +
    +No usage of uk.org.ury.common.library.LibraryUtils +

    +

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

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

    +Exception thrown when a library search is initiated + in which the query string is null. + + Frontends should handle this nicely. Do NOT treat this + as a fatal error! +

    + +

    +

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

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

    +EmptySearchException

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

    +

    +
    + +

    +EmptySearchException

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

    +

    +
    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/common/library/exceptions/class-use/EmptySearchException.html b/doc/uk/org/ury/common/library/exceptions/class-use/EmptySearchException.html new file mode 100644 index 0000000..0f86969 --- /dev/null +++ b/doc/uk/org/ury/common/library/exceptions/class-use/EmptySearchException.html @@ -0,0 +1,210 @@ + + + + + + +Uses of Class uk.org.ury.common.library.exceptions.EmptySearchException + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.common.library.exceptions.EmptySearchException

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

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

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

    + + + + + +
    +Uses of EmptySearchException in uk.org.ury.frontend.modules.library
    +  +

    + + + + + + + + + +
    Methods in uk.org.ury.frontend.modules.library that throw EmptySearchException
    + voidLibraryViewer.doSearch(java.lang.String search) + +
    +          Does a library search.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/common/library/exceptions/package-frame.html b/doc/uk/org/ury/common/library/exceptions/package-frame.html new file mode 100644 index 0000000..7d2429c --- /dev/null +++ b/doc/uk/org/ury/common/library/exceptions/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +uk.org.ury.common.library.exceptions + + + + + + + + + + + +uk.org.ury.common.library.exceptions + + + + +
    +Exceptions  + +
    +EmptySearchException
    + + + + diff --git a/doc/uk/org/ury/common/library/exceptions/package-summary.html b/doc/uk/org/ury/common/library/exceptions/package-summary.html new file mode 100644 index 0000000..4650d40 --- /dev/null +++ b/doc/uk/org/ury/common/library/exceptions/package-summary.html @@ -0,0 +1,158 @@ + + + + + + +uk.org.ury.common.library.exceptions + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.common.library.exceptions +

    + + + + + + + + + +
    +Exception Summary
    EmptySearchExceptionException thrown when a library search is initiated + in which the query string is null.
    +  + +

    +

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

    +Hierarchy For Package uk.org.ury.common.library.exceptions +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    +
      +
    • java.lang.Object
        +
      • java.lang.Throwable (implements java.io.Serializable) + +
      +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/common/library/exceptions/package-use.html b/doc/uk/org/ury/common/library/exceptions/package-use.html new file mode 100644 index 0000000..3aa0c73 --- /dev/null +++ b/doc/uk/org/ury/common/library/exceptions/package-use.html @@ -0,0 +1,191 @@ + + + + + + +Uses of Package uk.org.ury.common.library.exceptions + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    uk.org.ury.common.library.exceptions

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

    + + + + + + + + +
    +Classes in uk.org.ury.common.library.exceptions used by uk.org.ury.common.library
    EmptySearchException + +
    +          Exception thrown when a library search is initiated + in which the query string is null.
    +  +

    + + + + + + + + +
    +Classes in uk.org.ury.common.library.exceptions used by uk.org.ury.frontend.modules.library
    EmptySearchException + +
    +          Exception thrown when a library search is initiated + in which the query string is null.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/common/library/item/LibraryItem.html b/doc/uk/org/ury/common/library/item/LibraryItem.html new file mode 100644 index 0000000..e2ea863 --- /dev/null +++ b/doc/uk/org/ury/common/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.common.library.item +
    +Class LibraryItem

    +
    +java.lang.Object
+  extended by uk.org.ury.backend.database.DatabaseItem<LibraryItemProperty,java.lang.String>
+      extended by uk.org.ury.common.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.backend.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/common/library/item/LibraryItemProperty.html b/doc/uk/org/ury/common/library/item/LibraryItemProperty.html new file mode 100644 index 0000000..0ea633a --- /dev/null +++ b/doc/uk/org/ury/common/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.common.library.item +
    +Enum LibraryItemProperty

    +
    +java.lang.Object
+  extended by java.lang.Enum<LibraryItemProperty>
+      extended by uk.org.ury.common.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/common/library/item/class-use/LibraryItem.html b/doc/uk/org/ury/common/library/item/class-use/LibraryItem.html new file mode 100644 index 0000000..cb099ec --- /dev/null +++ b/doc/uk/org/ury/common/library/item/class-use/LibraryItem.html @@ -0,0 +1,224 @@ + + + + + + +Uses of Class uk.org.ury.common.library.item.LibraryItem + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

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

    + + + + + + + + + +
    Methods in uk.org.ury.common.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.frontend.modules.library
    +  +

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

    + + + + + + + + +
    Constructor parameters in uk.org.ury.frontend.modules.library 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/common/library/item/class-use/LibraryItemProperty.html b/doc/uk/org/ury/common/library/item/class-use/LibraryItemProperty.html new file mode 100644 index 0000000..4316501 --- /dev/null +++ b/doc/uk/org/ury/common/library/item/class-use/LibraryItemProperty.html @@ -0,0 +1,211 @@ + + + + + + +Uses of Class uk.org.ury.common.library.item.LibraryItemProperty + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

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

    + + + + + + + + + + + + + + + + + +
    Methods in uk.org.ury.common.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.common.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/common/library/item/package-frame.html b/doc/uk/org/ury/common/library/item/package-frame.html new file mode 100644 index 0000000..4a18c26 --- /dev/null +++ b/doc/uk/org/ury/common/library/item/package-frame.html @@ -0,0 +1,43 @@ + + + + + + +uk.org.ury.common.library.item + + + + + + + + + + + +uk.org.ury.common.library.item + + + + +
    +Classes  + +
    +LibraryItem
    + + + + + + +
    +Enums  + +
    +LibraryItemProperty
    + + + + diff --git a/doc/uk/org/ury/common/library/item/package-summary.html b/doc/uk/org/ury/common/library/item/package-summary.html new file mode 100644 index 0000000..961ab27 --- /dev/null +++ b/doc/uk/org/ury/common/library/item/package-summary.html @@ -0,0 +1,171 @@ + + + + + + +uk.org.ury.common.library.item + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.common.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/common/library/item/package-tree.html b/doc/uk/org/ury/common/library/item/package-tree.html new file mode 100644 index 0000000..0358985 --- /dev/null +++ b/doc/uk/org/ury/common/library/item/package-tree.html @@ -0,0 +1,165 @@ + + + + + + +uk.org.ury.common.library.item Class Hierarchy + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

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

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

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

    + + + + + + + + +
    +Classes in uk.org.ury.common.library.item used by uk.org.ury.frontend.modules.library
    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/common/library/package-frame.html b/doc/uk/org/ury/common/library/package-frame.html new file mode 100644 index 0000000..dab4935 --- /dev/null +++ b/doc/uk/org/ury/common/library/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +uk.org.ury.common.library + + + + + + + + + + + +uk.org.ury.common.library + + + + +
    +Classes  + +
    +LibraryUtils
    + + + + diff --git a/doc/uk/org/ury/common/library/package-summary.html b/doc/uk/org/ury/common/library/package-summary.html new file mode 100644 index 0000000..4df5c5b --- /dev/null +++ b/doc/uk/org/ury/common/library/package-summary.html @@ -0,0 +1,158 @@ + + + + + + +uk.org.ury.common.library + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.common.library +

    + + + + + + + + + +
    +Class Summary
    LibraryUtilsA set of common utility routines to facilitate the extraction of + library items from the library areas of the URY database.
    +  + +

    +

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

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

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

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

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

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/common/protocol/Directive.html b/doc/uk/org/ury/common/protocol/Directive.html new file mode 100644 index 0000000..7ec7a46 --- /dev/null +++ b/doc/uk/org/ury/common/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.common.protocol +
    +Enum Directive

    +
    +java.lang.Object
+  extended by java.lang.Enum<Directive>
+      extended by uk.org.ury.common.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/common/protocol/ProtocolUtils.html b/doc/uk/org/ury/common/protocol/ProtocolUtils.html new file mode 100644 index 0000000..4eec6b3 --- /dev/null +++ b/doc/uk/org/ury/common/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.common.protocol +
    +Class ProtocolUtils

    +
    +java.lang.Object
+  extended by uk.org.ury.common.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/common/protocol/Status.html b/doc/uk/org/ury/common/protocol/Status.html new file mode 100644 index 0000000..8ec2dc4 --- /dev/null +++ b/doc/uk/org/ury/common/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.common.protocol +
    +Enum Status

    +
    +java.lang.Object
+  extended by java.lang.Enum<Status>
+      extended by uk.org.ury.common.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/common/protocol/class-use/Directive.html b/doc/uk/org/ury/common/protocol/class-use/Directive.html new file mode 100644 index 0000000..74dabe8 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/class-use/Directive.html @@ -0,0 +1,189 @@ + + + + + + +Uses of Class uk.org.ury.common.protocol.Directive + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

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

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

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

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

    +

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

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

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

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

    + + + + + + + + + + + + + +
    Methods in uk.org.ury.common.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/common/protocol/exceptions/DecodeFailureException.html b/doc/uk/org/ury/common/protocol/exceptions/DecodeFailureException.html new file mode 100644 index 0000000..cc41139 --- /dev/null +++ b/doc/uk/org/ury/common/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.common.protocol.exceptions +
    +Class DecodeFailureException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.common.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/common/protocol/exceptions/InvalidMessageException.html b/doc/uk/org/ury/common/protocol/exceptions/InvalidMessageException.html new file mode 100644 index 0000000..5c4ebca --- /dev/null +++ b/doc/uk/org/ury/common/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.common.protocol.exceptions +
    +Class InvalidMessageException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.common.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/common/protocol/exceptions/class-use/DecodeFailureException.html b/doc/uk/org/ury/common/protocol/exceptions/class-use/DecodeFailureException.html new file mode 100644 index 0000000..ed7efdd --- /dev/null +++ b/doc/uk/org/ury/common/protocol/exceptions/class-use/DecodeFailureException.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Class uk.org.ury.common.protocol.exceptions.DecodeFailureException + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

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

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

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

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

    +

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

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

    +
    + + + + + + + + + + + + + +
    +Packages that use InvalidMessageException
    uk.org.ury.common.protocol  
    uk.org.ury.frontend.modules.library  
    +  +

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

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

    + + + + + +
    +Uses of InvalidMessageException in uk.org.ury.frontend.modules.library
    +  +

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

    +

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

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

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

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

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

    +
    + + + + + + + + + + + + + + + + + +
    +Packages that use uk.org.ury.common.protocol.exceptions
    uk.org.ury.common.protocol  
    uk.org.ury.frontend.client  
    uk.org.ury.frontend.modules.library  
    +  +

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

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

    + + + + + + + + +
    +Classes in uk.org.ury.common.protocol.exceptions used by uk.org.ury.frontend.modules.library
    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/common/protocol/package-frame.html b/doc/uk/org/ury/common/protocol/package-frame.html new file mode 100644 index 0000000..8ea297f --- /dev/null +++ b/doc/uk/org/ury/common/protocol/package-frame.html @@ -0,0 +1,45 @@ + + + + + + +uk.org.ury.common.protocol + + + + + + + + + + + +uk.org.ury.common.protocol + + + + +
    +Classes  + +
    +ProtocolUtils
    + + + + + + +
    +Enums  + +
    +Directive +
    +Status
    + + + + diff --git a/doc/uk/org/ury/common/protocol/package-summary.html b/doc/uk/org/ury/common/protocol/package-summary.html new file mode 100644 index 0000000..e53976c --- /dev/null +++ b/doc/uk/org/ury/common/protocol/package-summary.html @@ -0,0 +1,176 @@ + + + + + + +uk.org.ury.common.protocol + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

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

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

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

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

    + + + + + + + + + + + +
    +Classes in uk.org.ury.common.protocol used by uk.org.ury.common.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/common/show/ShowChannel.html b/doc/uk/org/ury/common/show/ShowChannel.html new file mode 100644 index 0000000..c6a912e --- /dev/null +++ b/doc/uk/org/ury/common/show/ShowChannel.html @@ -0,0 +1,369 @@ + + + + + + +ShowChannel + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.common.show +
    +Class ShowChannel

    +
    +java.lang.Object
+  extended by javax.swing.AbstractListModel
+      extended by uk.org.ury.common.show.ShowChannel
+
    +
    +
    All Implemented Interfaces:
    java.io.Serializable, javax.swing.ListModel
    +
    +
    +
    +
    public class ShowChannel
    extends javax.swing.AbstractListModel
    + + +

    +A channel of ShowItems in a show. +

    + +

    +

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

    + + + + + + + + + + + +
    +Constructor Summary
    ShowChannel() + +
    +          Constructs a new, empty channel.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(int index, + ShowItem item) + +
    +          Adds a new item to the channel.
    + voidadd(ShowItem item) + +
    +          Adds a new item to the end of the channel.
    + ShowItemget(int index) + +
    +          Retrieves an item from the channel.
    + java.lang.ObjectgetElementAt(int index) + +
    +          List model retrieval wrapper for get.
    + intgetSize() + +
    +           
    +  + + + + + + + +
    Methods inherited from class javax.swing.AbstractListModel
    addListDataListener, getListDataListeners, getListeners, removeListDataListener
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +ShowChannel

    +
    +public ShowChannel()
    +
    +
    Constructs a new, empty channel. +

    +

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

    +add

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

    +

    +
    Parameters:
    index - The position at which to add the item.
    item - The new item to add. +
    Throws: +
    java.lang.IllegalArgumentException - if the item is null, the index is negative or the index is + out of bounds.
    +
    +
    +
    + +

    +add

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

    +

    +
    Parameters:
    item - The new item to add.
    +
    +
    +
    + +

    +get

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

    +

    +
    Parameters:
    index - The index of the item to retrieve from the channel. +
    Returns:
    the item at the given index in the list. +
    Throws: +
    java.lang.IllegalArgumentException - if the index is negative or overflowing.
    +
    +
    +
    + +

    +getElementAt

    +
    +public java.lang.Object getElementAt(int index)
    +
    +
    List model retrieval wrapper for get. +

    +

    +
    Parameters:
    index - The index of the item to retrieve from the channel. +
    Returns:
    the item at the given index in the list.
    +
    +
    +
    + +

    +getSize

    +
    +public int getSize()
    +
    +
    + +
    Returns:
    the size of the list.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/common/show/ShowUtils.html b/doc/uk/org/ury/common/show/ShowUtils.html new file mode 100644 index 0000000..71d01a6 --- /dev/null +++ b/doc/uk/org/ury/common/show/ShowUtils.html @@ -0,0 +1,345 @@ + + + + + + +ShowUtils + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.common.show +
    +Class ShowUtils

    +
    +java.lang.Object
+  extended by uk.org.ury.common.show.ShowUtils
+
    +
    +
    +
    public class ShowUtils
    extends java.lang.Object
    + + +

    +A set of common utility routines to facilitate the extraction of show items + from the show storage areas of the URY database. +

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +static intNUM_CHANNELS + +
    +          The number of channels reserved for show items.
    +  + + + + + + + + + + +
    +Constructor Summary
    ShowUtils() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    +static java.util.List<ShowItem>getChannelList(DatabaseDriver db, + int showID, + int channel) + +
    +          Given a show and a channel, retrieve a list of all show items bound to + that channel for the show.
    +static java.util.List<java.lang.String>getPublicFolders(DatabaseDriver db) + +
    +          Return the names of the public track folders, or "bins".
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +NUM_CHANNELS

    +
    +public static final int NUM_CHANNELS
    +
    +
    The number of channels reserved for show items. + + TODO: move this somewhere more appropriate. +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +ShowUtils

    +
    +public ShowUtils()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getPublicFolders

    +
    +public static java.util.List<java.lang.String> getPublicFolders(DatabaseDriver db)
+                                                         throws QueryFailureException
    +
    +
    Return the names of the public track folders, or "bins". +

    +

    +
    Parameters:
    db - The database to query. +
    Returns:
    a list of the public folder names. The list may be empty. +
    Throws: +
    java.lang.IllegalArgumentException - if the database is null, the show ID is negative or the + channel index falls out of bounds. +
    QueryFailureException - if the database backend yielded an error while executing the + search query.
    +
    +
    +
    + +

    +getChannelList

    +
    +public static java.util.List<ShowItem> getChannelList(DatabaseDriver db,
+                                                      int showID,
+                                                      int channel)
+                                               throws QueryFailureException
    +
    +
    Given a show and a channel, retrieve a list of all show items bound to + that channel for the show. +

    +

    +
    Parameters:
    db - The database to query.
    showID - The unique number that identifies the show.
    channel - The index of the channel to query. +
    Returns:
    a list of ShowItems extracted from the show and channel. The list + may be empty. +
    Throws: +
    java.lang.IllegalArgumentException - if the database is null, the show ID is negative or the + channel index falls out of bounds. +
    QueryFailureException - if the database backend yielded an error while executing the + search query.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/common/show/class-use/ShowChannel.html b/doc/uk/org/ury/common/show/class-use/ShowChannel.html new file mode 100644 index 0000000..cc21645 --- /dev/null +++ b/doc/uk/org/ury/common/show/class-use/ShowChannel.html @@ -0,0 +1,195 @@ + + + + + + +Uses of Class uk.org.ury.common.show.ShowChannel + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.common.show.ShowChannel

    +
    + + + + + + + + + +
    +Packages that use ShowChannel
    uk.org.ury.frontend.modules.show  
    +  +

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

    + + + + + + + + + +
    Methods in uk.org.ury.frontend.modules.show that return ShowChannel
    + ShowChannel[]ShowViewer.getChannels() + +
    +           
    +  +

    + + + + + + + + +
    Constructors in uk.org.ury.frontend.modules.show with parameters of type ShowChannel
    ChannelPanel(int number, + ShowChannel channel) + +
    +          Construct a new ChannelPanel.
    +  +

    +

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

    +Uses of Class
    uk.org.ury.common.show.ShowUtils

    +
    +No usage of uk.org.ury.common.show.ShowUtils +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/common/show/item/ShowItem.html b/doc/uk/org/ury/common/show/item/ShowItem.html new file mode 100644 index 0000000..bef6df2 --- /dev/null +++ b/doc/uk/org/ury/common/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.common.show.item +
    +Class ShowItem

    +
    +java.lang.Object
+  extended by uk.org.ury.backend.database.DatabaseItem<ShowItemProperty,java.lang.String>
+      extended by uk.org.ury.common.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.backend.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/common/show/item/ShowItemProperty.html b/doc/uk/org/ury/common/show/item/ShowItemProperty.html new file mode 100644 index 0000000..71e9a86 --- /dev/null +++ b/doc/uk/org/ury/common/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.common.show.item +
    +Enum ShowItemProperty

    +
    +java.lang.Object
+  extended by java.lang.Enum<ShowItemProperty>
+      extended by uk.org.ury.common.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/common/show/item/class-use/ShowItem.html b/doc/uk/org/ury/common/show/item/class-use/ShowItem.html new file mode 100644 index 0000000..24e0fc9 --- /dev/null +++ b/doc/uk/org/ury/common/show/item/class-use/ShowItem.html @@ -0,0 +1,224 @@ + + + + + + +Uses of Class uk.org.ury.common.show.item.ShowItem + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

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

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

    + + + + + + + + + +
    Methods in uk.org.ury.common.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.common.show with parameters of type ShowItem
    + voidShowChannel.add(int index, + ShowItem item) + +
    +          Adds a new item to the channel.
    + voidShowChannel.add(ShowItem item) + +
    +          Adds 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/common/show/item/class-use/ShowItemProperty.html b/doc/uk/org/ury/common/show/item/class-use/ShowItemProperty.html new file mode 100644 index 0000000..f79276f --- /dev/null +++ b/doc/uk/org/ury/common/show/item/class-use/ShowItemProperty.html @@ -0,0 +1,203 @@ + + + + + + +Uses of Class uk.org.ury.common.show.item.ShowItemProperty + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

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

    + + + + + + + + + + + + + +
    Methods in uk.org.ury.common.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.common.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/common/show/item/package-frame.html b/doc/uk/org/ury/common/show/item/package-frame.html new file mode 100644 index 0000000..912c449 --- /dev/null +++ b/doc/uk/org/ury/common/show/item/package-frame.html @@ -0,0 +1,43 @@ + + + + + + +uk.org.ury.common.show.item + + + + + + + + + + + +uk.org.ury.common.show.item + + + + +
    +Classes  + +
    +ShowItem
    + + + + + + +
    +Enums  + +
    +ShowItemProperty
    + + + + diff --git a/doc/uk/org/ury/common/show/item/package-summary.html b/doc/uk/org/ury/common/show/item/package-summary.html new file mode 100644 index 0000000..db91ab1 --- /dev/null +++ b/doc/uk/org/ury/common/show/item/package-summary.html @@ -0,0 +1,189 @@ + + + + + + +uk.org.ury.common.show.item + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

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

    +The show item class and related properties. +

    +See: +
    +          Description +

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

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

    +

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

    + +

    +

    The show item class and related properties.

    +

    The two contained classes, ShowItem and ShowItemProperty, + implement the storage of items (songs, audio tracks, etc) that + can be placed in show channels.

    +

    + +

    +

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

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

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    +
      +
    • java.lang.Object +
    +

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

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

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

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

    + + + + + + + + +
    +Classes in uk.org.ury.common.show.item used by uk.org.ury.common.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/common/show/package-frame.html b/doc/uk/org/ury/common/show/package-frame.html new file mode 100644 index 0000000..752f0b5 --- /dev/null +++ b/doc/uk/org/ury/common/show/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +uk.org.ury.common.show + + + + + + + + + + + +uk.org.ury.common.show + + + + +
    +Classes  + +
    +ShowChannel +
    +ShowUtils
    + + + + diff --git a/doc/uk/org/ury/common/show/package-summary.html b/doc/uk/org/ury/common/show/package-summary.html new file mode 100644 index 0000000..72d30bd --- /dev/null +++ b/doc/uk/org/ury/common/show/package-summary.html @@ -0,0 +1,162 @@ + + + + + + +uk.org.ury.common.show + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.common.show +

    + + + + + + + + + + + + + +
    +Class Summary
    ShowChannelA channel of ShowItems in a show.
    ShowUtilsA set of common utility routines to facilitate the extraction of show items + from the show storage areas of the URY database.
    +  + +

    +

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

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

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    +
      +
    • java.lang.Object
        +
      • javax.swing.AbstractListModel (implements javax.swing.ListModel, java.io.Serializable) + +
      • uk.org.ury.common.show.ShowUtils
      +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/common/show/package-use.html b/doc/uk/org/ury/common/show/package-use.html new file mode 100644 index 0000000..696b273 --- /dev/null +++ b/doc/uk/org/ury/common/show/package-use.html @@ -0,0 +1,170 @@ + + + + + + +Uses of Package uk.org.ury.common.show + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

    + + + + + + + + +
    +Classes in uk.org.ury.common.show used by uk.org.ury.frontend.modules.show
    ShowChannel + +
    +          A channel of ShowItems in a show.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/AbstractFrontendModule.html b/doc/uk/org/ury/frontend/AbstractFrontendModule.html index 0eea2a6..a639028 100644 --- a/doc/uk/org/ury/frontend/AbstractFrontendModule.html +++ b/doc/uk/org/ury/frontend/AbstractFrontendModule.html @@ -2,7 +2,7 @@ - + AbstractFrontendModule @@ -99,7 +99,7 @@ java.lang.Object
    All Implemented Interfaces:
    FrontendModule
    -
    Direct Known Subclasses:
    DemoMenu, LibraryViewer, ShowViewer
    +
    Direct Known Subclasses:
    DemoMenu, LibraryViewer, ShowViewer
    diff --git a/doc/uk/org/ury/frontend/FrontendApplet.html b/doc/uk/org/ury/frontend/FrontendApplet.html index 757e506..1a131b0 100644 --- a/doc/uk/org/ury/frontend/FrontendApplet.html +++ b/doc/uk/org/ury/frontend/FrontendApplet.html @@ -2,7 +2,7 @@ - + FrontendApplet @@ -101,11 +101,11 @@ java.lang.Object 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
    +
    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
    +
    public class FrontendApplet
    extends javax.swing.JApplet
    implements FrontendMaster, Launcher

    @@ -158,13 +158,13 @@ A frame that hosts a FrontendModulePanel, used for serving frontend panels in

    		BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
    -  +  - + - +
    Fields inherited from interface uk.org.ury.testrig.LauncherFields inherited from interface uk.org.ury.frontend.testrig.Launcher
    DEFAULT_MODULE_NAMEDEFAULT_MODULE_NAME
      diff --git a/doc/uk/org/ury/frontend/FrontendBanner.html b/doc/uk/org/ury/frontend/FrontendBanner.html index 4d015e1..9d129db 100644 --- a/doc/uk/org/ury/frontend/FrontendBanner.html +++ b/doc/uk/org/ury/frontend/FrontendBanner.html @@ -2,7 +2,7 @@ - + FrontendBanner diff --git a/doc/uk/org/ury/frontend/FrontendControlPanel.html b/doc/uk/org/ury/frontend/FrontendControlPanel.html index fd5d1c3..357b4a7 100644 --- a/doc/uk/org/ury/frontend/FrontendControlPanel.html +++ b/doc/uk/org/ury/frontend/FrontendControlPanel.html @@ -2,7 +2,7 @@ - + FrontendControlPanel @@ -104,7 +104,7 @@ java.lang.Object
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    -
    Direct Known Subclasses:
    DemoControlPanel, LibraryControlPanel
    +
    Direct Known Subclasses:
    DemoControlPanel, LibraryControlPanel
    diff --git a/doc/uk/org/ury/frontend/FrontendError.html b/doc/uk/org/ury/frontend/FrontendError.html index 741ddab..7948526 100644 --- a/doc/uk/org/ury/frontend/FrontendError.html +++ b/doc/uk/org/ury/frontend/FrontendError.html @@ -2,7 +2,7 @@ - + FrontendError diff --git a/doc/uk/org/ury/frontend/FrontendFrame.html b/doc/uk/org/ury/frontend/FrontendFrame.html index 8f2f727..7b45c1a 100644 --- a/doc/uk/org/ury/frontend/FrontendFrame.html +++ b/doc/uk/org/ury/frontend/FrontendFrame.html @@ -2,7 +2,7 @@ - + FrontendFrame @@ -109,8 +109,8 @@ java.lang.Object

    -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).

    @@ -250,8 +250,8 @@ A frame that hosts a FrontendModulePanel, used for serving frontend java.lang.String cPanelName)
    -          Load a module into the frontend frame, additionally installing - a control panel to communicate with the previous module. +          Load a module into the frontend frame, additionally installing a control + panel to communicate with the previous module. @@ -260,8 +260,7 @@ A frame that hosts a FrontendModulePanel, used for serving frontend FrontendControlPanel cpanel)
    -          Restore an existing module and control panel into the frontend - frame. +          Restore an existing module and control panel into the frontend frame. @@ -355,12 +354,12 @@ 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. + 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.
    +
    Parameters:
    moduleName - The fully qualified class-name of the module, minus the + leading "uk.org.ury." domain.
    @@ -397,19 +396,18 @@ public void loadModule(java.lang.String moduleName)
    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. + 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. +
    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.
    +
    LoadFailureException - if the class is not found, or is not an implementor of + FrontendModule.
    • @@ -421,24 +419,22 @@ 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. +
    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. + 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. +
    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.
    +
    LoadFailureException - if the class is not found, or is not an implementor of + FrontendModule.
    @@ -449,15 +445,14 @@ restoreModule public void 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.

    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. +
    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.
    @@ -475,8 +470,7 @@ public void fatalError(java.lang.String message)
    Specified by:
    fatalError in interface FrontendMaster
    -
    Parameters:
    message - The message, eg the exception message, to report - to the user.
    +
    Parameters:
    message - The message, eg the exception message, to report to the user.
    diff --git a/doc/uk/org/ury/frontend/FrontendMaster.html b/doc/uk/org/ury/frontend/FrontendMaster.html index 4045ace..5660bca 100644 --- a/doc/uk/org/ury/frontend/FrontendMaster.html +++ b/doc/uk/org/ury/frontend/FrontendMaster.html @@ -2,7 +2,7 @@ - + FrontendMaster diff --git a/doc/uk/org/ury/frontend/FrontendModule.html b/doc/uk/org/ury/frontend/FrontendModule.html index f5acde2..761de60 100644 --- a/doc/uk/org/ury/frontend/FrontendModule.html +++ b/doc/uk/org/ury/frontend/FrontendModule.html @@ -2,7 +2,7 @@ - + FrontendModule @@ -92,7 +92,7 @@ uk.org.ury.frontend
    Interface FrontendModule
    -
    All Known Implementing Classes:
    AbstractFrontendModule, DemoMenu, LibraryViewer, ShowViewer
    +
    All Known Implementing Classes:
    AbstractFrontendModule, DemoMenu, LibraryViewer, ShowViewer
    @@ -100,22 +100,20 @@ Interface FrontendModule

    -Interface for all system modules that are to be reachable from - the frontend array. +Interface for all system modules that are to be reachable from the frontend + array. Frontend-exposed modules must: - be runnable standalone, as either an application or an applet; - - contain their user interface in a subclass of FrontendModulePanel - which can be embedded either in a FrontendFrame, a web page - or another module; - + - contain their user interface in a subclass of FrontendModulePanel which can + be embedded either in a FrontendFrame, a web page or another module; + - use the frontend error reporting systems. - An abstract implementation of this interface, - AbstractFrontendModule, is provided to simplify the creation of - frontend modules. + An abstract implementation of this interface, AbstractFrontendModule, is + provided to simplify the creation of frontend modules.

    @@ -166,8 +164,7 @@ runFrontend

    Parameters:
    master - The FrontendMaster driving the frontend. -
    Returns:
    the frontend panel to insert into the - FrontendMaster.
    +
    Returns:
    the frontend panel to insert into the FrontendMaster.
    diff --git a/doc/uk/org/ury/frontend/FrontendModulePanel.html b/doc/uk/org/ury/frontend/FrontendModulePanel.html index b6c91e4..0cf7d5e 100644 --- a/doc/uk/org/ury/frontend/FrontendModulePanel.html +++ b/doc/uk/org/ury/frontend/FrontendModulePanel.html @@ -2,7 +2,7 @@ - + FrontendModulePanel @@ -104,7 +104,7 @@ java.lang.Object
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    -
    Direct Known Subclasses:
    DemoMenuPanel, LibraryViewerPanel, ShowViewerPanel
    +
    Direct Known Subclasses:
    DemoMenuPanel, LibraryViewerPanel, ShowViewerPanel
    diff --git a/doc/uk/org/ury/frontend/FrontendPanel.html b/doc/uk/org/ury/frontend/FrontendPanel.html index 25a85ca..6b7e0d4 100644 --- a/doc/uk/org/ury/frontend/FrontendPanel.html +++ b/doc/uk/org/ury/frontend/FrontendPanel.html @@ -2,7 +2,7 @@ - + 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:
    ChannelPanel, FrontendControlPanel, FrontendModulePanel, TrackBin
    +
    Direct Known Subclasses:
    ChannelPanel, FrontendControlPanel, FrontendModulePanel, TrackBin
    diff --git a/doc/uk/org/ury/frontend/FrontendSubBanner.html b/doc/uk/org/ury/frontend/FrontendSubBanner.html index ed98791..1f8673d 100644 --- a/doc/uk/org/ury/frontend/FrontendSubBanner.html +++ b/doc/uk/org/ury/frontend/FrontendSubBanner.html @@ -2,7 +2,7 @@ - + FrontendSubBanner diff --git a/doc/uk/org/ury/frontend/HintField.html b/doc/uk/org/ury/frontend/HintField.html index ffe7760..880ce9a 100644 --- a/doc/uk/org/ury/frontend/HintField.html +++ b/doc/uk/org/ury/frontend/HintField.html @@ -2,7 +2,7 @@ - + HintField diff --git a/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html b/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html index 9606536..131d70c 100644 --- a/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html +++ b/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html @@ -2,7 +2,7 @@ - + Uses of Class uk.org.ury.frontend.AbstractFrontendModule @@ -90,25 +90,25 @@ function windowTitle() Packages that use AbstractFrontendModule -uk.org.ury.library.viewer +uk.org.ury.frontend.modules.library    -uk.org.ury.show.viewer +uk.org.ury.frontend.modules.menu    -uk.org.ury.testrig +uk.org.ury.frontend.modules.show     

    - + +Uses of AbstractFrontendModule in uk.org.ury.frontend.modules.library
    -Uses of AbstractFrontendModule in uk.org.ury.library.viewer
      @@ -116,12 +116,12 @@ Uses of -Subclasses of AbstractFrontendModule in uk.org.ury.library.viewer +Subclasses of AbstractFrontendModule in uk.org.ury.frontend.modules.library  class -LibraryViewer +LibraryViewer
              Module for investigating the track library. @@ -129,11 +129,11 @@ Uses of  

    - + +Uses of AbstractFrontendModule in uk.org.ury.frontend.modules.menu
    -Uses of AbstractFrontendModule in uk.org.ury.show.viewer
      @@ -141,24 +141,24 @@ Uses of -Subclasses of AbstractFrontendModule in uk.org.ury.show.viewer +Subclasses of AbstractFrontendModule in uk.org.ury.frontend.modules.menu  class -ShowViewer +DemoMenu
    -          Frontend module for viewing show details. +          Application frontend, for testing early-stage frontend code.  

    - + +Uses of AbstractFrontendModule in uk.org.ury.frontend.modules.show
    -Uses of AbstractFrontendModule in uk.org.ury.testrig
      @@ -166,15 +166,15 @@ Uses of -Subclasses of AbstractFrontendModule in uk.org.ury.testrig +Subclasses of AbstractFrontendModule in uk.org.ury.frontend.modules.show  class -DemoMenu +ShowViewer
    -          Application frontend, for testing early-stage frontend code. +          Frontend module for viewing show details.   diff --git a/doc/uk/org/ury/frontend/class-use/FrontendApplet.html b/doc/uk/org/ury/frontend/class-use/FrontendApplet.html index 275c9ec..952267f 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendApplet.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendApplet.html @@ -2,7 +2,7 @@ - + Uses of Class uk.org.ury.frontend.FrontendApplet diff --git a/doc/uk/org/ury/frontend/class-use/FrontendBanner.html b/doc/uk/org/ury/frontend/class-use/FrontendBanner.html index 01d308f..75261ee 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendBanner.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendBanner.html @@ -2,7 +2,7 @@ - + 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 b870f01..f1e610e 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendControlPanel.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendControlPanel.html @@ -2,7 +2,7 @@ - + Uses of Class uk.org.ury.frontend.FrontendControlPanel @@ -94,11 +94,11 @@ Packages that use -uk.org.ury.show.viewer +uk.org.ury.frontend.cpanels.menu    -uk.org.ury.testrig +uk.org.ury.frontend.cpanels.show    @@ -134,8 +134,7 @@ Uses of FrontendControlPanel cpanel)
    -          Restore an existing module and control panel into the frontend - frame. +          Restore an existing module and control panel into the frontend frame. @@ -160,11 +159,11 @@ Uses of  

    - + +Uses of FrontendControlPanel in uk.org.ury.frontend.cpanels.menu
    -Uses of FrontendControlPanel in uk.org.ury.show.viewer
      @@ -172,12 +171,12 @@ Uses of -Subclasses of FrontendControlPanel in uk.org.ury.show.viewer     +Subclasses of FrontendControlPanel in uk.org.ury.frontend.cpanels.menu  class -LibraryControlPanel +DemoControlPanel
              Control panel for the demo system. @@ -185,11 +184,11 @@ Uses of  

    - + +Uses of FrontendControlPanel in uk.org.ury.frontend.cpanels.show
    -Uses of FrontendControlPanel in uk.org.ury.testrig
      @@ -197,12 +196,12 @@ Uses of -Subclasses of FrontendControlPanel in uk.org.ury.testrig +Subclasses of FrontendControlPanel in uk.org.ury.frontend.cpanels.show  class -DemoControlPanel +LibraryControlPanel
              Control panel for the demo system. diff --git a/doc/uk/org/ury/frontend/class-use/FrontendError.html b/doc/uk/org/ury/frontend/class-use/FrontendError.html index 3b23715..45d1709 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendError.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendError.html @@ -2,7 +2,7 @@ - + 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 f73cc31..1ff3540 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendFrame.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendFrame.html @@ -2,7 +2,7 @@ - + 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 ca79312..d15fefb 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendMaster.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendMaster.html @@ -2,7 +2,7 @@ - + Uses of Interface uk.org.ury.frontend.FrontendMaster @@ -94,15 +94,15 @@ Packages that use -uk.org.ury.library.viewer +uk.org.ury.frontend.modules.library    -uk.org.ury.show.viewer +uk.org.ury.frontend.modules.menu    -uk.org.ury.testrig +uk.org.ury.frontend.modules.show    @@ -137,8 +137,8 @@ Uses of FrontendFrame
    -          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).   @@ -203,11 +203,11 @@ Uses of + +Uses of FrontendMaster in uk.org.ury.frontend.modules.library
    -Uses of FrontendMaster in uk.org.ury.library.viewer
      @@ -215,12 +215,12 @@ Uses of -Methods in uk.org.ury.library.viewer with parameters of type FrontendMaster +Methods in uk.org.ury.frontend.modules.library with parameters of type FrontendMaster  FrontendModulePanel -LibraryViewer.runFrontend(FrontendMaster master) +LibraryViewer.runFrontend(FrontendMaster master)
              Runs the library viewer frontend. @@ -231,10 +231,10 @@ Uses of -Constructors in uk.org.ury.library.viewer with parameters of type FrontendMaster +Constructors in uk.org.ury.frontend.modules.library with parameters of type FrontendMaster -LibraryViewerPanel(LibraryViewer viewer, +LibraryViewerPanel(LibraryViewer viewer, FrontendMaster master)
    @@ -243,11 +243,11 @@ Uses of + +Uses of FrontendMaster in uk.org.ury.frontend.modules.menu
    -Uses of FrontendMaster in uk.org.ury.show.viewer
      @@ -255,15 +255,15 @@ Uses of -Methods in uk.org.ury.show.viewer with parameters of type FrontendMaster +Methods in uk.org.ury.frontend.modules.menu with parameters of type FrontendMaster  FrontendModulePanel -ShowViewer.runFrontend(FrontendMaster master) +DemoMenu.runFrontend(FrontendMaster master)
    -          Run the library viewer frontend. +          Run the demo menu in frontend mode.   @@ -271,23 +271,22 @@ Uses of -Constructors in uk.org.ury.show.viewer with parameters of type FrontendMaster +Constructors in uk.org.ury.frontend.modules.menu with parameters of type FrontendMaster -ShowViewerPanel(ShowViewer viewer, - FrontendMaster master) +DemoMenuPanel(FrontendMaster inMaster)
    -          Construct a new ShowViewerPanel. +          Construct a new DemoMenuPanel.  

    - + +Uses of FrontendMaster in uk.org.ury.frontend.modules.show
    -Uses of FrontendMaster in uk.org.ury.testrig
      @@ -295,15 +294,15 @@ Uses of -Methods in uk.org.ury.testrig with parameters of type FrontendMaster +Methods in uk.org.ury.frontend.modules.show with parameters of type FrontendMaster  FrontendModulePanel -DemoMenu.runFrontend(FrontendMaster master) +ShowViewer.runFrontend(FrontendMaster master)
    -          Run the demo menu in frontend mode. +          Run the library viewer frontend.   @@ -311,13 +310,14 @@ Uses of -Constructors in uk.org.ury.testrig with parameters of type FrontendMaster +Constructors in uk.org.ury.frontend.modules.show with parameters of type FrontendMaster -DemoMenuPanel(FrontendMaster inMaster) +ShowViewerPanel(ShowViewer viewer, + FrontendMaster master)
    -          Construct a new DemoMenuPanel. +          Construct a new ShowViewerPanel.   diff --git a/doc/uk/org/ury/frontend/class-use/FrontendModule.html b/doc/uk/org/ury/frontend/class-use/FrontendModule.html index edecafc..334c782 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendModule.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendModule.html @@ -2,7 +2,7 @@ - + Uses of Interface uk.org.ury.frontend.FrontendModule @@ -94,15 +94,15 @@ Packages that use -uk.org.ury.library.viewer +uk.org.ury.frontend.modules.library    -uk.org.ury.show.viewer +uk.org.ury.frontend.modules.menu    -uk.org.ury.testrig +uk.org.ury.frontend.modules.show    @@ -172,11 +172,11 @@ Uses of + +Uses of FrontendModule in uk.org.ury.frontend.modules.library
    -Uses of FrontendModule in uk.org.ury.library.viewer
      @@ -184,12 +184,12 @@ Uses of -Classes in uk.org.ury.library.viewer that implement FrontendModule +Classes in uk.org.ury.frontend.modules.library that implement FrontendModule  class -LibraryViewer +LibraryViewer
              Module for investigating the track library. @@ -197,11 +197,11 @@ Uses of + +Uses of FrontendModule in uk.org.ury.frontend.modules.menu
    -Uses of FrontendModule in uk.org.ury.show.viewer
      @@ -209,24 +209,24 @@ Uses of -Classes in uk.org.ury.show.viewer that implement FrontendModule +Classes in uk.org.ury.frontend.modules.menu that implement FrontendModule  class -ShowViewer +DemoMenu
    -          Frontend module for viewing show details. +          Application frontend, for testing early-stage frontend code.  

    - + +Uses of FrontendModule in uk.org.ury.frontend.modules.show
    -Uses of FrontendModule in uk.org.ury.testrig
      @@ -234,15 +234,15 @@ Uses of -Classes in uk.org.ury.testrig that implement FrontendModule +Classes in uk.org.ury.frontend.modules.show that implement FrontendModule  class -DemoMenu +ShowViewer
    -          Application frontend, for testing early-stage frontend code. +          Frontend module for viewing show details.   diff --git a/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html b/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html index 05972a9..5fa3376 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html @@ -2,7 +2,7 @@ - + Uses of Class uk.org.ury.frontend.FrontendModulePanel @@ -94,15 +94,15 @@ Packages that use -uk.org.ury.library.viewer +uk.org.ury.frontend.modules.library    -uk.org.ury.show.viewer +uk.org.ury.frontend.modules.menu    -uk.org.ury.testrig +uk.org.ury.frontend.modules.show    @@ -154,8 +154,7 @@ Uses of FrontendControlPanel cpanel)
    -          Restore an existing module and control panel into the frontend - frame. +          Restore an existing module and control panel into the frontend frame. @@ -180,11 +179,11 @@ Uses of  

    - + +Uses of FrontendModulePanel in uk.org.ury.frontend.modules.library
    -Uses of FrontendModulePanel in uk.org.ury.library.viewer
      @@ -192,12 +191,12 @@ Uses of -Subclasses of FrontendModulePanel in uk.org.ury.library.viewer     +Subclasses of FrontendModulePanel in uk.org.ury.frontend.modules.library  class -LibraryViewerPanel +LibraryViewerPanel
              Frontend panel providing access to an underlying library viewer. @@ -208,12 +207,12 @@ Uses of -Methods in uk.org.ury.library.viewer that return FrontendModulePanel +Methods in uk.org.ury.frontend.modules.library that return FrontendModulePanel  FrontendModulePanel -LibraryViewer.runFrontend(FrontendMaster master) +LibraryViewer.runFrontend(FrontendMaster master)
              Runs the library viewer frontend. @@ -221,11 +220,11 @@ Uses of  

    - + +Uses of FrontendModulePanel in uk.org.ury.frontend.modules.menu
    -Uses of FrontendModulePanel in uk.org.ury.show.viewer
      @@ -233,15 +232,15 @@ Uses of -Subclasses of FrontendModulePanel in uk.org.ury.show.viewer +Subclasses of FrontendModulePanel in uk.org.ury.frontend.modules.menu  class -ShowViewerPanel +DemoMenuPanel
    -          Frontend panel providing access to an underlying show viewer. +              @@ -249,24 +248,24 @@ Uses of -Methods in uk.org.ury.show.viewer that return FrontendModulePanel +Methods in uk.org.ury.frontend.modules.menu that return FrontendModulePanel  FrontendModulePanel -ShowViewer.runFrontend(FrontendMaster master) +DemoMenu.runFrontend(FrontendMaster master)
    -          Run the library viewer frontend. +          Run the demo menu in frontend mode.  

    - + +Uses of FrontendModulePanel in uk.org.ury.frontend.modules.show
    -Uses of FrontendModulePanel in uk.org.ury.testrig
      @@ -274,15 +273,15 @@ Uses of -Subclasses of FrontendModulePanel in uk.org.ury.testrig +Subclasses of FrontendModulePanel in uk.org.ury.frontend.modules.show  class -DemoMenuPanel +ShowViewerPanel
    -            +          Frontend panel providing access to an underlying show viewer.   @@ -290,15 +289,15 @@ Uses of -Methods in uk.org.ury.testrig that return FrontendModulePanel +Methods in uk.org.ury.frontend.modules.show that return FrontendModulePanel  FrontendModulePanel -DemoMenu.runFrontend(FrontendMaster master) +ShowViewer.runFrontend(FrontendMaster master)
    -          Run the demo menu in frontend mode. +          Run the library viewer frontend.   diff --git a/doc/uk/org/ury/frontend/class-use/FrontendPanel.html b/doc/uk/org/ury/frontend/class-use/FrontendPanel.html index 3ae79e6..f24b27b 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendPanel.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendPanel.html @@ -2,7 +2,7 @@ - + Uses of Class uk.org.ury.frontend.FrontendPanel @@ -94,15 +94,23 @@ Packages that use -uk.org.ury.library.viewer +uk.org.ury.frontend.cpanels.menu    -uk.org.ury.show.viewer +uk.org.ury.frontend.cpanels.show    -uk.org.ury.testrig +uk.org.ury.frontend.modules.library +   + + +uk.org.ury.frontend.modules.menu +   + + +uk.org.ury.frontend.modules.show    @@ -141,11 +149,11 @@ Uses of + +Uses of FrontendPanel in uk.org.ury.frontend.cpanels.menu
    -Uses of FrontendPanel in uk.org.ury.library.viewer
      @@ -153,24 +161,24 @@ Uses of -Subclasses of FrontendPanel in uk.org.ury.library.viewer +Subclasses of FrontendPanel in uk.org.ury.frontend.cpanels.menu  class -LibraryViewerPanel +DemoControlPanel
    -          Frontend panel providing access to an underlying library viewer. +          Control panel for the demo system.  

    - + +Uses of FrontendPanel in uk.org.ury.frontend.cpanels.show
    -Uses of FrontendPanel in uk.org.ury.show.viewer
      @@ -178,48 +186,74 @@ Uses of -Subclasses of FrontendPanel in uk.org.ury.show.viewer +Subclasses of FrontendPanel in uk.org.ury.frontend.cpanels.show  class -ChannelPanel +LibraryControlPanel
    -          A panel displaying channel information. +          Control panel for the demo system. - - - class -LibraryControlPanel + +  +

    + + + + + +
    +Uses of FrontendPanel in uk.org.ury.frontend.modules.library
    +  +

    -
    -          Control panel for the demo system. + + + - +          Frontend panel providing access to an underlying library viewer. + +
    Subclasses of FrontendPanel in uk.org.ury.frontend.modules.library
     classShowViewerPanel +LibraryViewerPanel
    -          Frontend panel providing access to an underlying show viewer.
    +  +

    + + + + + +
    +Uses of FrontendPanel in uk.org.ury.frontend.modules.menu
    +  +

    + + + + - +           
    Subclasses of FrontendPanel in uk.org.ury.frontend.modules.menu
     classTrackBin +DemoMenuPanel
    -          A panel displaying track bin contents.
     

    - + +Uses of FrontendPanel in uk.org.ury.frontend.modules.show
    -Uses of FrontendPanel in uk.org.ury.testrig
      @@ -227,23 +261,31 @@ Uses of -Subclasses of FrontendPanel in uk.org.ury.testrig +Subclasses of FrontendPanel in uk.org.ury.frontend.modules.show  class -DemoControlPanel +ChannelPanel
    -          Control panel for the demo system. +          A panel displaying channel information.  class -DemoMenuPanel +ShowViewerPanel
    -            +          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 8bcae14..8fb5bdc 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html @@ -2,7 +2,7 @@ - + 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 e830fd0..5225f05 100644 --- a/doc/uk/org/ury/frontend/class-use/HintField.html +++ b/doc/uk/org/ury/frontend/class-use/HintField.html @@ -2,7 +2,7 @@ - + Uses of Class uk.org.ury.frontend.HintField diff --git a/doc/uk/org/ury/frontend/client/Client.html b/doc/uk/org/ury/frontend/client/Client.html new file mode 100644 index 0000000..870ab92 --- /dev/null +++ b/doc/uk/org/ury/frontend/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.frontend.client +
    +Class Client

    +
    +java.lang.Object
+  extended by uk.org.ury.frontend.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/frontend/client/class-use/Client.html b/doc/uk/org/ury/frontend/client/class-use/Client.html new file mode 100644 index 0000000..ab39a6e --- /dev/null +++ b/doc/uk/org/ury/frontend/client/class-use/Client.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.client.Client + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

    +

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

    +Package uk.org.ury.frontend.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/frontend/client/package-tree.html b/doc/uk/org/ury/frontend/client/package-tree.html new file mode 100644 index 0000000..e3c5540 --- /dev/null +++ b/doc/uk/org/ury/frontend/client/package-tree.html @@ -0,0 +1,153 @@ + + + + + + +uk.org.ury.frontend.client Class Hierarchy + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

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

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

    +

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

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

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

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

    +

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

    +Package uk.org.ury.frontend.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/frontend/client/test/package-tree.html b/doc/uk/org/ury/frontend/client/test/package-tree.html new file mode 100644 index 0000000..b8296c1 --- /dev/null +++ b/doc/uk/org/ury/frontend/client/test/package-tree.html @@ -0,0 +1,153 @@ + + + + + + +uk.org.ury.frontend.client.test Class Hierarchy + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

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

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

    +

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

    +
    +java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.FrontendControlPanel
+                          extended by uk.org.ury.frontend.cpanels.menu.DemoControlPanel
+
    +
    +
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    +
    +
    +
    +
    public class DemoControlPanel
    extends FrontendControlPanel
    + + +

    +Control panel for the demo system. +

    + +

    +

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

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class javax.swing.JComponent
    javax.swing.JComponent.AccessibleJComponent
    +  + + + + + + + + +
    Nested classes/interfaces inherited from class java.awt.Component
    java.awt.Component.BaselineResizeBehavior
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class javax.swing.JComponent
    TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
    +  + + + + + + + +
    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
    +  + + + + + + + + + + +
    +Constructor Summary
    DemoControlPanel() + +
    +          Constructs a new DemoControlPanel.
    +  + + + + + + + + + + + +
    +Method Summary
    + voidback() + +
    +          Go back to the previous module.
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendControlPanel
    setPanels, setPreviousCPanel
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendPanel
    setMaster
    +  + + + + + + + +
    Methods inherited from class javax.swing.JPanel
    getAccessibleContext, getUI, getUIClassID, setUI, updateUI
    +  + + + + + + + +
    Methods inherited from class javax.swing.JComponent
    addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
    +  + + + + + + + +
    Methods inherited from class java.awt.Container
    add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
    +  + + + + + + + +
    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, 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
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +DemoControlPanel

    +
    +public DemoControlPanel()
+                 throws UICreationFailureException
    +
    +
    Constructs a new DemoControlPanel. +

    +

    + +
    Throws: +
    UICreationFailureException - if the UI creation fails.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +back

    +
    +public void back()
    +
    +
    Go back to the previous module. +

    +

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

    +Uses of Class
    uk.org.ury.frontend.cpanels.menu.DemoControlPanel

    +
    +No usage of uk.org.ury.frontend.cpanels.menu.DemoControlPanel +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/cpanels/menu/package-frame.html b/doc/uk/org/ury/frontend/cpanels/menu/package-frame.html new file mode 100644 index 0000000..31c1e1d --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/menu/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +uk.org.ury.frontend.cpanels.menu + + + + + + + + + + + +uk.org.ury.frontend.cpanels.menu + + + + +
    +Classes  + +
    +DemoControlPanel
    + + + + diff --git a/doc/uk/org/ury/frontend/cpanels/menu/package-summary.html b/doc/uk/org/ury/frontend/cpanels/menu/package-summary.html new file mode 100644 index 0000000..1d9668a --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/menu/package-summary.html @@ -0,0 +1,157 @@ + + + + + + +uk.org.ury.frontend.cpanels.menu + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.frontend.cpanels.menu +

    + + + + + + + + + +
    +Class Summary
    DemoControlPanelControl panel for the demo system.
    +  + +

    +

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

    +Hierarchy For Package uk.org.ury.frontend.cpanels.menu +

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

    +Uses of Package
    uk.org.ury.frontend.cpanels.menu

    +
    +No usage of uk.org.ury.frontend.cpanels.menu +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/cpanels/show/LibraryControlPanel.html b/doc/uk/org/ury/frontend/cpanels/show/LibraryControlPanel.html new file mode 100644 index 0000000..6cf1c8c --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/show/LibraryControlPanel.html @@ -0,0 +1,397 @@ + + + + + + +LibraryControlPanel + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.cpanels.show +
    +Class LibraryControlPanel

    +
    +java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.FrontendControlPanel
+                          extended by uk.org.ury.frontend.cpanels.show.LibraryControlPanel
+
    +
    +
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    +
    +
    +
    +
    public class LibraryControlPanel
    extends FrontendControlPanel
    + + +

    +Control panel for the demo system. +

    + +

    +

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

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class javax.swing.JComponent
    javax.swing.JComponent.AccessibleJComponent
    +  + + + + + + + + +
    Nested classes/interfaces inherited from class java.awt.Component
    java.awt.Component.BaselineResizeBehavior
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class javax.swing.JComponent
    TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
    +  + + + + + + + +
    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
    +  + + + + + + + + + + +
    +Constructor Summary
    LibraryControlPanel() + +
    +          Construct a new LibraryControlPanel.
    +  + + + + + + + + + + + +
    +Method Summary
    + voidback() + +
    +          Go back to the previous module.
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendControlPanel
    setPanels, setPreviousCPanel
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendPanel
    setMaster
    +  + + + + + + + +
    Methods inherited from class javax.swing.JPanel
    getAccessibleContext, getUI, getUIClassID, setUI, updateUI
    +  + + + + + + + +
    Methods inherited from class javax.swing.JComponent
    addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
    +  + + + + + + + +
    Methods inherited from class java.awt.Container
    add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
    +  + + + + + + + +
    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, 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
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +LibraryControlPanel

    +
    +public LibraryControlPanel()
+                    throws UICreationFailureException
    +
    +
    Construct a new LibraryControlPanel. +

    +

    + +
    Throws: +
    UICreationFailureException - if the UI creation fails.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +back

    +
    +public void back()
    +
    +
    Go back to the previous module. +

    +

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

    +Uses of Class
    uk.org.ury.frontend.cpanels.show.LibraryControlPanel

    +
    +No usage of uk.org.ury.frontend.cpanels.show.LibraryControlPanel +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/cpanels/show/package-frame.html b/doc/uk/org/ury/frontend/cpanels/show/package-frame.html new file mode 100644 index 0000000..fbec8e6 --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/show/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +uk.org.ury.frontend.cpanels.show + + + + + + + + + + + +uk.org.ury.frontend.cpanels.show + + + + +
    +Classes  + +
    +LibraryControlPanel
    + + + + diff --git a/doc/uk/org/ury/frontend/cpanels/show/package-summary.html b/doc/uk/org/ury/frontend/cpanels/show/package-summary.html new file mode 100644 index 0000000..13adf2c --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/show/package-summary.html @@ -0,0 +1,157 @@ + + + + + + +uk.org.ury.frontend.cpanels.show + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.frontend.cpanels.show +

    + + + + + + + + + +
    +Class Summary
    LibraryControlPanelControl panel for the demo system.
    +  + +

    +

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

    +Hierarchy For Package uk.org.ury.frontend.cpanels.show +

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

    +Uses of Package
    uk.org.ury.frontend.cpanels.show

    +
    +No usage of uk.org.ury.frontend.cpanels.show +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html b/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html index c3cc03c..ccd35ce 100644 --- a/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html @@ -2,7 +2,7 @@ - + LoadFailureException diff --git a/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html b/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html index b01b412..568928a 100644 --- a/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html @@ -2,7 +2,7 @@ - + UICreationFailureException diff --git a/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html b/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html index c80e812..90bbddb 100644 --- a/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html @@ -2,7 +2,7 @@ - + Uses of Class uk.org.ury.frontend.exceptions.LoadFailureException @@ -151,8 +151,8 @@ Uses of 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 ad9a179..a2efd61 100644 --- a/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html @@ -2,7 +2,7 @@ - + Uses of Class uk.org.ury.frontend.exceptions.UICreationFailureException @@ -94,15 +94,19 @@ Packages that use -uk.org.ury.library.viewer +uk.org.ury.frontend.cpanels.menu    -uk.org.ury.show.viewer +uk.org.ury.frontend.cpanels.show    -uk.org.ury.testrig +uk.org.ury.frontend.modules.library +   + + +uk.org.ury.frontend.modules.show    @@ -147,11 +151,11 @@ Uses of + +Uses of UICreationFailureException in uk.org.ury.frontend.cpanels.menu
    -Uses of UICreationFailureException in uk.org.ury.library.viewer
      @@ -159,23 +163,22 @@ Uses of -Constructors in uk.org.ury.library.viewer that throw UICreationFailureException     +Constructors in uk.org.ury.frontend.cpanels.menu that throw UICreationFailureException -LibraryViewerPanel(LibraryViewer viewer, - FrontendMaster master) +DemoControlPanel()
    -          Construct a new LibraryViewerPanel. +          Constructs a new DemoControlPanel.  

    - + +Uses of UICreationFailureException in uk.org.ury.frontend.cpanels.show
    -Uses of UICreationFailureException in uk.org.ury.show.viewer
      @@ -183,42 +186,46 @@ Uses of -Constructors in uk.org.ury.show.viewer that throw UICreationFailureException - - -ChannelPanel(int number, - ShowChannel channel) - -
    -          Construct a new ChannelPanel. +Constructors in uk.org.ury.frontend.cpanels.show that throw UICreationFailureException -LibraryControlPanel() +LibraryControlPanel()
              Construct a new LibraryControlPanel. - -ShowViewerPanel(ShowViewer viewer, - FrontendMaster master) + +  +

    + + + + + +
    +Uses of UICreationFailureException in uk.org.ury.frontend.modules.library
    +  +

    -
    -          Construct a new ShowViewerPanel. + + + - +          Construct a new LibraryViewerPanel.
    Constructors in uk.org.ury.frontend.modules.library that throw UICreationFailureException
    TrackBin(java.lang.String name) +LibraryViewerPanel(LibraryViewer viewer, + FrontendMaster master)
    -          Construct a new TrackBin.
     

    - + +Uses of UICreationFailureException in uk.org.ury.frontend.modules.show
    -Uses of UICreationFailureException in uk.org.ury.testrig
      @@ -226,13 +233,27 @@ Uses of -Constructors in uk.org.ury.testrig that throw UICreationFailureException +Constructors in uk.org.ury.frontend.modules.show that throw UICreationFailureException -DemoControlPanel() +ChannelPanel(int number, + ShowChannel channel)
    -          Constructs a new DemoControlPanel. +          Construct a new ChannelPanel. + + +ShowViewerPanel(ShowViewer viewer, + FrontendMaster master) + +
    +          Construct a new ShowViewerPanel. + + +TrackBin(java.lang.String name) + +
    +          Construct a new TrackBin.   diff --git a/doc/uk/org/ury/frontend/exceptions/package-frame.html b/doc/uk/org/ury/frontend/exceptions/package-frame.html index 36fa46e..5477eac 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-frame.html +++ b/doc/uk/org/ury/frontend/exceptions/package-frame.html @@ -2,7 +2,7 @@ - + uk.org.ury.frontend.exceptions diff --git a/doc/uk/org/ury/frontend/exceptions/package-summary.html b/doc/uk/org/ury/frontend/exceptions/package-summary.html index 55af0ac..00c4161 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-summary.html +++ b/doc/uk/org/ury/frontend/exceptions/package-summary.html @@ -2,7 +2,7 @@ - + uk.org.ury.frontend.exceptions @@ -55,8 +55,8 @@ function windowTitle() - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE FRAMES    NO FRAMES   @@ -132,8 +132,8 @@ Package uk.org.ury.frontend.exceptions - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/frontend/exceptions/package-tree.html b/doc/uk/org/ury/frontend/exceptions/package-tree.html index 7018784..4500af3 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-tree.html +++ b/doc/uk/org/ury/frontend/exceptions/package-tree.html @@ -2,7 +2,7 @@ - + uk.org.ury.frontend.exceptions Class Hierarchy @@ -55,8 +55,8 @@ function windowTitle() - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   @@ -129,8 +129,8 @@ Class Hierarchy - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/frontend/exceptions/package-use.html b/doc/uk/org/ury/frontend/exceptions/package-use.html index 9680c18..0c68c34 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-use.html +++ b/doc/uk/org/ury/frontend/exceptions/package-use.html @@ -2,7 +2,7 @@ - + Uses of Package uk.org.ury.frontend.exceptions @@ -94,15 +94,19 @@ Packages that use -uk.org.ury.library.viewer +uk.org.ury.frontend.cpanels.menu    -uk.org.ury.show.viewer +uk.org.ury.frontend.cpanels.show    -uk.org.ury.testrig +uk.org.ury.frontend.modules.library +   + + +uk.org.ury.frontend.modules.show    @@ -129,14 +133,29 @@ Classes in + + + + + + + + +
    +Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.frontend.cpanels.menu
    UICreationFailureException + +
    +          Exception thrown when the creation of a UI element fails.
    +  +

    + +Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.frontend.cpanels.show - @@ -144,14 +163,14 @@ Classes in +
    -Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.library.viewer
    UICreationFailureException +UICreationFailureException
              Exception thrown when the creation of a UI element fails.
    +Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.frontend.modules.library - @@ -159,14 +178,14 @@ Classes in +
    -Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.show.viewer
    UICreationFailureException +UICreationFailureException
              Exception thrown when the creation of a UI element fails.
    +Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.frontend.modules.show - diff --git a/doc/uk/org/ury/frontend/modules/library/LibraryTableModel.html b/doc/uk/org/ury/frontend/modules/library/LibraryTableModel.html new file mode 100644 index 0000000..3fd28a7 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/LibraryTableModel.html @@ -0,0 +1,362 @@ + + + + + + +LibraryTableModel + + + + + + + + + + + + +
    + + + + + +
    -Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.testrig
    UICreationFailureException +UICreationFailureException
              Exception thrown when the creation of a UI element fails.
    + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.modules.library +
    +Class LibraryTableModel

    +
    +java.lang.Object
+  extended by javax.swing.table.AbstractTableModel
+      extended by uk.org.ury.frontend.modules.library.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/frontend/modules/library/LibraryViewer.html b/doc/uk/org/ury/frontend/modules/library/LibraryViewer.html new file mode 100644 index 0000000..d597bcd --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/LibraryViewer.html @@ -0,0 +1,327 @@ + + + + + + +LibraryViewer + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.modules.library +
    +Class LibraryViewer

    +
    +java.lang.Object
+  extended by uk.org.ury.frontend.AbstractFrontendModule
+      extended by uk.org.ury.frontend.modules.library.LibraryViewer
+
    +
    +
    All Implemented Interfaces:
    FrontendModule
    +
    +
    +
    +
    public class LibraryViewer
    extends AbstractFrontendModule
    + + +

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

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    LibraryViewer() + +
    +          Constructs a new LibraryViewer as a frontend object.
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voiddoSearch(java.lang.String search) + +
    +          Does a library search.
    + java.util.List<LibraryItem>getLibraryList() + +
    +           
    + FrontendModulePanelrunFrontend(FrontendMaster master) + +
    +          Runs the library viewer frontend.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +LibraryViewer

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

    +

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

    +runFrontend

    +
    +public FrontendModulePanel runFrontend(FrontendMaster master)
    +
    +
    Runs the library viewer frontend. +

    +

    +
    Parameters:
    master - The FrontendMaster driving the frontend. +
    Returns:
    the frontend panel to insert into the FrontendMaster.
    +
    +
    +
    + +

    +doSearch

    +
    +public void doSearch(java.lang.String search)
+              throws EmptySearchException,
+                     InvalidMessageException
    +
    +
    Does a library 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. +
    Throws: +
    EmptySearchException - if the search string is empty or null (from + LibraryUtils.search). +
    InvalidMessageException - if the response from the server is invalid.
    +
    +
    +
    + +

    +getLibraryList

    +
    +public java.util.List<LibraryItem> getLibraryList()
    +
    +
    + +
    Returns:
    the current library list.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/modules/library/LibraryViewerPanel.html b/doc/uk/org/ury/frontend/modules/library/LibraryViewerPanel.html new file mode 100644 index 0000000..8311c59 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/LibraryViewerPanel.html @@ -0,0 +1,424 @@ + + + + + + +LibraryViewerPanel + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.modules.library +
    +Class LibraryViewerPanel

    +
    +java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.FrontendModulePanel
+                          extended by uk.org.ury.frontend.modules.library.LibraryViewerPanel
+
    +
    +
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    +
    +
    +
    +
    public class LibraryViewerPanel
    extends FrontendModulePanel
    + + +

    +Frontend panel providing access to an underlying library viewer. +

    + +

    +

    +
    Author:
    +
    Matt Windsor, Nathan Lasseter
    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class javax.swing.JComponent
    javax.swing.JComponent.AccessibleJComponent
    +  + + + + + + + + +
    Nested classes/interfaces inherited from class java.awt.Component
    java.awt.Component.BaselineResizeBehavior
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class javax.swing.JComponent
    TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
    +  + + + + + + + +
    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
    +  + + + + + + + + + + +
    +Constructor Summary
    LibraryViewerPanel(LibraryViewer viewer, + FrontendMaster master) + +
    +          Construct a new LibraryViewerPanel.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetModuleName() + +
    +           
    + voidsearch() + +
    +          Action method for performing a search, bound by the UI XML manifest to + the search field and button.
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendModulePanel
    getModule
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendPanel
    setMaster
    +  + + + + + + + +
    Methods inherited from class javax.swing.JPanel
    getAccessibleContext, getUI, getUIClassID, setUI, updateUI
    +  + + + + + + + +
    Methods inherited from class javax.swing.JComponent
    addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
    +  + + + + + + + +
    Methods inherited from class java.awt.Container
    add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
    +  + + + + + + + +
    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, 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
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +LibraryViewerPanel

    +
    +public LibraryViewerPanel(LibraryViewer viewer,
+                          FrontendMaster master)
+                   throws UICreationFailureException
    +
    +
    Construct a new LibraryViewerPanel. +

    +

    +
    Parameters:
    viewer - The LibraryViewer controlling this LibraryViewerPanel.
    master - The FrontendMaster driving the frontend. +
    Throws: +
    UICreationFailureException - if the UI creation fails.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getModuleName

    +
    +public java.lang.String getModuleName()
    +
    +
    +
    Specified by:
    getModuleName in class FrontendModulePanel
    +
    +
    + +
    Returns:
    the name of the panel.
    See Also:
    FrontendModulePanel.getModuleName()
    +
    +
    +
    + +

    +search

    +
    +public void search()
    +
    +
    Action method for performing a search, bound by the UI XML manifest to + the search field and button. +

    +

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

    +Uses of Class
    uk.org.ury.frontend.modules.library.LibraryTableModel

    +
    +No usage of uk.org.ury.frontend.modules.library.LibraryTableModel +

    +

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

    +Uses of Class
    uk.org.ury.frontend.modules.library.LibraryViewer

    +
    + + + + + + + + + +
    +Packages that use LibraryViewer
    uk.org.ury.frontend.modules.library  
    +  +

    + + + + + +
    +Uses of LibraryViewer in uk.org.ury.frontend.modules.library
    +  +

    + + + + + + + + +
    Constructors in uk.org.ury.frontend.modules.library with parameters of type LibraryViewer
    LibraryViewerPanel(LibraryViewer viewer, + FrontendMaster master) + +
    +          Construct a new LibraryViewerPanel.
    +  +

    +

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

    +Uses of Class
    uk.org.ury.frontend.modules.library.LibraryViewerPanel

    +
    +No usage of uk.org.ury.frontend.modules.library.LibraryViewerPanel +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/modules/library/package-frame.html b/doc/uk/org/ury/frontend/modules/library/package-frame.html new file mode 100644 index 0000000..b60a755 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +uk.org.ury.frontend.modules.library + + + + + + + + + + + +uk.org.ury.frontend.modules.library + + + + +
    +Classes  + +
    +LibraryTableModel +
    +LibraryViewer +
    +LibraryViewerPanel
    + + + + diff --git a/doc/uk/org/ury/frontend/modules/library/package-summary.html b/doc/uk/org/ury/frontend/modules/library/package-summary.html new file mode 100644 index 0000000..ea5857c --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/package-summary.html @@ -0,0 +1,165 @@ + + + + + + +uk.org.ury.frontend.modules.library + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.frontend.modules.library +

    + + + + + + + + + + + + + + + + + +
    +Class Summary
    LibraryTableModelA table model for the library viewer.
    LibraryViewerModule for investigating the track library.
    LibraryViewerPanelFrontend panel providing access to an underlying library viewer.
    +  + +

    +

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

    +Hierarchy For Package uk.org.ury.frontend.modules.library +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +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
            +
          • javax.swing.JComponent (implements java.io.Serializable) + +
          +
        +
      +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/modules/library/package-use.html b/doc/uk/org/ury/frontend/modules/library/package-use.html new file mode 100644 index 0000000..4c8eb56 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/package-use.html @@ -0,0 +1,170 @@ + + + + + + +Uses of Package uk.org.ury.frontend.modules.library + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    uk.org.ury.frontend.modules.library

    +
    + + + + + + + + + +
    +Packages that use uk.org.ury.frontend.modules.library
    uk.org.ury.frontend.modules.library  
    +  +

    + + + + + + + + +
    +Classes in uk.org.ury.frontend.modules.library used by uk.org.ury.frontend.modules.library
    LibraryViewer + +
    +          Module for investigating the track library.
    +  +

    +

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

    +
    +java.lang.Object
+  extended by uk.org.ury.frontend.AbstractFrontendModule
+      extended by uk.org.ury.frontend.modules.menu.DemoMenu
+
    +
    +
    All Implemented Interfaces:
    FrontendModule
    +
    +
    +
    +
    public class DemoMenu
    extends AbstractFrontendModule
    + + +

    +Application frontend, for testing early-stage frontend code. +

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    DemoMenu() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidloadModule(java.lang.String module) + +
    +           
    + voidrun() + +
    +          Run the demo menu, creating a user interface.
    + FrontendModulePanelrunFrontend(FrontendMaster master) + +
    +          Run the demo menu in frontend mode.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +DemoMenu

    +
    +public DemoMenu()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +loadModule

    +
    +public void loadModule(java.lang.String module)
    +
    +
    +
    +
    +
    +
    + +

    +run

    +
    +public void run()
    +
    +
    Run the demo menu, creating a user interface. +

    +

    +
    +
    +
    +
    + +

    +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.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/modules/menu/DemoMenuPanel.html b/doc/uk/org/ury/frontend/modules/menu/DemoMenuPanel.html new file mode 100644 index 0000000..5833e8d --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/DemoMenuPanel.html @@ -0,0 +1,390 @@ + + + + + + +DemoMenuPanel + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.modules.menu +
    +Class DemoMenuPanel

    +
    +java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.FrontendModulePanel
+                          extended by uk.org.ury.frontend.modules.menu.DemoMenuPanel
+
    +
    +
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    +
    +
    +
    +
    public class DemoMenuPanel
    extends FrontendModulePanel
    + + +

    +

    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class javax.swing.JComponent
    javax.swing.JComponent.AccessibleJComponent
    +  + + + + + + + + +
    Nested classes/interfaces inherited from class java.awt.Component
    java.awt.Component.BaselineResizeBehavior
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class javax.swing.JComponent
    TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
    +  + + + + + + + +
    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
    +  + + + + + + + + + + +
    +Constructor Summary
    DemoMenuPanel(FrontendMaster inMaster) + +
    +          Construct a new DemoMenuPanel.
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetModuleName() + +
    +           
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendModulePanel
    getModule
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendPanel
    setMaster
    +  + + + + + + + +
    Methods inherited from class javax.swing.JPanel
    getAccessibleContext, getUI, getUIClassID, setUI, updateUI
    +  + + + + + + + +
    Methods inherited from class javax.swing.JComponent
    addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
    +  + + + + + + + +
    Methods inherited from class java.awt.Container
    add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
    +  + + + + + + + +
    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, 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
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +DemoMenuPanel

    +
    +public DemoMenuPanel(FrontendMaster inMaster)
    +
    +
    Construct a new DemoMenuPanel. +

    +

    +
    Parameters:
    inMaster - The new frontend master of the panel, if any.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getModuleName

    +
    +public java.lang.String getModuleName()
    +
    +
    +
    Specified by:
    getModuleName in class FrontendModulePanel
    +
    +
    + +
    Returns:
    the name of the module.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/modules/menu/class-use/DemoMenu.html b/doc/uk/org/ury/frontend/modules/menu/class-use/DemoMenu.html new file mode 100644 index 0000000..1b9abcb --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/class-use/DemoMenu.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.modules.menu.DemoMenu + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.frontend.modules.menu.DemoMenu

    +
    +No usage of uk.org.ury.frontend.modules.menu.DemoMenu +

    +

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

    +Uses of Class
    uk.org.ury.frontend.modules.menu.DemoMenuPanel

    +
    +No usage of uk.org.ury.frontend.modules.menu.DemoMenuPanel +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/modules/menu/package-frame.html b/doc/uk/org/ury/frontend/modules/menu/package-frame.html new file mode 100644 index 0000000..a8b1492 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +uk.org.ury.frontend.modules.menu + + + + + + + + + + + +uk.org.ury.frontend.modules.menu + + + + +
    +Classes  + +
    +DemoMenu +
    +DemoMenuPanel
    + + + + diff --git a/doc/uk/org/ury/frontend/modules/menu/package-summary.html b/doc/uk/org/ury/frontend/modules/menu/package-summary.html new file mode 100644 index 0000000..706fd25 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/package-summary.html @@ -0,0 +1,161 @@ + + + + + + +uk.org.ury.frontend.modules.menu + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.frontend.modules.menu +

    + + + + + + + + + + + + + +
    +Class Summary
    DemoMenuApplication frontend, for testing early-stage frontend code.
    DemoMenuPanel 
    +  + +

    +

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

    +Hierarchy For Package uk.org.ury.frontend.modules.menu +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    +
      +
    • java.lang.Object
        +
      • uk.org.ury.frontend.AbstractFrontendModule (implements uk.org.ury.frontend.FrontendModule) +
          +
        • uk.org.ury.frontend.modules.menu.DemoMenu
        +
      • java.awt.Component (implements java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable) +
          +
        • java.awt.Container
            +
          • javax.swing.JComponent (implements java.io.Serializable) + +
          +
        +
      +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/modules/menu/package-use.html b/doc/uk/org/ury/frontend/modules/menu/package-use.html new file mode 100644 index 0000000..d172ab8 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/package-use.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Package uk.org.ury.frontend.modules.menu + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    uk.org.ury.frontend.modules.menu

    +
    +No usage of uk.org.ury.frontend.modules.menu +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/modules/show/ChannelPanel.html b/doc/uk/org/ury/frontend/modules/show/ChannelPanel.html new file mode 100644 index 0000000..6b44c78 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/ChannelPanel.html @@ -0,0 +1,363 @@ + + + + + + +ChannelPanel + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.modules.show +
    +Class ChannelPanel

    +
    +java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.modules.show.ChannelPanel
+
    +
    +
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    +
    +
    +
    +
    public class ChannelPanel
    extends FrontendPanel
    + + +

    +A panel displaying channel information. +

    + +

    +

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

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class javax.swing.JComponent
    javax.swing.JComponent.AccessibleJComponent
    +  + + + + + + + + +
    Nested classes/interfaces inherited from class java.awt.Component
    java.awt.Component.BaselineResizeBehavior
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class javax.swing.JComponent
    TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
    +  + + + + + + + +
    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
    +  + + + + + + + + + + +
    +Constructor Summary
    ChannelPanel(int number, + ShowChannel channel) + +
    +          Construct a new ChannelPanel.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendPanel
    setMaster
    +  + + + + + + + +
    Methods inherited from class javax.swing.JPanel
    getAccessibleContext, getUI, getUIClassID, setUI, updateUI
    +  + + + + + + + +
    Methods inherited from class javax.swing.JComponent
    addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
    +  + + + + + + + +
    Methods inherited from class java.awt.Container
    add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
    +  + + + + + + + +
    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, 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
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +ChannelPanel

    +
    +public ChannelPanel(int number,
+                    ShowChannel channel)
+             throws UICreationFailureException
    +
    +
    Construct a new ChannelPanel. + + This constructor reads the channel panel layout from the + XML manifest "channel_panel.xml" in the same directory as + this class file. +

    +

    +
    Parameters:
    number - The number of the channel.
    channel - The channel whose data the ChannelPanel is viewing. +
    Throws: +
    UICreationFailureException - if the UI creation fails.
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/modules/show/ShowViewer.html b/doc/uk/org/ury/frontend/modules/show/ShowViewer.html new file mode 100644 index 0000000..9f9e174 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/ShowViewer.html @@ -0,0 +1,315 @@ + + + + + + +ShowViewer + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.modules.show +
    +Class ShowViewer

    +
    +java.lang.Object
+  extended by uk.org.ury.frontend.AbstractFrontendModule
+      extended by uk.org.ury.frontend.modules.show.ShowViewer
+
    +
    +
    All Implemented Interfaces:
    FrontendModule
    +
    +
    +
    +
    public class ShowViewer
    extends AbstractFrontendModule
    + + +

    +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. +

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ShowViewer() + +
    +          Construct a new ShowViewer as a frontend object.
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.util.List<java.lang.String>getBins() + +
    +           
    + ShowChannel[]getChannels() + +
    +           
    + FrontendModulePanelrunFrontend(FrontendMaster master) + +
    +          Run the library viewer frontend.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +ShowViewer

    +
    +public ShowViewer()
    +
    +
    Construct a new ShowViewer as a frontend object. +

    +

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

    +runFrontend

    +
    +public FrontendModulePanel runFrontend(FrontendMaster master)
    +
    +
    Run the library viewer frontend. +

    +

    +
    Parameters:
    master - The FrontendMaster driving the frontend. +
    Returns:
    the frontend panel to insert into the FrontendMaster.
    +
    +
    +
    + +

    +getChannels

    +
    +public ShowChannel[] getChannels()
    +
    +
    + +
    Returns:
    the channel array.
    +
    +
    +
    + +

    +getBins

    +
    +public java.util.List<java.lang.String> getBins()
+                                         throws QueryFailureException
    +
    +
    + +
    Returns:
    the list of bin names. +
    Throws: +
    QueryFailureException - if the underlying database query fails.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/modules/show/ShowViewerPanel.html b/doc/uk/org/ury/frontend/modules/show/ShowViewerPanel.html new file mode 100644 index 0000000..8f049d0 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/ShowViewerPanel.html @@ -0,0 +1,431 @@ + + + + + + +ShowViewerPanel + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.modules.show +
    +Class ShowViewerPanel

    +
    +java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.FrontendModulePanel
+                          extended by uk.org.ury.frontend.modules.show.ShowViewerPanel
+
    +
    +
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    +
    +
    +
    +
    public class ShowViewerPanel
    extends FrontendModulePanel
    + + +

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

    + +

    +

    +
    Author:
    +
    Matt Windsor, Nathan Lasseter
    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class javax.swing.JComponent
    javax.swing.JComponent.AccessibleJComponent
    +  + + + + + + + + +
    Nested classes/interfaces inherited from class java.awt.Component
    java.awt.Component.BaselineResizeBehavior
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class javax.swing.JComponent
    TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
    +  + + + + + + + +
    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
    +  + + + + + + + + + + +
    +Constructor Summary
    ShowViewerPanel(ShowViewer viewer, + FrontendMaster master) + +
    +          Construct a new ShowViewerPanel.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetModuleName() + +
    +           
    + voidsearch() + +
    +          Initialise the library viewer for the purposes of adding tracks + and/or browsing the library.
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendModulePanel
    getModule
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendPanel
    setMaster
    +  + + + + + + + +
    Methods inherited from class javax.swing.JPanel
    getAccessibleContext, getUI, getUIClassID, setUI, updateUI
    +  + + + + + + + +
    Methods inherited from class javax.swing.JComponent
    addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
    +  + + + + + + + +
    Methods inherited from class java.awt.Container
    add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
    +  + + + + + + + +
    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, 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
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +ShowViewerPanel

    +
    +public ShowViewerPanel(ShowViewer viewer,
+                       FrontendMaster master)
+                throws 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. +
    Throws: +
    UICreationFailureException - if the UI creation fails.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getModuleName

    +
    +public java.lang.String getModuleName()
    +
    +
    +
    Specified by:
    getModuleName in class FrontendModulePanel
    +
    +
    + +
    Returns:
    the name of the panel.
    See Also:
    FrontendModulePanel.getModuleName()
    +
    +
    +
    + +

    +search

    +
    +public void search()
    +
    +
    Initialise the library viewer for the purposes of adding tracks + and/or browsing the library. +

    +

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/modules/show/TrackBin.html b/doc/uk/org/ury/frontend/modules/show/TrackBin.html new file mode 100644 index 0000000..e92ba8f --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/TrackBin.html @@ -0,0 +1,363 @@ + + + + + + +TrackBin + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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.modules.show +
    +Class TrackBin

    +
    +java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.modules.show.TrackBin
+
    +
    +
    All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    +
    +
    +
    +
    public class TrackBin
    extends FrontendPanel
    + + +

    +A panel displaying track bin contents. +

    + +

    +

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

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class javax.swing.JComponent
    javax.swing.JComponent.AccessibleJComponent
    +  + + + + + + + + +
    Nested classes/interfaces inherited from class java.awt.Component
    java.awt.Component.BaselineResizeBehavior
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class javax.swing.JComponent
    TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
    +  + + + + + + + +
    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
    +  + + + + + + + + + + +
    +Constructor Summary
    TrackBin(java.lang.String name) + +
    +          Construct a new TrackBin.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class uk.org.ury.frontend.FrontendPanel
    setMaster
    +  + + + + + + + +
    Methods inherited from class javax.swing.JPanel
    getAccessibleContext, getUI, getUIClassID, setUI, updateUI
    +  + + + + + + + +
    Methods inherited from class javax.swing.JComponent
    addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
    +  + + + + + + + +
    Methods inherited from class java.awt.Container
    add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
    +  + + + + + + + +
    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, 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
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +TrackBin

    +
    +public TrackBin(java.lang.String name)
+         throws UICreationFailureException
    +
    +
    Construct a new TrackBin. + + This constructor reads the channel panel layout from the + XML manifest "track_bin.xml" in the same directory as + this class file. + + TODO: add track list into constructor +

    +

    +
    Parameters:
    name - The name of the bin. +
    Throws: +
    UICreationFailureException - if the UI creation fails.
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    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/modules/show/class-use/ChannelPanel.html b/doc/uk/org/ury/frontend/modules/show/class-use/ChannelPanel.html new file mode 100644 index 0000000..347a935 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/class-use/ChannelPanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.modules.show.ChannelPanel + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.frontend.modules.show.ChannelPanel

    +
    +No usage of uk.org.ury.frontend.modules.show.ChannelPanel +

    +

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

    +Uses of Class
    uk.org.ury.frontend.modules.show.ShowViewer

    +
    + + + + + + + + + +
    +Packages that use ShowViewer
    uk.org.ury.frontend.modules.show  
    +  +

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

    + + + + + + + + +
    Constructors in uk.org.ury.frontend.modules.show with parameters of type ShowViewer
    ShowViewerPanel(ShowViewer viewer, + FrontendMaster master) + +
    +          Construct a new ShowViewerPanel.
    +  +

    +

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

    +Uses of Class
    uk.org.ury.frontend.modules.show.ShowViewerPanel

    +
    +No usage of uk.org.ury.frontend.modules.show.ShowViewerPanel +

    +

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

    +Uses of Class
    uk.org.ury.frontend.modules.show.TrackBin

    +
    +No usage of uk.org.ury.frontend.modules.show.TrackBin +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/modules/show/package-frame.html b/doc/uk/org/ury/frontend/modules/show/package-frame.html new file mode 100644 index 0000000..1ffabea --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/package-frame.html @@ -0,0 +1,38 @@ + + + + + + +uk.org.ury.frontend.modules.show + + + + + + + + + + + +uk.org.ury.frontend.modules.show + + + + +
    +Classes  + +
    +ChannelPanel +
    +ShowViewer +
    +ShowViewerPanel +
    +TrackBin
    + + + + diff --git a/doc/uk/org/ury/frontend/modules/show/package-summary.html b/doc/uk/org/ury/frontend/modules/show/package-summary.html new file mode 100644 index 0000000..a7e77b4 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/package-summary.html @@ -0,0 +1,169 @@ + + + + + + +uk.org.ury.frontend.modules.show + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.frontend.modules.show +

    + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    ChannelPanelA panel displaying channel information.
    ShowViewerFrontend module for viewing show details.
    ShowViewerPanelFrontend panel providing access to an underlying show viewer.
    TrackBinA panel displaying track bin contents.
    +  + +

    +

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

    +Hierarchy For Package uk.org.ury.frontend.modules.show +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +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
            +
          • javax.swing.JComponent (implements java.io.Serializable) + +
          +
        +
      +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/modules/show/package-use.html b/doc/uk/org/ury/frontend/modules/show/package-use.html new file mode 100644 index 0000000..a697637 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/package-use.html @@ -0,0 +1,170 @@ + + + + + + +Uses of Package uk.org.ury.frontend.modules.show + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    uk.org.ury.frontend.modules.show

    +
    + + + + + + + + + +
    +Packages that use uk.org.ury.frontend.modules.show
    uk.org.ury.frontend.modules.show  
    +  +

    + + + + + + + + +
    +Classes in uk.org.ury.frontend.modules.show used by uk.org.ury.frontend.modules.show
    ShowViewer + +
    +          Frontend module for viewing show details.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/package-frame.html b/doc/uk/org/ury/frontend/package-frame.html index fe3138d..a7e56bb 100644 --- a/doc/uk/org/ury/frontend/package-frame.html +++ b/doc/uk/org/ury/frontend/package-frame.html @@ -2,7 +2,7 @@ - + uk.org.ury.frontend diff --git a/doc/uk/org/ury/frontend/package-summary.html b/doc/uk/org/ury/frontend/package-summary.html index 1428153..c55a261 100644 --- a/doc/uk/org/ury/frontend/package-summary.html +++ b/doc/uk/org/ury/frontend/package-summary.html @@ -2,7 +2,7 @@ - + uk.org.ury.frontend @@ -55,8 +55,8 @@ function windowTitle() - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE     FRAMES    NO FRAMES   @@ -95,8 +95,8 @@ Package uk.org.ury.frontend FrontendModule -Interface for all system modules that are to be reachable from - the frontend array. +Interface for all system modules that are to be reachable from the frontend + array.   @@ -132,8 +132,8 @@ Package uk.org.ury.frontend FrontendFrame -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). FrontendModulePanel @@ -190,8 +190,8 @@ Package uk.org.ury.frontend - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/frontend/package-tree.html b/doc/uk/org/ury/frontend/package-tree.html index bf3fd81..6f89e47 100644 --- a/doc/uk/org/ury/frontend/package-tree.html +++ b/doc/uk/org/ury/frontend/package-tree.html @@ -2,7 +2,7 @@ - + uk.org.ury.frontend Class Hierarchy @@ -55,8 +55,8 @@ function windowTitle() - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   @@ -117,7 +117,7 @@ Class Hierarchy
  • java.applet.Applet @@ -170,8 +170,8 @@ Interface Hierarchy - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/frontend/package-use.html b/doc/uk/org/ury/frontend/package-use.html index b2251ef..ca799a0 100644 --- a/doc/uk/org/ury/frontend/package-use.html +++ b/doc/uk/org/ury/frontend/package-use.html @@ -2,7 +2,7 @@ - + Uses of Package uk.org.ury.frontend @@ -94,15 +94,23 @@ Packages that use    -uk.org.ury.library.viewer +uk.org.ury.frontend.cpanels.menu    -uk.org.ury.show.viewer +uk.org.ury.frontend.cpanels.show    -uk.org.ury.testrig +uk.org.ury.frontend.modules.library +   + + +uk.org.ury.frontend.modules.menu +   + + +uk.org.ury.frontend.modules.show    @@ -131,8 +139,8 @@ Classes in uk.org FrontendFrame
    -          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). FrontendMaster @@ -145,8 +153,8 @@ Classes in uk.org FrontendModule
    -          Interface for all system modules that are to be reachable from - the frontend array. +          Interface for all system modules that are to be reachable from the frontend + array. FrontendModulePanel @@ -164,40 +172,84 @@ Classes in uk.org  

    - + + + + + + + + + + + +
    +Classes in uk.org.ury.frontend used by uk.org.ury.frontend.cpanels.menu
    FrontendControlPanel + +
    +          Abstract class for frontend module control panels.
    FrontendPanel + +
    +          An extension of JPanel providing common functionality for user + interface panels in the URY system frontend.
    +  +

    + + + + + + + + + + + +
    +Classes in uk.org.ury.frontend used by uk.org.ury.frontend.cpanels.show
    FrontendControlPanel + +
    +          Abstract class for frontend module control panels.
    FrontendPanel + +
    +          An extension of JPanel providing common functionality for user + interface panels in the URY system frontend.
    +  +

    + +Classes in uk.org.ury.frontend used by uk.org.ury.frontend.modules.library - - - +          Interface for all system modules that are to be reachable from the frontend + array. - -
    -Classes in uk.org.ury.frontend used by uk.org.ury.library.viewer
    AbstractFrontendModule +AbstractFrontendModule
              An abstract implementation of the FrontendModule interface.
    FrontendMaster +FrontendMaster
              Interface for classes providing the parent unit of a frontend session.
    FrontendModule +FrontendModule
    -          Interface for all system modules that are to be reachable from - the frontend array.
    FrontendModulePanel +FrontendModulePanel
              A frontend user interface panel.
    FrontendPanel +FrontendPanel
              An extension of JPanel providing common functionality for user @@ -206,46 +258,40 @@ Classes in uk.org
     

    - + +Classes in uk.org.ury.frontend used by uk.org.ury.frontend.modules.menu - - - - - - +          Interface for all system modules that are to be reachable from the frontend + array. - -
    -Classes in uk.org.ury.frontend used by uk.org.ury.show.viewer
    AbstractFrontendModule +AbstractFrontendModule
              An abstract implementation of the FrontendModule interface.
    FrontendControlPanel - -
    -          Abstract class for frontend module control panels.
    FrontendMaster +FrontendMaster
              Interface for classes providing the parent unit of a frontend session.
    FrontendModule +FrontendModule
    -          Interface for all system modules that are to be reachable from - the frontend array.
    FrontendModulePanel +FrontendModulePanel
              A frontend user interface panel.
    FrontendPanel +FrontendPanel
              An extension of JPanel providing common functionality for user @@ -254,46 +300,40 @@ Classes in uk.org
     

    - + +Classes in uk.org.ury.frontend used by uk.org.ury.frontend.modules.show - - - - - - +          Interface for all system modules that are to be reachable from the frontend + array. - -
    -Classes in uk.org.ury.frontend used by uk.org.ury.testrig
    AbstractFrontendModule +AbstractFrontendModule
              An abstract implementation of the FrontendModule interface.
    FrontendControlPanel - -
    -          Abstract class for frontend module control panels.
    FrontendMaster +FrontendMaster
              Interface for classes providing the parent unit of a frontend session.
    FrontendModule +FrontendModule
    -          Interface for all system modules that are to be reachable from - the frontend array.
    FrontendModulePanel +FrontendModulePanel
              A frontend user interface panel.
    FrontendPanel +FrontendPanel
              An extension of JPanel providing common functionality for user diff --git a/doc/uk/org/ury/frontend/testrig/ApplicationLauncher.html b/doc/uk/org/ury/frontend/testrig/ApplicationLauncher.html new file mode 100644 index 0000000..049e8a8 --- /dev/null +++ b/doc/uk/org/ury/frontend/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.frontend.testrig +
    +Class ApplicationLauncher

    +
    +java.lang.Object
+  extended by uk.org.ury.frontend.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.frontend.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/frontend/testrig/Launcher.html b/doc/uk/org/ury/frontend/testrig/Launcher.html new file mode 100644 index 0000000..64dbf34 --- /dev/null +++ b/doc/uk/org/ury/frontend/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.frontend.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/frontend/testrig/class-use/ApplicationLauncher.html b/doc/uk/org/ury/frontend/testrig/class-use/ApplicationLauncher.html new file mode 100644 index 0000000..af4b74a --- /dev/null +++ b/doc/uk/org/ury/frontend/testrig/class-use/ApplicationLauncher.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.testrig.ApplicationLauncher + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

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

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

    +

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

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

    +
    + + + + + + + + + + + + + +
    +Packages that use Launcher
    uk.org.ury.frontend  
    uk.org.ury.frontend.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.frontend.testrig
    +  +

    + + + + + + + + + +
    Classes in uk.org.ury.frontend.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/frontend/testrig/package-frame.html b/doc/uk/org/ury/frontend/testrig/package-frame.html new file mode 100644 index 0000000..6b1fed0 --- /dev/null +++ b/doc/uk/org/ury/frontend/testrig/package-frame.html @@ -0,0 +1,43 @@ + + + + + + +uk.org.ury.frontend.testrig + + + + + + + + + + + +uk.org.ury.frontend.testrig + + + + +
    +Interfaces  + +
    +Launcher
    + + + + + + +
    +Classes  + +
    +ApplicationLauncher
    + + + + diff --git a/doc/uk/org/ury/frontend/testrig/package-summary.html b/doc/uk/org/ury/frontend/testrig/package-summary.html new file mode 100644 index 0000000..14b8058 --- /dev/null +++ b/doc/uk/org/ury/frontend/testrig/package-summary.html @@ -0,0 +1,171 @@ + + + + + + +uk.org.ury.frontend.testrig + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.frontend.testrig +

    + + + + + + + + + +
    +Interface Summary
    LauncherInterface for entry points into the frontend.
    +  + +

    + + + + + + + + + +
    +Class Summary
    ApplicationLauncherAn application-based entry point into the frontend.
    +  + +

    +

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

    +Hierarchy For Package uk.org.ury.frontend.testrig +

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

    +Uses of Package
    uk.org.ury.frontend.testrig

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

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

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

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/src/uk/org/ury/backend/config/Auth.java b/src/uk/org/ury/backend/config/Auth.java new file mode 100644 index 0000000..46660e5 --- /dev/null +++ b/src/uk/org/ury/backend/config/Auth.java @@ -0,0 +1,36 @@ +package uk.org.ury.backend.config; + +/** + * A login authorisation configuration + * + * @author Nathan Lasseter + */ +public class Auth { + + private String user; + private String pass; + + /** + * Get the username of the login + * + * @return String username + */ + public String getUser() { return user; } + /** + * Get the password of the login + * + * @return String password + */ + public String getPass() { return pass; } + + /** + * Create a login auth object + * @param user The username for the login + * @param pass The password for the login + */ + public Auth(String user, String pass) { + this.user = user; + this.pass = pass; + } + +} \ No newline at end of file diff --git a/src/uk/org/ury/backend/config/ConfigReader.java b/src/uk/org/ury/backend/config/ConfigReader.java new file mode 100644 index 0000000..63403c9 --- /dev/null +++ b/src/uk/org/ury/backend/config/ConfigReader.java @@ -0,0 +1,115 @@ +package uk.org.ury.backend.config; + +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; + +import org.w3c.dom.Document; +import org.w3c.dom.Element; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; +import org.xml.sax.SAXException; +import org.xml.sax.SAXParseException; + +import uk.org.ury.backend.database.exceptions.MissingCredentialsException; + +/** + * Reads in an XML config file and creates config objects + * + * @author Nathan Lasseter + */ +public class ConfigReader { + + private Database database = null; + private Auth roAuth = null; + private Auth rwAuth = null; + + /** + * Get the database configuration + * + * @return Database database + */ + public Database getDatabase() { return database; } + /** + * Get the read only login auth configuration + * + * @return Auth roAauth + */ + public Auth getRoAuth() { return roAuth; } + /** + * Get the read write login auth configuration + * + * @return Auth rwAauth + */ + public Auth getRwAuth() { return rwAuth; } + + /** + * Read in the config file and create the Database and Auth configuration objects. + * Specify a config file. + * @throws MissingCredentialsException + */ + public ConfigReader(String configFile) throws MissingCredentialsException { + + try { + DocumentBuilderFactory docBuilderFactory = DocumentBuilderFactory.newInstance(); + DocumentBuilder docBuilder = docBuilderFactory.newDocumentBuilder(); + Document doc = docBuilder.parse (configFile); + doc.getDocumentElement().normalize(); + + NodeList nList = doc.getElementsByTagName("auth"); + for(int i = 0; i < nList.getLength(); i++) { + Node nNode = nList.item(i); + if(nNode.getNodeType() == Node.ELEMENT_NODE) { + Element eElement = (Element) nNode; + String user = getTagValue("user", eElement); + String pass = getTagValue("pass", eElement); + String sType = getTagValue("type", eElement); + if(sType.equalsIgnoreCase("read_only")) { + if(roAuth != null) continue; + roAuth = new Auth(user, pass); + } else if(sType.equalsIgnoreCase("read_write")) { + if(rwAuth != null) continue; + rwAuth = new Auth(user, pass); + } else { + throw new IllegalArgumentException("Unused user class."); + } + } + } + + nList = doc.getElementsByTagName("database"); + for(int i = 0; i < nList.getLength(); i++) { + if(database != null) break; + Node nNode = nList.item(i); + if(nNode.getNodeType() == Node.ELEMENT_NODE) { + Element eElement = (Element) nNode; + String host = getTagValue("host", eElement); + String port = getTagValue("port", eElement); + String db = getTagValue("db", eElement); + database = new Database(host, Integer.parseInt(port.trim()), db); + } + } + } + + catch(NullPointerException n) { + throw new MissingCredentialsException("An element node is empty."); + } + + catch (SAXParseException err) { + System.out.println ("** Parsing error" + ", line " + err.getLineNumber () + ", uri " + err.getSystemId ()); + System.out.println(" " + err.getMessage ()); + } + catch (SAXException e) { + Exception x = e.getException (); + ((x == null) ? e : x).printStackTrace (); + } + catch (Throwable t) { + t.printStackTrace (); + } + } + + private static String getTagValue(String sTag, Element eElement){ + NodeList nlList= eElement.getElementsByTagName(sTag).item(0).getChildNodes(); + Node nValue = (Node) nlList.item(0); + + return nValue.getNodeValue(); + } +} diff --git a/src/uk/org/ury/backend/config/Database.java b/src/uk/org/ury/backend/config/Database.java new file mode 100644 index 0000000..1939a4a --- /dev/null +++ b/src/uk/org/ury/backend/config/Database.java @@ -0,0 +1,45 @@ +package uk.org.ury.backend.config; + +/** + * A Database Server configuration + * + * @author Nathan Lasseter + */ +public class Database { + + private String host; + private int port; + private String db; + + /** + * Get the hostname of the database server + * + * @return String hostname + */ + public String getHost() { return host; } + /** + * Get the port the database server is running on + * + * @return int port + */ + public int getPort() { return port; } + /** + * Get the name of the database + * + * @return String database name + */ + public String getDb() { return db; } + + /** + * Create a database object + * @param host The hostname of the database server + * @param port The port that the database server listens on + * @param db The name of the database on the server + */ + public Database(String host, int port, String db) { + this.host = host; + this.port = port; + this.db = db; + } + +} \ No newline at end of file diff --git a/src/uk/org/ury/backend/database/DatabaseDriver.java b/src/uk/org/ury/backend/database/DatabaseDriver.java new file mode 100644 index 0000000..5cd9b98 --- /dev/null +++ b/src/uk/org/ury/backend/database/DatabaseDriver.java @@ -0,0 +1,166 @@ +package uk.org.ury.backend.database; + +import java.sql.Connection; +import java.sql.DriverManager; +import java.sql.PreparedStatement; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; + +import uk.org.ury.backend.config.ConfigReader; +import uk.org.ury.backend.database.exceptions.ConnectionFailureException; +import uk.org.ury.backend.database.exceptions.MissingCredentialsException; + +/** + * A database connection manager that connects to the URY databases using + * suitably privileged accounts, and handles the processing of SQL queries. + * + * @author Matt Windsor + * @author Nathan Lasseter + * + */ +public class DatabaseDriver { + /* The JDBC path used to connect to the URY database. */ + private String DATABASE_PATH = "jdbc:postgresql://"; + + /* The database connection. */ + private Connection conn; + + /** + * Construct a new DatabaseDriver with the given user class. + * + * @param config + * The config with login details. + * + * @param type + * The user class to log in to the database with. + * + * @throws IllegalArgumentException + * if the user class is not supported (this should not happen). + * + * @throws MissingCredentialsException + * if the user class login credentials could not be loaded. + * + * @throws ConnectionFailureException + * if the database backend failed to connect to the database + * server. + */ + public DatabaseDriver(ConfigReader config, UserClass type) + throws MissingCredentialsException, ConnectionFailureException { + try { + connect(config, type); + } catch (SQLException e) { + throw new ConnectionFailureException(e.getMessage()); + } + + } + + /** + * Connect to the URY database. + * + * @param config + * The config to use for the connection. + * @param type + * The access level of the connection + * + * @throws SQLException + * if the database connection failed. + */ + private void connect(ConfigReader config, UserClass type) + throws SQLException { + if (config == null) + throw new IllegalArgumentException("Supplied null config."); + + if (config.getDatabase().getHost() == null) + throw new IllegalArgumentException("config has no associated host."); + + if (config.getDatabase().getDb() == null) + throw new IllegalArgumentException( + "config has no associated database."); + + DATABASE_PATH = DATABASE_PATH + config.getDatabase().getHost() + "/" + + config.getDatabase().getDb(); + + if (type == UserClass.READ_ONLY) { + if (config.getRoAuth().getUser() == null) + throw new IllegalArgumentException( + "config has no associated username."); + if (config.getRoAuth().getPass() == null) + throw new IllegalArgumentException( + "config has no associated password."); + conn = DriverManager.getConnection(DATABASE_PATH, config + .getRoAuth().getUser(), config.getRoAuth().getPass()); + } else if (type == UserClass.READ_WRITE) { + if (config.getRwAuth().getUser() == null) + throw new IllegalArgumentException( + "config has no associated username."); + if (config.getRwAuth().getPass() == null) + throw new IllegalArgumentException( + "config has no associated password."); + conn = DriverManager.getConnection(DATABASE_PATH, config + .getRwAuth().getUser(), config.getRwAuth().getPass()); + } + } + + /** + * Execute an unprepared SQL statement with no arguments. + * + * @param sql + * The SQL statement to execute. + * @param fetchSize + * The maximum number of query rows to return. + * + * @return the JDBC results set. + * + * @throws SQLException + * if a SQL error occurs. + */ + public ResultSet executeQuery(String sql, int fetchSize) + throws SQLException { + Statement st = conn.createStatement(); + st.setFetchSize(fetchSize); + + return st.executeQuery(sql); + } + + /** + * Perform a SQL statement with arguments. + * + * This accepts an array of parameter objects, which must each either be + * String or Integer objects. The objects will be used sequentially to fill + * in '?' placeholders in the query text. + * + * @param sql + * The SQL statement to execute. + * @param params + * A list of parameter objects. + * @param fetchSize + * The maximum number of query rows to return. + * + * @return the set of results from the query. + * + * @throws IllegalArgumentException + * if any of the parameters is unsupported by the database as a + * statement parameter. + * + * @throws SQLException + * if a SQL error occurs. + */ + public ResultSet executeQuery(String sql, Object[] params, int fetchSize) + throws SQLException { + PreparedStatement st = conn.prepareStatement(sql); + + st.setFetchSize(fetchSize); + + for (int i = 0; i < params.length; i++) + if (params[i] instanceof String) + st.setString(i + 1, (String) params[i]); + else if (params[i] instanceof Integer) + st.setInt(i + 1, (Integer) params[i]); + else + throw new IllegalArgumentException("Unsupported parameter #" + + (i + 1)); + + return st.executeQuery(); + } +} diff --git a/src/uk/org/ury/backend/database/DatabaseItem.java b/src/uk/org/ury/backend/database/DatabaseItem.java new file mode 100644 index 0000000..b25e9f2 --- /dev/null +++ b/src/uk/org/ury/backend/database/DatabaseItem.java @@ -0,0 +1,80 @@ +package uk.org.ury.backend.database; + +import java.util.HashMap; +import java.util.Map; + +import uk.org.ury.backend.database.exceptions.MissingPropertyException; + +/** + * An abstract class presenting a template for objects serving as a data + * structure for collections of properties retrieved from a SQL database. + * + * @param E + * The enumeration type used as the property list. + * + * @param T + * The type of datum stored for each property. + * + * @author Matt Windsor + */ +public abstract class DatabaseItem { + private Map properties; + + /** + * Construct a new item from an existing list of properties. + * + * @param properties + * The map of properties that the new item will inherit. + */ + public DatabaseItem(Map properties) { + this.properties = properties; + } + + /** + * Check whether a property has been set in the item. + * + * @return true if the property has been set; false otherwise. + */ + + public boolean has(E property) { + return properties.containsKey(property); + } + + /** + * Query this item for a property. + * + * @param property + * The property to query. + * + * @return The property, if it exists. + * + * @throws MissingPropertyException + * if the property does not exist. + */ + public T get(E property) throws MissingPropertyException { + if (properties.containsKey(property)) + return properties.get(property); + else + throw new MissingPropertyException(property.toString()); + } + + /** + * Retrieve a map of string representations of the properties. + * + * This relies on E and T having meaningful toString methods. + * + * @return a list of lines representing the response. + */ + public Map asResponse() { + // TODO: Fan out implementation details into separate class + Map response = new HashMap(); + + for (E property : properties.keySet()) { + if (properties.get(property) != null) + response.put(property.toString(), properties.get(property) + .toString()); + } + + return response; + } +} diff --git a/src/uk/org/ury/backend/database/UserClass.java b/src/uk/org/ury/backend/database/UserClass.java new file mode 100644 index 0000000..1cd39fc --- /dev/null +++ b/src/uk/org/ury/backend/database/UserClass.java @@ -0,0 +1,38 @@ +/** + * + */ +package uk.org.ury.backend.database; + +/** + * The various user classes of the database driver. + * + * These refer to various users in the database proper, and thus grant various + * levels of permission to the program. + * + * Please use the least privileged user class that works. For most cases, + * READ_ONLY should work perfectly. + * + * @author Matt Windsor + * + */ + +public enum UserClass { + // Constant configName + READ_ONLY ("read_only"), + READ_WRITE ("read_write"); + + /** + * The name of the tag in the configuration file that contains the + * credentials for this user class. + */ + public String configName; + + /** + * Constructs a new UserClass. + * + * @param configName The name of the user class in the config. + */ + private UserClass(String configName) { + this.configName = configName; + } +} diff --git a/src/uk/org/ury/backend/database/exceptions/ConnectionFailureException.java b/src/uk/org/ury/backend/database/exceptions/ConnectionFailureException.java new file mode 100644 index 0000000..393f3ce --- /dev/null +++ b/src/uk/org/ury/backend/database/exceptions/ConnectionFailureException.java @@ -0,0 +1,44 @@ +/** + * + */ +package uk.org.ury.backend.database.exceptions; + +/** + * Exception thrown when the database backend fails to connect to + * the database server, in absence of a more specific exception. + * + * @author Matt Windsor + */ + +public class ConnectionFailureException extends Exception +{ + /** + * + */ + private static final long serialVersionUID = -7353531873142099828L; + + +/** + * Construct a new ConnectionFailureException with a + * default reason. + */ + + public + ConnectionFailureException () + { + super ("Connection failure."); + } + + + /** + * Construct a new ConnectionFailureException. + * + * @param reason The explanation for the exception. + */ + + public + ConnectionFailureException (String reason) + { + super (reason); + } +} diff --git a/src/uk/org/ury/backend/database/exceptions/MissingCredentialsException.java b/src/uk/org/ury/backend/database/exceptions/MissingCredentialsException.java new file mode 100644 index 0000000..4c73683 --- /dev/null +++ b/src/uk/org/ury/backend/database/exceptions/MissingCredentialsException.java @@ -0,0 +1,52 @@ +/** + * + */ +package uk.org.ury.backend.database.exceptions; + +/** + * Exception thrown when the database credentials required to + * log into the URY database under a user class are missing, + * and thus the log-in cannot continue. + * + * The best practice for handling a MissingCredentialsException + * is to attempt to log into the database with a less privileged + * user class or, if the credentials for read-only access are + * missing, give up. + * + * @author Matt Windsor + */ + +public class MissingCredentialsException extends Exception +{ + + /** + * + */ + + private static final long serialVersionUID = -397479334359858162L; + + + /** + * Construct a new MissingCredentialsException with a + * default reason. + */ + + public + MissingCredentialsException () + { + super ("Missing credentials."); + } + + + /** + * Construct a new MissingCredentialsException. + * + * @param reason The explanation for the exception. + */ + + public + MissingCredentialsException (String reason) + { + super (reason); + } +} diff --git a/src/uk/org/ury/backend/database/exceptions/MissingPropertyException.java b/src/uk/org/ury/backend/database/exceptions/MissingPropertyException.java new file mode 100644 index 0000000..485771b --- /dev/null +++ b/src/uk/org/ury/backend/database/exceptions/MissingPropertyException.java @@ -0,0 +1,47 @@ +/** + * + */ +package uk.org.ury.backend.database.exceptions; + + +/** + * Exception thrown when a DatabaseItem is queried for a property + * that does not exist. + * + * This is (usually) not a fatal error. + * + * @author Matt Windsor + */ + +public class MissingPropertyException extends Exception +{ + /** + * + */ + private static final long serialVersionUID = -7353531873142099828L; + + +/** + * Construct a new MissingPropertyException with a + * default reason. + */ + + public + MissingPropertyException () + { + super ("Query failure."); + } + + + /** + * Construct a new MissingPropertyException. + * + * @param reason The explanation for the exception. + */ + + public + MissingPropertyException (String reason) + { + super (reason); + } +} diff --git a/src/uk/org/ury/backend/database/exceptions/QueryFailureException.java b/src/uk/org/ury/backend/database/exceptions/QueryFailureException.java new file mode 100644 index 0000000..6c01e61 --- /dev/null +++ b/src/uk/org/ury/backend/database/exceptions/QueryFailureException.java @@ -0,0 +1,45 @@ +/** + * + */ +package uk.org.ury.backend.database.exceptions; + + +/** + * Exception thrown when the database backend fails to execute + * a query. + * + * @author Matt Windsor + */ + +public class QueryFailureException extends Exception +{ + /** + * + */ + private static final long serialVersionUID = -7353531873142099828L; + + +/** + * Construct a new QueryFailureException with a + * default reason. + */ + + public + QueryFailureException () + { + super ("Query failure."); + } + + + /** + * Construct a new QueryFailureException. + * + * @param reason The explanation for the exception. + */ + + public + QueryFailureException (String reason) + { + super (reason); + } +} diff --git a/src/uk/org/ury/backend/database/exceptions/package.html b/src/uk/org/ury/backend/database/exceptions/package.html new file mode 100644 index 0000000..b5e7cac --- /dev/null +++ b/src/uk/org/ury/backend/database/exceptions/package.html @@ -0,0 +1,11 @@ + + + + + uk.org.ury.database.exceptions + + +

    Exceptions thrown by the database services classes.

    + + \ No newline at end of file diff --git a/src/uk/org/ury/backend/database/package.html b/src/uk/org/ury/backend/database/package.html new file mode 100644 index 0000000..2b138b8 --- /dev/null +++ b/src/uk/org/ury/backend/database/package.html @@ -0,0 +1,15 @@ + + + + + uk.org.ury.database + + +

    Database services for the URY Presenter Suite.

    +

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

    + + \ No newline at end of file diff --git a/src/uk/org/ury/backend/handlers/LibraryRequestHandler.java b/src/uk/org/ury/backend/handlers/LibraryRequestHandler.java new file mode 100644 index 0000000..25423f6 --- /dev/null +++ b/src/uk/org/ury/backend/handlers/LibraryRequestHandler.java @@ -0,0 +1,189 @@ +/** + * + */ +package uk.org.ury.backend.handlers; + +import java.io.UnsupportedEncodingException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Locale; +import java.util.Map; + +import org.apache.http.HttpRequest; +import org.apache.http.HttpResponse; +import org.apache.http.HttpStatus; +import org.apache.http.entity.StringEntity; +import org.apache.http.protocol.HTTP; +import org.apache.http.protocol.HttpContext; +import org.json.simple.JSONValue; + +import uk.org.ury.backend.database.DatabaseDriver; +import uk.org.ury.backend.database.UserClass; +import uk.org.ury.backend.database.exceptions.ConnectionFailureException; +import uk.org.ury.backend.database.exceptions.MissingCredentialsException; +import uk.org.ury.backend.database.exceptions.QueryFailureException; +import uk.org.ury.backend.server.AbstractRequestHandler; +import uk.org.ury.backend.server.Server; +import uk.org.ury.backend.server.exceptions.BadRequestException; +import uk.org.ury.backend.server.exceptions.HandleFailureException; +import uk.org.ury.backend.server.exceptions.HandlerNotFoundException; +import uk.org.ury.backend.server.exceptions.HandlerSetupFailureException; +import uk.org.ury.backend.server.exceptions.NotAHandlerException; +import uk.org.ury.backend.server.exceptions.UnknownFunctionException; +import uk.org.ury.common.library.LibraryUtils; +import uk.org.ury.common.library.exceptions.EmptySearchException; +import uk.org.ury.common.library.item.LibraryItem; +import uk.org.ury.common.protocol.Directive; +import uk.org.ury.common.protocol.Status; + +/** + * A request handler for library queries. + * + * @author Matt Windsor + */ +public class LibraryRequestHandler extends AbstractRequestHandler { + /** + * Construct a new LibraryRequestHandler. + * + * @param server + * The instance of the URY server responsible for the request. + * + * @param mount + * The directory to which this handler is to be mounted. + */ + public LibraryRequestHandler(Server server, String mount) { + super(server, mount); + } + + /** + * Perform a library search, populating the response list. + * + * @param 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. + * + * @param response + * The response list to populate. + * + * @param server + * The server providing database resources. + * + * @throws HandleFailureException + * if an error occurs that thwarts the handling of the request. + */ + + private void doSearch(Map parameters, + Map response, Server server) + throws HandleFailureException { + if (parameters.containsKey("search") == false) + throw new HandleFailureException("Search term is missing."); + else if (parameters.get("search") == null) + throw new HandleFailureException("Search term is null."); + + String search = parameters.get("search"); + DatabaseDriver dd = null; + + try { + dd = server.getDatabaseConnection(UserClass.READ_ONLY); + } catch (MissingCredentialsException e) { + throw new HandleFailureException(e.getMessage()); + } catch (ConnectionFailureException e) { + throw new HandleFailureException(e.getMessage()); + } + + try { + List> itemArray = new ArrayList>(); + + for (LibraryItem li : LibraryUtils.search(dd, search)) { + itemArray.add(li.asResponse()); + } + + response.put(Directive.ITEMS.toString(), itemArray); + } catch (QueryFailureException e) { + throw new HandleFailureException(e.getMessage()); + } catch (EmptySearchException e) { + throw new HandleFailureException(e.getMessage()); + } + } + + /** + * Handle a HTTP GET request. + * + * @param request + * The HTTP request. + * + * @param response + * The response that the handler will populate during the + * handling of the request. + * + * @param context + * The HTTP context. + * + * @throws HandlerNotFoundException + * if the client requested a request handler that could not be + * found on the class path. + * + * @throws HandlerSetupFailureException + * if the handler was found but could not be set up (eg does not + * implement appropriate interface or cannot be instantiated). + * + * @throws HandleFailureException + * if an appropriate handler was contacted, but it failed to + * process the request. + * + * @throws BadRequestException + * if the request was malformed or invalid. + * + * @throws NotAHandlerException + * if the class requested to handle the request is not a + * handler. + * + * @throws UnknownFunctionException + * if the request is for a path that does not correspond to one + * of this handler's functions. + */ + @Override + public void handleGet(HttpRequest request, HttpResponse response, + HttpContext context) throws HandlerNotFoundException, + HandlerSetupFailureException, HandleFailureException, + BadRequestException, NotAHandlerException, UnknownFunctionException { + String path; + String uri = request.getRequestLine().getUri(); + String query = getQueryString(uri); + + if (query == null) + path = uri.toLowerCase(Locale.ENGLISH); + else + path = uri.split("\\?" + query)[0].toLowerCase(Locale.ENGLISH); + + Map content = new HashMap(); + + if (path.equals("/library/tracks")) { + try { + doSearch(parseQueryString(query), content, server); + } catch (UnsupportedEncodingException e) { + throw new HandleFailureException(e.getMessage()); + } + } else { + throw new UnknownFunctionException(path); + } + + response.setStatusLine(request.getProtocolVersion(), HttpStatus.SC_OK, + "OK"); + + content.put(Directive.STATUS.toString(), Status.OK.toString()); + + StringEntity entity = null; + + try { + entity = new StringEntity(JSONValue.toJSONString(content)); + } catch (UnsupportedEncodingException e) { + throw new HandlerSetupFailureException(getClass().getName(), e); + } + + entity.setContentType(HTTP.PLAIN_TEXT_TYPE); + response.setEntity(entity); + } +} diff --git a/src/uk/org/ury/backend/server/AbstractRequestHandler.java b/src/uk/org/ury/backend/server/AbstractRequestHandler.java new file mode 100644 index 0000000..53517d7 --- /dev/null +++ b/src/uk/org/ury/backend/server/AbstractRequestHandler.java @@ -0,0 +1,254 @@ +/** + * + */ +package uk.org.ury.backend.server; + +import java.io.IOException; +import java.io.UnsupportedEncodingException; +import java.net.URLDecoder; +import java.util.HashMap; +import java.util.Locale; +import java.util.Map; + +import org.apache.http.HttpException; +import org.apache.http.HttpRequest; +import org.apache.http.HttpResponse; +import org.apache.http.HttpStatus; +import org.apache.http.entity.StringEntity; +import org.apache.http.protocol.HTTP; +import org.apache.http.protocol.HttpContext; +import org.apache.http.protocol.HttpRequestHandler; +import org.json.simple.JSONValue; + +import uk.org.ury.backend.server.exceptions.BadRequestException; +import uk.org.ury.backend.server.exceptions.HandleFailureException; +import uk.org.ury.backend.server.exceptions.HandlerNotFoundException; +import uk.org.ury.backend.server.exceptions.HandlerSetupFailureException; +import uk.org.ury.backend.server.exceptions.HandlingException; +import uk.org.ury.backend.server.exceptions.NotAHandlerException; +import uk.org.ury.backend.server.exceptions.UnknownFunctionException; +import uk.org.ury.common.protocol.Directive; +import uk.org.ury.common.protocol.Status; + +/** + * An abstract request handler for HttpCore, providing basic functionality such + * as uniform error response. + * + * @author Matt Windsor + */ +public abstract class AbstractRequestHandler implements HttpRequestHandler { + protected Server server; + protected String mount; + + /** + * Constructs a new AbstractRequestHandler. + * + * Obviously, this class cannot be instantiated directly. + * + * @param server + * The instance of the URY server responsible for the request. + * + * @param mount + * The directory to which this handler is to be mounted. + */ + public AbstractRequestHandler(Server server, String mount) { + this.server = server; + this.mount = mount; + } + + /** + * Begins handling of a HTTP request. + * + * @param request + * The HTTP request. + * + * @param response + * The response that the handler will populate during the + * handling of the request. + * + * @param context + * The HTTP context. + */ + @Override + public void handle(HttpRequest request, HttpResponse response, + HttpContext context) throws HttpException, IOException { + String method = request.getRequestLine().getMethod() + .toUpperCase(Locale.ENGLISH); + + if (method.equals("GET")) { + try { + handleGet(request, response, context); + } catch (HandlerNotFoundException e) { + // TODO: log + serveError(request, response, HttpStatus.SC_NOT_FOUND, + e.getMessage()); + } catch (BadRequestException e) { + // TODO: log + serveError(request, response, HttpStatus.SC_BAD_REQUEST, + e.getMessage()); + } catch (HandlingException e) { + serveError(request, response, + HttpStatus.SC_INTERNAL_SERVER_ERROR, e.getMessage()); + } + } else { + serveError(request, response, HttpStatus.SC_NOT_IMPLEMENTED, + "Method not implemented."); + } + } + + /** + * Serves a HTTP plain-text error as the HTTP response for a request. + * + * @param request + * The request that is being responded to. + * + * @param response + * The response to populate with the error message. + * + * @param code + * HTTP status code to use. + * + * @param reason + * The reason to display to the client. + */ + protected void serveError(HttpRequest request, HttpResponse response, + int code, String reason) { + // Get the reason string to put in the error response. + String statusReason = ""; + + switch (code) { + case HttpStatus.SC_BAD_REQUEST: + statusReason = "Bad Request"; + break; + case HttpStatus.SC_NOT_FOUND: + statusReason = "Not Found"; + break; + default: + case HttpStatus.SC_INTERNAL_SERVER_ERROR: + statusReason = "Internal Server Error"; + break; + } + + response.setStatusLine(request.getProtocolVersion(), code, statusReason); + StringEntity entity = null; + + try { + Map content = new HashMap(); + + content.put(Directive.STATUS.toString(), Status.ERROR.toString()); + content.put(Directive.REASON.toString(), reason); + + entity = new StringEntity(JSONValue.toJSONString(content)); + } catch (UnsupportedEncodingException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + + if (entity != null) { + entity.setContentType(HTTP.PLAIN_TEXT_TYPE); + response.setEntity(entity); + } + } + + /** + * Handles a HTTP GET request. + * + * @param request + * The HTTP request. + * + * @param response + * The response that the handler will populate during the + * handling of the request. + * + * @param context + * The HTTP context. + * + * @throws HandlerNotFoundException + * if the client requested a request handler that could not be + * found on the class path. + * + * @throws HandlerSetupFailureException + * if the handler was found but could not be set up (eg does not + * implement appropriate interface or cannot be instantiated). + * + * @throws HandleFailureException + * if an appropriate handler was contacted, but it failed to + * process the request. + * + * @throws BadRequestException + * if the request was malformed or invalid. + * + * @throws NotAHandlerException + * if the class requested to handle the request is not a + * handler. + * + * @throws UnknownFunctionException + * if the request is for a path that does not correspond to one + * of this handler's functions. + */ + protected abstract void handleGet(HttpRequest request, + HttpResponse response, HttpContext context) + throws HandlerNotFoundException, HandlerSetupFailureException, + HandleFailureException, BadRequestException, NotAHandlerException, + UnknownFunctionException; + + /** + * Parses a query string, populating a key-value map of the URL-unescaped + * results. + * + * @param query + * The query string to parse. + * + * @return A map associating parameter keys and values. + * + * @throws UnsupportedEncodingException + * if the URL decoder fails. + */ + protected final Map parseQueryString(String query) + throws UnsupportedEncodingException { + Map params = new HashMap(); + + // At least one parameter + if (query != null && query.endsWith("&") == false) { + String[] qsplit = { query }; + + // More than one parameter - split the query. + if (query.contains("&")) + qsplit = query.split("&"); + + for (String param : qsplit) { + // Has a value + if (param.contains("=") && param.endsWith("=") == false) { + String[] paramsplit = param.split("="); + params.put(URLDecoder.decode(paramsplit[0], "UTF-8"), + URLDecoder.decode(paramsplit[1], "UTF-8")); + } + // Doesn't have a value + else if (param.contains("=") == false) { + params.put(URLDecoder.decode(param, "UTF-8"), null); + } + } + } + + return params; + } + + /** + * Gets the query string element of a URI. + * + * @param uri + * The Uniform Resource Indicator whose query string should be + * extracted. + * + * @return The query string, or null if it does not exist. + */ + protected final String getQueryString(String uri) { + String result = null; + + if (uri.contains("?") && uri.endsWith("?") == false) { + result = uri.split("\\?")[1]; + } + + return result; + } +} \ No newline at end of file diff --git a/src/uk/org/ury/backend/server/ApiRequestHandler.java b/src/uk/org/ury/backend/server/ApiRequestHandler.java new file mode 100644 index 0000000..fc867ce --- /dev/null +++ b/src/uk/org/ury/backend/server/ApiRequestHandler.java @@ -0,0 +1,42 @@ +package uk.org.ury.backend.server; + +import java.util.Map; + +import uk.org.ury.backend.server.exceptions.HandleFailureException; + + +/** + * 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 + */ +public interface ApiRequestHandler +{ + /** + * Handle a server GET request (that is, a request for data + * output). + * + * @param 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. + * + * @param server The server from which the request originated. + * This will be able to provide the handler with + * pooled resources, for example the database. + * + * @return A series of key-value pairs to pass back to + * the client. + * + * @throws HandleFailureException if the handler cannot + * handle the request. + */ + + public Map + handleGetRequest (Map parameters, Server server) + throws HandleFailureException; +} diff --git a/src/uk/org/ury/backend/server/HttpHandler.java b/src/uk/org/ury/backend/server/HttpHandler.java new file mode 100644 index 0000000..ed94d3d --- /dev/null +++ b/src/uk/org/ury/backend/server/HttpHandler.java @@ -0,0 +1,205 @@ +/* + * HttpHandler.java + * --------------------- + * + * Part of the URY Server Platform + * + * V0.00 2011/03/20 + * + * (C) 2011 URY Computing + * + * Based on the HttpCore example code, which is available under the + * Apache License, version 2.0; the copyright notice provided with + * said code follows. + * + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + +package uk.org.ury.backend.server; + +import java.io.UnsupportedEncodingException; +import java.net.MalformedURLException; +import java.net.URL; +import java.util.Map; + +import org.apache.http.HttpRequest; +import org.apache.http.HttpResponse; +import org.apache.http.HttpStatus; +import org.apache.http.entity.StringEntity; +import org.apache.http.protocol.HTTP; +import org.apache.http.protocol.HttpContext; +import org.apache.http.protocol.HttpRequestHandler; +import org.json.simple.JSONValue; + +import uk.org.ury.backend.server.exceptions.BadRequestException; +import uk.org.ury.backend.server.exceptions.HandleFailureException; +import uk.org.ury.backend.server.exceptions.HandlerNotFoundException; +import uk.org.ury.backend.server.exceptions.HandlerSetupFailureException; +import uk.org.ury.backend.server.exceptions.NotAHandlerException; +import uk.org.ury.common.protocol.Directive; +import uk.org.ury.common.protocol.Status; + +/** + * @author Matt Windsor, Apache Software Foundation + */ +public class HttpHandler extends AbstractRequestHandler implements + HttpRequestHandler { + + /** + * Construct a new HttpHandler. + * + * @param server + * The instance of the URY server responsible for the request. + * + * @param mount + * The directory to which this handler is to be mounted. + */ + public HttpHandler(Server server, String mount) { + super(server, mount); + } + + /** + * Handle a HTTP GET request. + * + * @param request + * The HTTP request. + * + * @param response + * The response that the handler will populate during the + * handling of the request. + * + * @param context + * The HTTP context. + * + * @throws HandlerNotFoundException + * if the client requested a request handler that could not be + * found on the class path. + * + * @throws HandlerSetupFailureException + * if the handler was found but could not be set up (eg does not + * implement appropriate interface or cannot be instantiated). + * + * @throws HandleFailureException + * if an appropriate handler was contacted, but it failed to + * process the request. + * + * @throws BadRequestException + * if the request was malformed or invalid. + * + * @throws NotAHandlerException + * if the class requested to handle the request is not a + * handler. + */ + @Override + public void handleGet(HttpRequest request, HttpResponse response, + HttpContext context) throws HandlerNotFoundException, + HandlerSetupFailureException, HandleFailureException, + BadRequestException, NotAHandlerException { + String path = request.getRequestLine().getUri(); + + if (path.equals("/index.html") || path.equals("/")) { + // Someone's trying to get the index page! + // Humour them. + + response.setStatusLine(request.getProtocolVersion(), + HttpStatus.SC_OK, "OK"); + + StringEntity entity = null; + + try { + entity = new StringEntity(Server.DOCTYPE + Server.INDEX_HTML); + } catch (UnsupportedEncodingException e) { + throw new HandlerSetupFailureException("(Index page)", e); + } + + entity.setContentType("text/html"); + + response.setEntity(entity); + } else { + // Convert this into a URL and fan out the various parts of it. + + URL pathURL = null; + + try { + pathURL = new URL("http://localhost" + path); + } catch (MalformedURLException e) { + throw new BadRequestException(e); + } + + String className = "uk.org.ury" + + pathURL.getPath().replace('/', '.'); + System.out.println(className); + Class newClass = null; + + try { + newClass = Class.forName(className); + } catch (ClassNotFoundException e) { + throw new HandlerNotFoundException(className, e); + } + + if (ApiRequestHandler.class.isAssignableFrom(newClass) == false) + throw new NotAHandlerException(className); + + String queryString = pathURL.getQuery(); + Map parameters; + + try { + parameters = parseQueryString(queryString); + } catch (UnsupportedEncodingException e) { + throw new HandlerSetupFailureException(className, e); + } + + Map content = null; + + try { + ApiRequestHandler srh = ((ApiRequestHandler) newClass + .newInstance()); + content = srh.handleGetRequest(parameters, server); + } catch (InstantiationException e) { + throw new HandlerSetupFailureException(className, e); + } catch (IllegalAccessException e) { + throw new HandlerSetupFailureException(className, e); + } + + // Everything seems OK, so make the response. + + response.setStatusLine(request.getProtocolVersion(), + HttpStatus.SC_OK, "OK"); + + content.put(Directive.STATUS.toString(), Status.OK.toString()); + + StringEntity entity = null; + + try { + entity = new StringEntity(JSONValue.toJSONString(content)); + } catch (UnsupportedEncodingException e) { + throw new HandlerSetupFailureException(className, e); + } + + entity.setContentType(HTTP.PLAIN_TEXT_TYPE); + response.setEntity(entity); + } + } +} diff --git a/src/uk/org/ury/backend/server/HttpListenerThread.java b/src/uk/org/ury/backend/server/HttpListenerThread.java new file mode 100644 index 0000000..c14ddb9 --- /dev/null +++ b/src/uk/org/ury/backend/server/HttpListenerThread.java @@ -0,0 +1,128 @@ +/* + * HttpListenerThread.java + * ----------------------- + * + * Part of the URY Server Platform + * + * V0.00 2011/03/20 + * + * (C) 2011 URY Computing + * + * Based on the HttpCore example code, which is available under the + * Apache License, version 2.0; the copyright notice provided with + * said code follows. + * + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + +package uk.org.ury.backend.server; + +import java.io.IOException; +import java.net.ServerSocket; +import java.net.Socket; + +import org.apache.http.HttpResponseInterceptor; +import org.apache.http.impl.DefaultConnectionReuseStrategy; +import org.apache.http.impl.DefaultHttpResponseFactory; +import org.apache.http.impl.DefaultHttpServerConnection; +import org.apache.http.params.CoreConnectionPNames; +import org.apache.http.params.CoreProtocolPNames; +import org.apache.http.params.HttpParams; +import org.apache.http.params.SyncBasicHttpParams; +import org.apache.http.protocol.HttpProcessor; +import org.apache.http.protocol.HttpRequestHandlerRegistry; +import org.apache.http.protocol.HttpService; +import org.apache.http.protocol.ImmutableHttpProcessor; +import org.apache.http.protocol.ResponseConnControl; +import org.apache.http.protocol.ResponseContent; +import org.apache.http.protocol.ResponseDate; +import org.apache.http.protocol.ResponseServer; + +import uk.org.ury.backend.handlers.LibraryRequestHandler; + +/** + * Listener thread for the URY server HTTP interface. + * + * @author Matt Windsor + * @author Apache Software Foundation + */ +public class HttpListenerThread extends Thread { + private ServerSocket ssocket; + private HttpParams params; + private HttpProcessor httpproc; + private HttpRequestHandlerRegistry registry; + private HttpService service; + + public HttpListenerThread(int port, Server server) throws IOException { + ssocket = new ServerSocket(port); + params = new SyncBasicHttpParams(); + + params.setIntParameter(CoreConnectionPNames.SO_TIMEOUT, 5000) + .setIntParameter(CoreConnectionPNames.SOCKET_BUFFER_SIZE, + 8 * 1024) + .setBooleanParameter( + CoreConnectionPNames.STALE_CONNECTION_CHECK, false) + .setBooleanParameter(CoreConnectionPNames.TCP_NODELAY, true) + .setParameter(CoreProtocolPNames.ORIGIN_SERVER, + "HttpComponents/1.1"); + + httpproc = new ImmutableHttpProcessor(new HttpResponseInterceptor[] { + new ResponseDate(), new ResponseServer(), + new ResponseContent(), new ResponseConnControl() }); + + registry = new HttpRequestHandlerRegistry(); + registry.register("/library/*", new LibraryRequestHandler(server, + "/library")); + registry.register("*", new HttpHandler(server, "")); + + service = new HttpService(httpproc, + new DefaultConnectionReuseStrategy(), + new DefaultHttpResponseFactory(), registry, params); + } + + /** + * Thread execution body. + */ + @Override + public void run() { + while (Thread.interrupted() == false) { + Socket csocket = null; + DefaultHttpServerConnection conn = new DefaultHttpServerConnection(); + Thread thread = null; + + try { + csocket = ssocket.accept(); + conn.bind(csocket, params); + } catch (IOException e) { + e.printStackTrace(); + break; + } + + thread = new HttpWorkerThread(service, conn); + thread.setDaemon(true); + thread.start(); + } + } +} diff --git a/src/uk/org/ury/backend/server/HttpWorkerThread.java b/src/uk/org/ury/backend/server/HttpWorkerThread.java new file mode 100644 index 0000000..563832a --- /dev/null +++ b/src/uk/org/ury/backend/server/HttpWorkerThread.java @@ -0,0 +1,104 @@ +/* + * HttpWorkerThread.java + * --------------------- + * + * Part of the URY Server Platform + * + * V0.00 2011/03/20 + * + * (C) 2011 URY Computing + * + * Based on the HttpCore example code, which is available under the + * Apache License, version 2.0; the copyright notice provided with + * said code follows. + * + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ + +package uk.org.ury.backend.server; + +import java.io.IOException; +import java.io.InterruptedIOException; + +import org.apache.http.ConnectionClosedException; +import org.apache.http.HttpException; +import org.apache.http.HttpServerConnection; +import org.apache.http.protocol.BasicHttpContext; +import org.apache.http.protocol.HttpContext; +import org.apache.http.protocol.HttpService; + +/** + * A worker thread in the server HTTP interface. + * + * This thread handles requests from the connected client, passing them to the + * request handler(s). + * + * @author Matt Windsor, Apache Software Foundation + */ +public class HttpWorkerThread extends Thread { + private final HttpService service; + private final HttpServerConnection conn; + + /** + * Construct a new HttpWorkerThread. + * + * @param service + * The HTTP service the thread is working for. + * @param conn + * The connection the thread is listening on. + */ + public HttpWorkerThread(HttpService service, HttpServerConnection conn) { + super(); + this.service = service; + this.conn = conn; + } + + /** + * Thread execution body. + */ + public void run() { + HttpContext context = new BasicHttpContext(null); + + try { + while (Thread.interrupted() == false && conn.isOpen()) { + service.handleRequest(conn, context); + } + } catch (ConnectionClosedException e) { + System.out.println("Client closed connection."); + } catch (InterruptedIOException e) { + System.out.println("Interrupted IO: " + e.getMessage()); + } catch (IOException e) { + e.printStackTrace(); + } catch (HttpException e) { + e.printStackTrace(); + } finally { + try { + conn.shutdown(); + } catch (IOException e) { + // Ignore + } + } + } +} diff --git a/src/uk/org/ury/backend/server/Server.java b/src/uk/org/ury/backend/server/Server.java new file mode 100644 index 0000000..57a0030 --- /dev/null +++ b/src/uk/org/ury/backend/server/Server.java @@ -0,0 +1,99 @@ +/* + * Server.java + * ----------- + * + * Part of the URY Server Platform + * + * V0.00 2011/03/20 + * + * (C) 2011 URY Computing + */ + +package uk.org.ury.backend.server; + +import java.io.IOException; + +import uk.org.ury.backend.config.ConfigReader; +import uk.org.ury.backend.database.DatabaseDriver; +import uk.org.ury.backend.database.UserClass; +import uk.org.ury.backend.database.exceptions.ConnectionFailureException; +import uk.org.ury.backend.database.exceptions.MissingCredentialsException; + +/** + * The unified URY server, accepting requests over HTTP. + * + * @author Matt Windsor + * @version 2011.0320 + */ +public class Server { + public static final String SERVER_VERSION = "SLUT 0.0"; + public static final String DOCTYPE = ""; + public static final String INDEX_HTML = "\n" + "\n " + + "\n " + SERVER_VERSION + "" + "\n " + + "\n " + "\n

    Welcome to the " + SERVER_VERSION + + " server

    " + + "\n

    This server exposes a class-based API for accessing" + + "\n the internals of the " + SERVER_VERSION + " system.

    " + + "\n

    See the documentation for details.

    " + "\n " + + "\n"; + + /** + * The main method, which serves to create a server. + * + * @param args + * The argument vector. + */ + public static void main(String[] args) { + Server srv = new Server(); + srv.run(); + } + + /** + * Run the server. + */ + private void run() { + Thread thread = null; + + try { + thread = new HttpListenerThread(8000, this); + } catch (IOException e) { + e.printStackTrace(); + System.exit(-1); + } + + thread.setDaemon(false); + thread.run(); + } + + /** + * Gets a database connection using the given user class. + * + * @param userClass + * The user class to get a connection for. + * + * @return 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. + * + * @throws ConnectionFailureException + * if the connection failed. + */ + public DatabaseDriver getDatabaseConnection(UserClass userClass) + throws MissingCredentialsException, ConnectionFailureException { + // TODO: Singleton + + ConfigReader config = new ConfigReader("res/conf.xml"); + + return new DatabaseDriver(config, UserClass.READ_ONLY); + } + + /** + * @return the version string of the server. + */ + public String getVersion() { + return SERVER_VERSION; + } +} diff --git a/src/uk/org/ury/backend/server/ServerRequestHandler.java b/src/uk/org/ury/backend/server/ServerRequestHandler.java new file mode 100644 index 0000000..82764f2 --- /dev/null +++ b/src/uk/org/ury/backend/server/ServerRequestHandler.java @@ -0,0 +1,95 @@ +/** + * + */ +package uk.org.ury.backend.server; + +import java.util.HashMap; +import java.util.Map; + +import uk.org.ury.backend.server.ApiRequestHandler; +import uk.org.ury.backend.server.Server; +import uk.org.ury.backend.server.exceptions.HandleFailureException; + + +/** + * A request handler for server queries. + * + * @author Matt Windsor + */ + +public class ServerRequestHandler implements ApiRequestHandler +{ + /** + * Handle a server GET request (that is, a request for data + * output). + * + * @param 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. + * + * @param server The server from which the request originated. + * This will be able to provide the handler with + * pooled resources, for example the database. + * + * @return 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. + */ + + @Override + public Map + handleGetRequest (Map parameters, Server server) + throws HandleFailureException + { + Map response = new HashMap (); + + if (parameters.containsKey ("function")) + { + String function = parameters.get ("function"); + + if (function.equals ("info")) + { + getInfo (response, server); + } + else if (function.equals ("help")) + { + response.put ("INFO", "Available functions:"); + response.put ("INFO", "info - Get server information."); + } + else if (function.equals ("test")) + response.put ("INFO", "Test succeeded."); + else + throw new HandleFailureException ("Unknown function: " + + function + ". (Try 'function=help'.)"); + + } + else + throw new HandleFailureException ("No function provided. (Try 'function=help'.)"); + + return response; + } + + + /** + * Retrieve information about the server. + * + * @param response The response list to populate. + * + * @param server The server providing database resources. + * + * @throws HandleFailureException if an error occurs + * that thwarts the handling of the request. + */ + + private void + getInfo (Map response, Server server) + throws HandleFailureException + { + response.put ("INFO", "University Radio York BAPS Replacement"); + response.put ("INFO", "Server version is " + server.getVersion ()); + } + +} diff --git a/src/uk/org/ury/backend/server/exceptions/BadRequestException.java b/src/uk/org/ury/backend/server/exceptions/BadRequestException.java new file mode 100644 index 0000000..6f200f3 --- /dev/null +++ b/src/uk/org/ury/backend/server/exceptions/BadRequestException.java @@ -0,0 +1,47 @@ +/** + * + */ +package uk.org.ury.backend.server.exceptions; + +/** + * Exception thrown when the server meets a malformed request, or + * part of one. + * + * @author Matt Windsor + */ + +public class BadRequestException extends HandlingException +{ + + /** + * + */ + private static final long serialVersionUID = 1825771401085225357L; + + + /** + * Construct a new BadRequestException with a default reason. + */ + + public + BadRequestException () + { + super ("Bad request."); + } + + + /** + * Construct a new HandlerNotFoundException with a chained + * exception. + * + * @param cause The exception that this new exception is to + * wrap. + */ + + public + BadRequestException (Throwable cause) + { + super ("Bad request. (" + + cause.getMessage () + ")", cause); + } +} diff --git a/src/uk/org/ury/backend/server/exceptions/HandleFailureException.java b/src/uk/org/ury/backend/server/exceptions/HandleFailureException.java new file mode 100644 index 0000000..0efb7a3 --- /dev/null +++ b/src/uk/org/ury/backend/server/exceptions/HandleFailureException.java @@ -0,0 +1,46 @@ +/** + * + */ +package uk.org.ury.backend.server.exceptions; + +/** + * Generic exception thrown when a server request handler fails to + * handle a request. + * + * @author Matt Windsor + */ + +public class HandleFailureException extends HandlingException +{ + + /** + * Change this! ---v + */ + + private static final long serialVersionUID = -397479334359858162L; + + + /** + * Construct a new HandleFailureException with a + * default reason. + */ + + public + HandleFailureException () + { + super ("Server request handler failed to handle the request."); + } + + + /** + * Construct a new HandleFailureException. + * + * @param reason The explanation for the exception. + */ + + public + HandleFailureException (String reason) + { + super (reason); + } +} diff --git a/src/uk/org/ury/backend/server/exceptions/HandlerNotFoundException.java b/src/uk/org/ury/backend/server/exceptions/HandlerNotFoundException.java new file mode 100644 index 0000000..a7ba136 --- /dev/null +++ b/src/uk/org/ury/backend/server/exceptions/HandlerNotFoundException.java @@ -0,0 +1,51 @@ +/** + * + */ +package uk.org.ury.backend.server.exceptions; + +/** + * Exception thrown when the server request handler requested + * by the client is not * found in the class space. + * + * @author Matt Windsor + */ + +public class HandlerNotFoundException extends HandlingException +{ + + /** + * TODO: Change this! ---v + */ + + private static final long serialVersionUID = -397479334359858162L; + + + /** + * Construct a new HandlerNotFoundException with a + * default reason. + */ + + public + HandlerNotFoundException () + { + super ("Handler not found."); + } + + + /** + * Construct a new HandlerNotFoundException with a class name and + * chained exception. + * + * @param className The name of the missing handler class. + * + * @param cause The exception that this new exception is to + * wrap. + */ + + public + HandlerNotFoundException (String className, Throwable cause) + { + super ("Handler " + className + " not found. (" + + cause.getMessage () + ")", cause); + } +} diff --git a/src/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.java b/src/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.java new file mode 100644 index 0000000..d70624a --- /dev/null +++ b/src/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.java @@ -0,0 +1,55 @@ +/** + * + */ +package uk.org.ury.backend.server.exceptions; + +/** + * Exception thrown when the server request handler requested + * by the client cannot be set up to process the request. + * + * @author Matt Windsor + */ + +public class HandlerSetupFailureException extends HandlingException +{ + + /** + * TODO: Change this! ---v + */ + + private static final long serialVersionUID = -397479334359858162L; + + + /** + * Construct a new HandlerNotFoundException with a + * default reason. + */ + + public + HandlerSetupFailureException () + { + super ("Handler setup failed."); + } + + + /** + * Construct a new HandlerSetupFailureException with a class name + * and chained exception. + * + * Use this to hide exception specifics from higher abstraction + * layers. + * + * @param className The name of the failed handler class. + * + * @param cause The exception that this new exception is to + * wrap. + */ + + public + HandlerSetupFailureException (String className, + Throwable cause) + { + super ("Setup for handler " + className + " failed (reason: " + + cause.getMessage () + ").", cause); + } +} diff --git a/src/uk/org/ury/backend/server/exceptions/HandlingException.java b/src/uk/org/ury/backend/server/exceptions/HandlingException.java new file mode 100644 index 0000000..edca0aa --- /dev/null +++ b/src/uk/org/ury/backend/server/exceptions/HandlingException.java @@ -0,0 +1,48 @@ +/** + * + */ +package uk.org.ury.backend.server.exceptions; + +/** + * Generic exception thrown when the server cannot handle a request. + * + * @author Matt Windsor + */ + +public class HandlingException extends Exception +{ + /** + * TODO: Change this! ---v + */ + + private static final long serialVersionUID = -397479334359858162L; + + + /** + * Construct a HandlingException with a reason. + * + * @param string The reason to present. + */ + + public + HandlingException (String string) + { + super (string); + } + + + /** + * Construct a HandlingException with a reason and a cause to + * chain. + * + * @param string The reason to present. + * + * @param cause The thrown cause that this exception should wrap. + */ + + public + HandlingException (String string, Throwable cause) + { + super (string, cause); + } +} diff --git a/src/uk/org/ury/backend/server/exceptions/NotAHandlerException.java b/src/uk/org/ury/backend/server/exceptions/NotAHandlerException.java new file mode 100644 index 0000000..d5c9d93 --- /dev/null +++ b/src/uk/org/ury/backend/server/exceptions/NotAHandlerException.java @@ -0,0 +1,34 @@ +/** + * + */ +package uk.org.ury.backend.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). + * + * @author Matt Windsor + */ + +public class NotAHandlerException extends HandlingException +{ + /** + * + */ + private static final long serialVersionUID = -7268289187311868036L; + + /** + * Construct a NotAHandlerException with the name of the class that + * is not a handler. + * + * @param className The name of the offending class. + */ + + public + NotAHandlerException (String className) + { + super ("Class " + className + " is not a request handler."); + // TODO Auto-generated constructor stub + } + +} diff --git a/src/uk/org/ury/backend/server/exceptions/UnknownFunctionException.java b/src/uk/org/ury/backend/server/exceptions/UnknownFunctionException.java new file mode 100644 index 0000000..c0a8a06 --- /dev/null +++ b/src/uk/org/ury/backend/server/exceptions/UnknownFunctionException.java @@ -0,0 +1,37 @@ +/* + * UnknownFunctionException.java + * ----------------------------- + * + * Part of the URY Server Platform + * + * V0.00 2011/03/20 + * + * (C) 2011 URY Computing + */ + +package uk.org.ury.backend.server.exceptions; + +/** + * Exception thrown when a handler receives a request for a path that does not + * correspond to one of its functions. + * + * @author Matt Windsor + * + */ +public class UnknownFunctionException extends HandlingException { + /** + * + */ + private static final long serialVersionUID = -7557785978712465975L; + + /** + * Construct a new UnknownFunctionException. + * + * @param path + * The path that was requested. + */ + public UnknownFunctionException(String path) { + super("Not found: " + path); + } + +} diff --git a/src/uk/org/ury/backend/server/package.html b/src/uk/org/ury/backend/server/package.html new file mode 100644 index 0000000..b19b3b7 --- /dev/null +++ b/src/uk/org/ury/backend/server/package.html @@ -0,0 +1,23 @@ + + + + + uk.org.ury.server + + +

    The URY Server kernel.

    +

    The URY Server provides high-level access to the assets + (database, files and sound playback) available on the computer + systems of a radio station, exposing an intuitive application + programming interface using standard formats.

    +

    The server kernel consists of an Apache HttpCore-based HTTP + server implementation, which serves the high-level interface + to the server, code for managing the external modules that make + up the URY backend, and a common provider of objects useful to + server-level modules.

    +

    Though designed and built to replace the systems in place + at University Radio York, it is hoped that the URY Server will + be of use + + \ No newline at end of file diff --git a/src/uk/org/ury/client/Client.java b/src/uk/org/ury/client/Client.java deleted file mode 100644 index 5b8be62..0000000 --- a/src/uk/org/ury/client/Client.java +++ /dev/null @@ -1,60 +0,0 @@ -package uk.org.ury.client; - -import java.io.BufferedReader; -import java.io.IOException; -import java.io.InputStreamReader; - -import java.net.MalformedURLException; -import java.net.URL; -import java.net.URLConnection; - -import java.util.Map; - -import uk.org.ury.protocol.ProtocolUtils; -import uk.org.ury.protocol.exceptions.DecodeFailureException; - -public class Client { - /** - * Get a raw response from the server. - * - * @param file - * The "file", including path and query string, to fetch from the - * server. - * - * @return The response from the server, as a key-value map. - * - * @throws DecodeFailureException - * if the decode failed. - */ - public Map get(String file) throws DecodeFailureException { - URL url = null; - URLConnection uc = null; - String result = ""; - - try { - url = new URL("http://localhost:8000" + file); - } catch (MalformedURLException e) { - // TODO Auto-generated catch block - e.printStackTrace(); - } - - try { - uc = url.openConnection(); - - BufferedReader in = new BufferedReader(new InputStreamReader( - uc.getInputStream())); - - String inputLine; - - for (inputLine = in.readLine(); inputLine != null; inputLine = in - .readLine()) { - result += inputLine; - } - } catch (IOException e) { - // TODO Auto-generated catch block - e.printStackTrace(); - } - - return ProtocolUtils.decode(result); - } -} diff --git a/src/uk/org/ury/client/test/ClientTest.java b/src/uk/org/ury/client/test/ClientTest.java deleted file mode 100644 index 3ee70ef..0000000 --- a/src/uk/org/ury/client/test/ClientTest.java +++ /dev/null @@ -1,57 +0,0 @@ -/** - * - */ -package uk.org.ury.client.test; - -import java.util.Map; - -import junit.framework.Assert; - -import org.junit.After; -import org.junit.Before; -import org.junit.Test; - -import uk.org.ury.client.Client; -import uk.org.ury.protocol.Directive; -import uk.org.ury.protocol.exceptions.DecodeFailureException; - -/** - * JUnit test for the low-level client logic. - * - * @author Matt Windsor - */ -public class ClientTest { - - /** - * @throws java.lang.Exception - */ - @Before - public void setUp() throws Exception { - } - - /** - * @throws java.lang.Exception - */ - @After - public void tearDown() throws Exception { - } - - /** - * Test method for {@link uk.org.ury.client.Client#get(java.lang.String)}. - */ - @Test - public void testGet() { - Client client = new Client(); - - Map response = null; - - try { - response = client.get("/server/ServerRequestHandler?function=test"); - } catch (DecodeFailureException e) { - e.printStackTrace(); - } - - Assert.assertEquals("Test succeeded.", - response.get(Directive.INFO.toString())); - } -} diff --git a/src/uk/org/ury/common/library/LibraryUtils.java b/src/uk/org/ury/common/library/LibraryUtils.java new file mode 100644 index 0000000..335b8b5 --- /dev/null +++ b/src/uk/org/ury/common/library/LibraryUtils.java @@ -0,0 +1,144 @@ +/** + * + */ +package uk.org.ury.common.library; + +import java.sql.ResultSet; +import java.sql.SQLException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import uk.org.ury.backend.database.DatabaseDriver; +import uk.org.ury.backend.database.exceptions.QueryFailureException; +import uk.org.ury.common.library.exceptions.EmptySearchException; +import uk.org.ury.common.library.item.LibraryItem; +import uk.org.ury.common.library.item.LibraryItemProperty; + + + +/** + * A set of common utility routines to facilitate the extraction of + * library items from the library areas of the URY database. + * + * @author Matt Windsor + */ + +public class LibraryUtils +{ + /** + * Perform a library search. + * + * @param db The database to query. + * + * @param search The search fragment to include in the search. + * Can be empty or null. + * + * @throws IllegalArgumentException if the search term is + * are null. + * + * @throws QueryFailureException if the database backend + * yielded an error while executing the search + * query. + * + * @throws EmptySearchException if the search term is + * empty (to be handled as a user error). + * + * @return a list of LibraryItems matching the search terms. + */ + + public static List + search (DatabaseDriver db, String search) + throws QueryFailureException, EmptySearchException + { + if (db == null) + throw new IllegalArgumentException ("Database handle is null."); + + if (search == null) + throw new IllegalArgumentException ("Search string is null."); + + List results = new ArrayList (); + + + // Return empty set if the search term is null. + + if (search.equals("")) + throw new EmptySearchException (); + + + ResultSet rs = null; + + Object[] params = {"%" + search + "%", "%" + search + "%", "%" + search + "%"}; + + try + { + rs = db.executeQuery ( + "SELECT r.title AS album, t.title," + + " t.artist, recordlabel AS label, status, media AS medium, format," + + " datereleased, EXTRACT(EPOCH FROM dateadded) as dateadded," + + " EXTRACT(EPOCH FROM datetime_lastedit) AS dateedited," + + " shelfletter, shelfnumber, cdid, digitised, clean" + + " FROM rec_record AS r" + + " INNER JOIN rec_track AS t ON (r.recordid = t.recordid)" + + " WHERE t.title ILIKE ?" + + " OR t.artist ILIKE ?" + + " OR r.title ILIKE ?" + + " ORDER BY digitised DESC, medium ASC, r.title ASC," + + " t.artist ASC, t.title ASC;", params, 50); + } + catch (SQLException e) + { + throw new QueryFailureException (e.getMessage ()); + } + + try + { + while (rs.next ()) + { + results.add (translateRow (rs)); + } + } + catch (SQLException e) + { + throw new QueryFailureException (e.getMessage ()); + } + + return results; + } + + + /** + * Translate a row retrieved from the database into a LibraryItem. + * + * @param rs The result-set, or database cursor, pointing to the + * row to translate. + * + * @return A new LibraryItem containing the properties extracted + * from the translated row. + */ + + private static LibraryItem + translateRow (ResultSet rs) + { + // Translate SQL columns into a list of properties. + + Map properties = new HashMap (); + + for (LibraryItemProperty p : LibraryItemProperty.values ()) + { + try + { + properties.put (p, rs.getString (p.sql)); + } + catch (SQLException e) + { + // Ignore this, as it is almost certainly just a non-existent + // property. + } + } + + + return new LibraryItem (properties); + } +} diff --git a/src/uk/org/ury/common/library/exceptions/EmptySearchException.java b/src/uk/org/ury/common/library/exceptions/EmptySearchException.java new file mode 100644 index 0000000..fc4ed68 --- /dev/null +++ b/src/uk/org/ury/common/library/exceptions/EmptySearchException.java @@ -0,0 +1,49 @@ +/** + * + */ +package uk.org.ury.common.library.exceptions; + +/** + * Exception thrown when a library search is initiated + * in which the query string is null. + * + * Frontends should handle this nicely. Do NOT treat this + * as a fatal error! + * + * @author Matt Windsor + */ + +public class EmptySearchException extends Exception +{ + + /** + * Change this! ---v + */ + + private static final long serialVersionUID = -397479334359858162L; + + + /** + * Construct a new EmptySearchException with a + * default reason. + */ + + public + EmptySearchException () + { + super ("Query string was empty."); + } + + + /** + * Construct a new EmptySearchException. + * + * @param reason The explanation for the exception. + */ + + public + EmptySearchException (String reason) + { + super (reason); + } +} diff --git a/src/uk/org/ury/common/library/item/LibraryItem.java b/src/uk/org/ury/common/library/item/LibraryItem.java new file mode 100644 index 0000000..3e81041 --- /dev/null +++ b/src/uk/org/ury/common/library/item/LibraryItem.java @@ -0,0 +1,26 @@ +/** + * + */ +package uk.org.ury.common.library.item; + + +import java.util.Map; + +import uk.org.ury.backend.database.DatabaseItem; + + +/** + * An item in the URY library. + * + * @author Matt Windsor + */ + +public class LibraryItem extends DatabaseItem +{ + public + LibraryItem (Map properties) + { + super (properties); + } +} \ No newline at end of file diff --git a/src/uk/org/ury/common/library/item/LibraryItemProperty.java b/src/uk/org/ury/common/library/item/LibraryItemProperty.java new file mode 100644 index 0000000..2e4d2ef --- /dev/null +++ b/src/uk/org/ury/common/library/item/LibraryItemProperty.java @@ -0,0 +1,62 @@ +package uk.org.ury.common.library.item; + +/** + * The parameters that are stored in the LibraryItem. + * + * @author Matt Windsor + */ + +public enum LibraryItemProperty + { + // Constant SQL identifier + TITLE ("title"), + ALBUM ("album"), + ARTIST ("artist"), + LABEL ("label"), + STATUS ("status"), + MEDIUM ("medium"), + FORMAT ("format"), + DATE_RELEASED ("datereleased"), + DATE_ADDED ("dateadded"), + DATE_EDITED ("dateedited"), + SHELF_LETTER ("shelfletter"), + SHELF_NUMBER ("shelfnumber"), + CD_ID ("cdid"), + IS_DIGITISED ("digitised"), + IS_CLEAN ("clean"); + + + public final String sql; + + + private + LibraryItemProperty (String sql) + { + this.sql = sql; + } + + + /** + * Retrieve a LibraryItemProperty given its SQL identifier. + * + * @param string The SQL identifier. + * @return The first property to match. + * + * @throws IllegalArgumentException if no matches were + * found. + */ + + public static LibraryItemProperty + getFromSQL (String string) + { + // TODO: Better exception? + + for (LibraryItemProperty prop : values ()) + { + if (prop.sql.equals (string)) + return prop; + } + + throw new IllegalArgumentException ("Nonexistent property SQL."); + } + }; \ No newline at end of file diff --git a/src/uk/org/ury/common/protocol/Directive.java b/src/uk/org/ury/common/protocol/Directive.java new file mode 100644 index 0000000..e1edd98 --- /dev/null +++ b/src/uk/org/ury/common/protocol/Directive.java @@ -0,0 +1,18 @@ +/** + * + */ +package uk.org.ury.common.protocol; + +/** + * Directives supported by the protocol. + * + * @author Matt Windsor + */ + +public enum Directive + { + INFO, // Information string (can usually be ignored) + ITEMS, // Item + STATUS, // Status code (from the enum Status) + REASON; // Error reason + } diff --git a/src/uk/org/ury/common/protocol/ProtocolUtils.java b/src/uk/org/ury/common/protocol/ProtocolUtils.java new file mode 100644 index 0000000..8686eb7 --- /dev/null +++ b/src/uk/org/ury/common/protocol/ProtocolUtils.java @@ -0,0 +1,85 @@ +/** + * + */ +package uk.org.ury.common.protocol; + +import java.util.Map; + +import org.json.simple.JSONObject; +import org.json.simple.JSONValue; + +import uk.org.ury.common.protocol.exceptions.DecodeFailureException; +import uk.org.ury.common.protocol.exceptions.InvalidMessageException; + +/** + * 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 + * + */ + +public class ProtocolUtils { + /** + * 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. + * + * @param items + * The key-value map of items, which should contain strings, + * lists and maps. The keys of any map should be protocol + * directives. + * + * @return A string containing the encoded representation of the map. + */ + public static String encode(Map items) { + return JSONValue.toJSONString(items); + } + + /** + * Decode a protocol string into a key-value map. + * + * @param string + * The string to decode. + * + * @return A key-value map mapping directives to strings, lists and maps. + * + * @throws DecodeFailureException + * if the decoding engine returns something other than a map. + */ + public static Map decode(String string) throws DecodeFailureException { + Object result = JSONValue.parse(string); + + if (result instanceof JSONObject) + return (JSONObject) result; + else + throw new DecodeFailureException("Result not a map."); + } + + /** + * Check if a response is flagged as having OK status. + * + * @param response + * The response message, as a key-value map (eg in decoded + * format). + * + * @return 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). + */ + public static boolean responseIsOK(Map response) + throws InvalidMessageException { + if (response.containsKey(Directive.STATUS.toString()) == false) + throw new InvalidMessageException("No status line in response."); + + if ((response.get(Directive.STATUS.toString()) instanceof String) == false) + throw new InvalidMessageException("Status is not a string."); + + return (((String) response.get(Directive.STATUS.toString())) + .equals(Status.OK.toString())); + } +} diff --git a/src/uk/org/ury/common/protocol/Status.java b/src/uk/org/ury/common/protocol/Status.java new file mode 100644 index 0000000..b424fc9 --- /dev/null +++ b/src/uk/org/ury/common/protocol/Status.java @@ -0,0 +1,17 @@ +/** + * + */ +package uk.org.ury.common.protocol; + + +/** + * Statuses that can follow the STATUS directory. + * + * @author Matt Windsor + */ + +public enum Status + { + OK, // The request was processed OK; response should be valid + ERROR // An error occurred; message provided as REASON directive + } diff --git a/src/uk/org/ury/common/protocol/exceptions/DecodeFailureException.java b/src/uk/org/ury/common/protocol/exceptions/DecodeFailureException.java new file mode 100644 index 0000000..978ca7b --- /dev/null +++ b/src/uk/org/ury/common/protocol/exceptions/DecodeFailureException.java @@ -0,0 +1,32 @@ +/** + * + */ +package uk.org.ury.common.protocol.exceptions; + + +/** + * Exception thrown when the protocol decoder fails. + * + * @author Matt Windsor + */ + +public class DecodeFailureException extends Exception +{ + /** + * + */ + private static final long serialVersionUID = -3972492943653273528L; + + + /** + * Construct a new DecodeFailureException with a reason. + * + * @param reason The reason for throwing the exception. + */ + + public + DecodeFailureException (String reason) + { + super (reason); + } +} diff --git a/src/uk/org/ury/common/protocol/exceptions/InvalidMessageException.java b/src/uk/org/ury/common/protocol/exceptions/InvalidMessageException.java new file mode 100644 index 0000000..739b501 --- /dev/null +++ b/src/uk/org/ury/common/protocol/exceptions/InvalidMessageException.java @@ -0,0 +1,33 @@ +/** + * + */ +package uk.org.ury.common.protocol.exceptions; + + +/** + * Generic exception thrown when a protocol function cannot process a + * message due to an issue with the message. + * + * @author Matt Windsor + */ + +public class InvalidMessageException extends Exception +{ + /** + * + */ + private static final long serialVersionUID = -3972492943653273528L; + + + /** + * Construct a new InvalidMessageException with a reason. + * + * @param reason The reason for throwing the exception. + */ + + public + InvalidMessageException (String reason) + { + super (reason); + } +} diff --git a/src/uk/org/ury/common/show/ShowChannel.java b/src/uk/org/ury/common/show/ShowChannel.java new file mode 100644 index 0000000..1c1b8ce --- /dev/null +++ b/src/uk/org/ury/common/show/ShowChannel.java @@ -0,0 +1,120 @@ +/* + * ShowChannel.java + * ------------------ + * + * Part of the URY Presentation Suite + * + * V0.00 2011/03/21 + * + * (C) 2011 URY Computing + */ + +package uk.org.ury.common.show; + +import java.util.ArrayList; +import java.util.List; + +import javax.swing.AbstractListModel; + +import uk.org.ury.common.show.item.ShowItem; + +/** + * A channel of ShowItems in a show. + * + * @author Matt Windsor + */ +public class ShowChannel extends AbstractListModel { + /** + * + */ + private static final long serialVersionUID = -4651104185166068150L; + + /* Items enqueued in channel. */ + private List items; + + /** + * Constructs a new, empty channel. + */ + public ShowChannel() { + items = new ArrayList(); + } + + /** + * Adds a new item to the channel. + * + * @param index + * The position at which to add the item. + * + * @param item + * The new item to add. + * + * @throws IllegalArgumentException + * if the item is null, the index is negative or the index is + * out of bounds. + */ + public void add(int index, ShowItem item) { + if (item == null) + throw new IllegalArgumentException("Item is null."); + + if (index < 0 || index >= items.size()) + throw new IllegalArgumentException("Index " + index + + " out of bounds."); + + items.add(index, item); + fireIntervalAdded(this, index, index); + } + + /** + * Adds a new item to the end of the channel. + * + * @param item + * The new item to add. + */ + public void add(ShowItem item) { + if (item == null) + throw new IllegalArgumentException("Item is null."); + + items.add(item); + fireIntervalAdded(this, items.size() - 1, items.size() - 1); + } + + /** + * Retrieves an item from the channel. + * + * @param index + * The index of the item to retrieve from the channel. + * + * @return the item at the given index in the list. + * + * @throws IllegalArgumentException + * if the index is negative or overflowing. + */ + public ShowItem get(int index) { + if (index < 0 || index >= items.size()) + throw new IllegalArgumentException("Index " + index + + " out of bounds."); + + return items.get(index); + } + + /** + * List model retrieval wrapper for get. + * + * @param index + * The index of the item to retrieve from the channel. + * + * @return the item at the given index in the list. + */ + @Override + public Object getElementAt(int index) { + return get(index); + } + + /** + * @return the size of the list. + */ + @Override + public int getSize() { + return items.size(); + } +} diff --git a/src/uk/org/ury/common/show/ShowUtils.java b/src/uk/org/ury/common/show/ShowUtils.java new file mode 100644 index 0000000..a806d8f --- /dev/null +++ b/src/uk/org/ury/common/show/ShowUtils.java @@ -0,0 +1,190 @@ +/* + * ShowUtils.java + * ------------------ + * + * Part of the URY Backend Platform + * + * V0.00 2011/03/21 + * + * (C) 2011 URY Computing + */ + +package uk.org.ury.common.show; + +import java.sql.ResultSet; +import java.sql.SQLException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.ResourceBundle; + +import uk.org.ury.backend.database.DatabaseDriver; +import uk.org.ury.backend.database.exceptions.QueryFailureException; +import uk.org.ury.common.show.item.ShowItem; +import uk.org.ury.common.show.item.ShowItemProperty; + + +/** + * A set of common utility routines to facilitate the extraction of show items + * from the show storage areas of the URY database. + * + * @author Matt Windsor + */ +public class ShowUtils { + /** + * The number of channels reserved for show items. + * + * TODO: move this somewhere more appropriate. + */ + public static final int NUM_CHANNELS = 3; + + // Maximum number of results to pull from database + private static final int MAX_RESULTS = 50; + + // Resource bundle (for exception reasons) + private static ResourceBundle rb = ResourceBundle.getBundle(ShowUtils.class + .getPackage().getName() + ".ShowUtils"); + + /** + * Return the names of the public track folders, or "bins". + * + * @param db + * The database to query. + * + * @return a list of the public folder names. The list may be empty. + * + * @throws IllegalArgumentException + * if the database is null, the show ID is negative or the + * channel index falls out of bounds. + * + * @throws QueryFailureException + * if the database backend yielded an error while executing the + * search query. + */ + public static List getPublicFolders(DatabaseDriver db) + throws QueryFailureException { + if (db == null) + throw new IllegalArgumentException( + rb.getString("ERR_DB_HANDLE_IS_NULL")); + + List results = new ArrayList(); + + ResultSet rs = null; + + try { + rs = db.executeQuery("SELECT share AS name, description" + + " FROM baps_filefolder" + " WHERE baps_filefolder.public" + + " = TRUE" + " ORDER BY filefolderid ASC", MAX_RESULTS); + } catch (SQLException e1) { + throw new QueryFailureException(e1.getMessage()); + } + + try { + while (rs.next()) { + results.add(rs.getString(2)); + } + } catch (SQLException e) { + throw new QueryFailureException(e.getMessage()); + } + + return results; + } + + /** + * Given a show and a channel, retrieve a list of all show items bound to + * that channel for the show. + * + * @param db + * The database to query. + * + * @param showID + * The unique number that identifies the show. + * + * @param channel + * The index of the channel to query. + * + * @return a list of ShowItems extracted from the show and channel. The list + * may be empty. + * + * @throws IllegalArgumentException + * if the database is null, the show ID is negative or the + * channel index falls out of bounds. + * + * @throws QueryFailureException + * if the database backend yielded an error while executing the + * search query. + */ + public static List getChannelList(DatabaseDriver db, int showID, + int channel) throws QueryFailureException { + if (db == null) + throw new IllegalArgumentException( + rb.getString("ERR_DB_HANDLE_IS_NULL")); + + if (showID < 0) + throw new IllegalArgumentException( + rb.getString("ERR_NEGATIVE_SHOW_ID")); + + if (channel < 0 || channel >= NUM_CHANNELS) + throw new IllegalArgumentException( + rb.getString("ERR_CH_OUT_OF_BOUNDS")); + + List results = new ArrayList(); + + ResultSet rs = null; + + Object[] params = { showID, channel }; + + try { + rs = db.executeQuery("SELECT name1, name2, position" + + " FROM baps_show" + " INNER JOIN baps_listing" + + " ON baps_show.showid" + + " = baps_listing.showid" + + " INNER JOIN baps_item" + + " ON baps_listing.listingid" + + " = baps_item.listingid" + + " WHERE baps_show.showid" + + " = ?" + + " AND baps_listing.channel" + + " = ?" + + " ORDER BY position ASC", params, MAX_RESULTS); + } catch (SQLException e) { + throw new QueryFailureException(e.getMessage()); + } + + try { + while (rs.next()) { + results.add(translateRow(rs)); + } + } catch (SQLException e) { + throw new QueryFailureException(e.getMessage()); + } + return results; + } + + /** + * Translate a row retrieved from the database into a ShowItem. + * + * @param rs + * The result-set, or database cursor, pointing to the row to + * translate. + * + * @return A new ShowItem containing the properties extracted from the + * translated row. + */ + private static ShowItem translateRow(ResultSet rs) { + // Translate SQL columns into a list of properties. + + HashMap properties = new HashMap(); + + for (ShowItemProperty p : ShowItemProperty.values()) { + try { + properties.put(p, rs.getString(p.sql)); + } catch (SQLException e) { + // Ignore this, as it is almost certainly just a non-existent + // property. + } + } + + return new ShowItem(properties); + } +} \ No newline at end of file diff --git a/src/uk/org/ury/common/show/ShowUtils.properties b/src/uk/org/ury/common/show/ShowUtils.properties new file mode 100644 index 0000000..7f8a2fa --- /dev/null +++ b/src/uk/org/ury/common/show/ShowUtils.properties @@ -0,0 +1,4 @@ +// Exceptions +ERR_DB_HANDLE_IS_NULL = "Database handle is null." +ERR_NEGATIVE_SHOW_ID = "Show ID is negative." +ERR_CH_OUT_OF_BOUNDS = Channel index is out of bounds." \ No newline at end of file diff --git a/src/uk/org/ury/common/show/item/ShowItem.java b/src/uk/org/ury/common/show/item/ShowItem.java new file mode 100644 index 0000000..d1d1be1 --- /dev/null +++ b/src/uk/org/ury/common/show/item/ShowItem.java @@ -0,0 +1,68 @@ +/** + * + */ +package uk.org.ury.common.show.item; + + +import java.util.Map; + +import uk.org.ury.backend.database.DatabaseItem; +import uk.org.ury.backend.database.exceptions.MissingPropertyException; + + +/** + * An item in the show database. + * + * @author Matt Windsor + */ + +public class ShowItem extends DatabaseItem +{ + /** + * Construct a new ShowItem. + * + * @param properties The map of properties to store in the show item. + */ + + public + ShowItem (Map properties) + { + super (properties); + } + + + /** + * @return a string representation of the ShowItem. + */ + + @Override + public String + toString () + { + String name1; + String name2; + + try + { + name1 = get (ShowItemProperty.NAME1); + } + catch (MissingPropertyException e1) + { + name1 = "Unknown"; + } + + try + { + name2 = get (ShowItemProperty.NAME2); + } + catch (MissingPropertyException e2) + { + name2 = null; + } + + if (name2 != null) + return name1 + " - " + name2; + else + return name1; + } +} diff --git a/src/uk/org/ury/common/show/item/ShowItemProperty.java b/src/uk/org/ury/common/show/item/ShowItemProperty.java new file mode 100644 index 0000000..43d4e99 --- /dev/null +++ b/src/uk/org/ury/common/show/item/ShowItemProperty.java @@ -0,0 +1,26 @@ +package uk.org.ury.common.show.item; + + +/** + * Enumeration of the parameters that are stored in a ShowItem. + * + * @author Matt Windsor + */ + +public enum ShowItemProperty + { + // Constant SQL identifier + NAME1 ("name1"), + NAME2 ("name2"), + POSITION ("positionid"); + + + public final String sql; + + + private + ShowItemProperty (String sql) + { + this.sql = sql; + } + }; \ No newline at end of file diff --git a/src/uk/org/ury/common/show/item/package.html b/src/uk/org/ury/common/show/item/package.html new file mode 100644 index 0000000..0b2af5a --- /dev/null +++ b/src/uk/org/ury/common/show/item/package.html @@ -0,0 +1,14 @@ + + + + + uk.org.ury.show.item + + +

    The show item class and related properties.

    +

    The two contained classes, ShowItem and ShowItemProperty, + implement the storage of items (songs, audio tracks, etc) that + can be placed in show channels.

    + + \ No newline at end of file diff --git a/src/uk/org/ury/config/Auth.java b/src/uk/org/ury/config/Auth.java deleted file mode 100644 index 81be6e2..0000000 --- a/src/uk/org/ury/config/Auth.java +++ /dev/null @@ -1,36 +0,0 @@ -package uk.org.ury.config; - -/** - * A login authorisation configuration - * - * @author Nathan Lasseter - */ -public class Auth { - - private String user; - private String pass; - - /** - * Get the username of the login - * - * @return String username - */ - public String getUser() { return user; } - /** - * Get the password of the login - * - * @return String password - */ - public String getPass() { return pass; } - - /** - * Create a login auth object - * @param user The username for the login - * @param pass The password for the login - */ - public Auth(String user, String pass) { - this.user = user; - this.pass = pass; - } - -} \ No newline at end of file diff --git a/src/uk/org/ury/config/ConfigReader.java b/src/uk/org/ury/config/ConfigReader.java deleted file mode 100644 index ed2d852..0000000 --- a/src/uk/org/ury/config/ConfigReader.java +++ /dev/null @@ -1,115 +0,0 @@ -package uk.org.ury.config; - -import javax.xml.parsers.DocumentBuilder; -import javax.xml.parsers.DocumentBuilderFactory; - -import org.w3c.dom.Document; -import org.w3c.dom.Element; -import org.w3c.dom.Node; -import org.w3c.dom.NodeList; -import org.xml.sax.SAXException; -import org.xml.sax.SAXParseException; - -import uk.org.ury.database.exceptions.MissingCredentialsException; - -/** - * Reads in an XML config file and creates config objects - * - * @author Nathan Lasseter - */ -public class ConfigReader { - - private Database database = null; - private Auth roAuth = null; - private Auth rwAuth = null; - - /** - * Get the database configuration - * - * @return Database database - */ - public Database getDatabase() { return database; } - /** - * Get the read only login auth configuration - * - * @return Auth roAauth - */ - public Auth getRoAuth() { return roAuth; } - /** - * Get the read write login auth configuration - * - * @return Auth rwAauth - */ - public Auth getRwAuth() { return rwAuth; } - - /** - * Read in the config file and create the Database and Auth configuration objects. - * Specify a config file. - * @throws MissingCredentialsException - */ - public ConfigReader(String configFile) throws MissingCredentialsException { - - try { - DocumentBuilderFactory docBuilderFactory = DocumentBuilderFactory.newInstance(); - DocumentBuilder docBuilder = docBuilderFactory.newDocumentBuilder(); - Document doc = docBuilder.parse (configFile); - doc.getDocumentElement().normalize(); - - NodeList nList = doc.getElementsByTagName("auth"); - for(int i = 0; i < nList.getLength(); i++) { - Node nNode = nList.item(i); - if(nNode.getNodeType() == Node.ELEMENT_NODE) { - Element eElement = (Element) nNode; - String user = getTagValue("user", eElement); - String pass = getTagValue("pass", eElement); - String sType = getTagValue("type", eElement); - if(sType.equalsIgnoreCase("read_only")) { - if(roAuth != null) continue; - roAuth = new Auth(user, pass); - } else if(sType.equalsIgnoreCase("read_write")) { - if(rwAuth != null) continue; - rwAuth = new Auth(user, pass); - } else { - throw new IllegalArgumentException("Unused user class."); - } - } - } - - nList = doc.getElementsByTagName("database"); - for(int i = 0; i < nList.getLength(); i++) { - if(database != null) break; - Node nNode = nList.item(i); - if(nNode.getNodeType() == Node.ELEMENT_NODE) { - Element eElement = (Element) nNode; - String host = getTagValue("host", eElement); - String port = getTagValue("port", eElement); - String db = getTagValue("db", eElement); - database = new Database(host, Integer.parseInt(port.trim()), db); - } - } - } - - catch(NullPointerException n) { - throw new MissingCredentialsException("An element node is empty."); - } - - catch (SAXParseException err) { - System.out.println ("** Parsing error" + ", line " + err.getLineNumber () + ", uri " + err.getSystemId ()); - System.out.println(" " + err.getMessage ()); - } - catch (SAXException e) { - Exception x = e.getException (); - ((x == null) ? e : x).printStackTrace (); - } - catch (Throwable t) { - t.printStackTrace (); - } - } - - private static String getTagValue(String sTag, Element eElement){ - NodeList nlList= eElement.getElementsByTagName(sTag).item(0).getChildNodes(); - Node nValue = (Node) nlList.item(0); - - return nValue.getNodeValue(); - } -} diff --git a/src/uk/org/ury/config/Database.java b/src/uk/org/ury/config/Database.java deleted file mode 100644 index 19fe9bc..0000000 --- a/src/uk/org/ury/config/Database.java +++ /dev/null @@ -1,45 +0,0 @@ -package uk.org.ury.config; - -/** - * A Database Server configuration - * - * @author Nathan Lasseter - */ -public class Database { - - private String host; - private int port; - private String db; - - /** - * Get the hostname of the database server - * - * @return String hostname - */ - public String getHost() { return host; } - /** - * Get the port the database server is running on - * - * @return int port - */ - public int getPort() { return port; } - /** - * Get the name of the database - * - * @return String database name - */ - public String getDb() { return db; } - - /** - * Create a database object - * @param host The hostname of the database server - * @param port The port that the database server listens on - * @param db The name of the database on the server - */ - public Database(String host, int port, String db) { - this.host = host; - this.port = port; - this.db = db; - } - -} \ No newline at end of file diff --git a/src/uk/org/ury/database/DatabaseDriver.java b/src/uk/org/ury/database/DatabaseDriver.java deleted file mode 100644 index e48b0a1..0000000 --- a/src/uk/org/ury/database/DatabaseDriver.java +++ /dev/null @@ -1,166 +0,0 @@ -package uk.org.ury.database; - -import java.sql.Connection; -import java.sql.DriverManager; -import java.sql.PreparedStatement; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Statement; - -import uk.org.ury.config.ConfigReader; -import uk.org.ury.database.exceptions.ConnectionFailureException; -import uk.org.ury.database.exceptions.MissingCredentialsException; - -/** - * A database connection manager that connects to the URY databases using - * suitably privileged accounts, and handles the processing of SQL queries. - * - * @author Matt Windsor - * @author Nathan Lasseter - * - */ -public class DatabaseDriver { - /* The JDBC path used to connect to the URY database. */ - private String DATABASE_PATH = "jdbc:postgresql://"; - - /* The database connection. */ - private Connection conn; - - /** - * Construct a new DatabaseDriver with the given user class. - * - * @param config - * The config with login details. - * - * @param type - * The user class to log in to the database with. - * - * @throws IllegalArgumentException - * if the user class is not supported (this should not happen). - * - * @throws MissingCredentialsException - * if the user class login credentials could not be loaded. - * - * @throws ConnectionFailureException - * if the database backend failed to connect to the database - * server. - */ - public DatabaseDriver(ConfigReader config, UserClass type) - throws MissingCredentialsException, ConnectionFailureException { - try { - connect(config, type); - } catch (SQLException e) { - throw new ConnectionFailureException(e.getMessage()); - } - - } - - /** - * Connect to the URY database. - * - * @param config - * The config to use for the connection. - * @param type - * The access level of the connection - * - * @throws SQLException - * if the database connection failed. - */ - private void connect(ConfigReader config, UserClass type) - throws SQLException { - if (config == null) - throw new IllegalArgumentException("Supplied null config."); - - if (config.getDatabase().getHost() == null) - throw new IllegalArgumentException("config has no associated host."); - - if (config.getDatabase().getDb() == null) - throw new IllegalArgumentException( - "config has no associated database."); - - DATABASE_PATH = DATABASE_PATH + config.getDatabase().getHost() + "/" - + config.getDatabase().getDb(); - - if (type == UserClass.READ_ONLY) { - if (config.getRoAuth().getUser() == null) - throw new IllegalArgumentException( - "config has no associated username."); - if (config.getRoAuth().getPass() == null) - throw new IllegalArgumentException( - "config has no associated password."); - conn = DriverManager.getConnection(DATABASE_PATH, config - .getRoAuth().getUser(), config.getRoAuth().getPass()); - } else if (type == UserClass.READ_WRITE) { - if (config.getRwAuth().getUser() == null) - throw new IllegalArgumentException( - "config has no associated username."); - if (config.getRwAuth().getPass() == null) - throw new IllegalArgumentException( - "config has no associated password."); - conn = DriverManager.getConnection(DATABASE_PATH, config - .getRwAuth().getUser(), config.getRwAuth().getPass()); - } - } - - /** - * Execute an unprepared SQL statement with no arguments. - * - * @param sql - * The SQL statement to execute. - * @param fetchSize - * The maximum number of query rows to return. - * - * @return the JDBC results set. - * - * @throws SQLException - * if a SQL error occurs. - */ - public ResultSet executeQuery(String sql, int fetchSize) - throws SQLException { - Statement st = conn.createStatement(); - st.setFetchSize(fetchSize); - - return st.executeQuery(sql); - } - - /** - * Perform a SQL statement with arguments. - * - * This accepts an array of parameter objects, which must each either be - * String or Integer objects. The objects will be used sequentially to fill - * in '?' placeholders in the query text. - * - * @param sql - * The SQL statement to execute. - * @param params - * A list of parameter objects. - * @param fetchSize - * The maximum number of query rows to return. - * - * @return the set of results from the query. - * - * @throws IllegalArgumentException - * if any of the parameters is unsupported by the database as a - * statement parameter. - * - * @throws SQLException - * if a SQL error occurs. - */ - public ResultSet executeQuery(String sql, Object[] params, int fetchSize) - throws SQLException { - PreparedStatement st = conn.prepareStatement(sql); - - st.setFetchSize(fetchSize); - - for (int i = 0; i < params.length; i++) - if (params[i] instanceof String) - st.setString(i + 1, (String) params[i]); - else if (params[i] instanceof Integer) - st.setInt(i + 1, (Integer) params[i]); - else - throw new IllegalArgumentException("Unsupported parameter #" - + (i + 1)); - - return st.executeQuery(); - } -} diff --git a/src/uk/org/ury/database/DatabaseItem.java b/src/uk/org/ury/database/DatabaseItem.java deleted file mode 100644 index bac23a5..0000000 --- a/src/uk/org/ury/database/DatabaseItem.java +++ /dev/null @@ -1,80 +0,0 @@ -package uk.org.ury.database; - -import java.util.HashMap; -import java.util.Map; - -import uk.org.ury.database.exceptions.MissingPropertyException; - -/** - * An abstract class presenting a template for objects serving as a data - * structure for collections of properties retrieved from a SQL database. - * - * @param E - * The enumeration type used as the property list. - * - * @param T - * The type of datum stored for each property. - * - * @author Matt Windsor - */ -public abstract class DatabaseItem { - private Map properties; - - /** - * Construct a new item from an existing list of properties. - * - * @param properties - * The map of properties that the new item will inherit. - */ - public DatabaseItem(Map properties) { - this.properties = properties; - } - - /** - * Check whether a property has been set in the item. - * - * @return true if the property has been set; false otherwise. - */ - - public boolean has(E property) { - return properties.containsKey(property); - } - - /** - * Query this item for a property. - * - * @param property - * The property to query. - * - * @return The property, if it exists. - * - * @throws MissingPropertyException - * if the property does not exist. - */ - public T get(E property) throws MissingPropertyException { - if (properties.containsKey(property)) - return properties.get(property); - else - throw new MissingPropertyException(property.toString()); - } - - /** - * Retrieve a map of string representations of the properties. - * - * This relies on E and T having meaningful toString methods. - * - * @return a list of lines representing the response. - */ - public Map asResponse() { - // TODO: Fan out implementation details into separate class - Map response = new HashMap(); - - for (E property : properties.keySet()) { - if (properties.get(property) != null) - response.put(property.toString(), properties.get(property) - .toString()); - } - - return response; - } -} diff --git a/src/uk/org/ury/database/UserClass.java b/src/uk/org/ury/database/UserClass.java deleted file mode 100644 index 48cb2d3..0000000 --- a/src/uk/org/ury/database/UserClass.java +++ /dev/null @@ -1,38 +0,0 @@ -/** - * - */ -package uk.org.ury.database; - -/** - * The various user classes of the database driver. - * - * These refer to various users in the database proper, and thus grant various - * levels of permission to the program. - * - * Please use the least privileged user class that works. For most cases, - * READ_ONLY should work perfectly. - * - * @author Matt Windsor - * - */ - -public enum UserClass { - // Constant configName - READ_ONLY ("read_only"), - READ_WRITE ("read_write"); - - /** - * The name of the tag in the configuration file that contains the - * credentials for this user class. - */ - public String configName; - - /** - * Constructs a new UserClass. - * - * @param configName The name of the user class in the config. - */ - private UserClass(String configName) { - this.configName = configName; - } -} diff --git a/src/uk/org/ury/database/exceptions/ConnectionFailureException.java b/src/uk/org/ury/database/exceptions/ConnectionFailureException.java deleted file mode 100644 index 030b24f..0000000 --- a/src/uk/org/ury/database/exceptions/ConnectionFailureException.java +++ /dev/null @@ -1,44 +0,0 @@ -/** - * - */ -package uk.org.ury.database.exceptions; - -/** - * Exception thrown when the database backend fails to connect to - * the database server, in absence of a more specific exception. - * - * @author Matt Windsor - */ - -public class ConnectionFailureException extends Exception -{ - /** - * - */ - private static final long serialVersionUID = -7353531873142099828L; - - -/** - * Construct a new ConnectionFailureException with a - * default reason. - */ - - public - ConnectionFailureException () - { - super ("Connection failure."); - } - - - /** - * Construct a new ConnectionFailureException. - * - * @param reason The explanation for the exception. - */ - - public - ConnectionFailureException (String reason) - { - super (reason); - } -} diff --git a/src/uk/org/ury/database/exceptions/MissingCredentialsException.java b/src/uk/org/ury/database/exceptions/MissingCredentialsException.java deleted file mode 100644 index 2e45526..0000000 --- a/src/uk/org/ury/database/exceptions/MissingCredentialsException.java +++ /dev/null @@ -1,52 +0,0 @@ -/** - * - */ -package uk.org.ury.database.exceptions; - -/** - * Exception thrown when the database credentials required to - * log into the URY database under a user class are missing, - * and thus the log-in cannot continue. - * - * The best practice for handling a MissingCredentialsException - * is to attempt to log into the database with a less privileged - * user class or, if the credentials for read-only access are - * missing, give up. - * - * @author Matt Windsor - */ - -public class MissingCredentialsException extends Exception -{ - - /** - * - */ - - private static final long serialVersionUID = -397479334359858162L; - - - /** - * Construct a new MissingCredentialsException with a - * default reason. - */ - - public - MissingCredentialsException () - { - super ("Missing credentials."); - } - - - /** - * Construct a new MissingCredentialsException. - * - * @param reason The explanation for the exception. - */ - - public - MissingCredentialsException (String reason) - { - super (reason); - } -} diff --git a/src/uk/org/ury/database/exceptions/MissingPropertyException.java b/src/uk/org/ury/database/exceptions/MissingPropertyException.java deleted file mode 100644 index 3766fcf..0000000 --- a/src/uk/org/ury/database/exceptions/MissingPropertyException.java +++ /dev/null @@ -1,47 +0,0 @@ -/** - * - */ -package uk.org.ury.database.exceptions; - - -/** - * Exception thrown when a DatabaseItem is queried for a property - * that does not exist. - * - * This is (usually) not a fatal error. - * - * @author Matt Windsor - */ - -public class MissingPropertyException extends Exception -{ - /** - * - */ - private static final long serialVersionUID = -7353531873142099828L; - - -/** - * Construct a new MissingPropertyException with a - * default reason. - */ - - public - MissingPropertyException () - { - super ("Query failure."); - } - - - /** - * Construct a new MissingPropertyException. - * - * @param reason The explanation for the exception. - */ - - public - MissingPropertyException (String reason) - { - super (reason); - } -} diff --git a/src/uk/org/ury/database/exceptions/QueryFailureException.java b/src/uk/org/ury/database/exceptions/QueryFailureException.java deleted file mode 100644 index 5293a7c..0000000 --- a/src/uk/org/ury/database/exceptions/QueryFailureException.java +++ /dev/null @@ -1,45 +0,0 @@ -/** - * - */ -package uk.org.ury.database.exceptions; - - -/** - * Exception thrown when the database backend fails to execute - * a query. - * - * @author Matt Windsor - */ - -public class QueryFailureException extends Exception -{ - /** - * - */ - private static final long serialVersionUID = -7353531873142099828L; - - -/** - * Construct a new QueryFailureException with a - * default reason. - */ - - public - QueryFailureException () - { - super ("Query failure."); - } - - - /** - * Construct a new QueryFailureException. - * - * @param reason The explanation for the exception. - */ - - public - QueryFailureException (String reason) - { - super (reason); - } -} diff --git a/src/uk/org/ury/database/exceptions/package.html b/src/uk/org/ury/database/exceptions/package.html deleted file mode 100644 index b5e7cac..0000000 --- a/src/uk/org/ury/database/exceptions/package.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - - uk.org.ury.database.exceptions - - -

    Exceptions thrown by the database services classes.

    - - \ No newline at end of file diff --git a/src/uk/org/ury/database/package.html b/src/uk/org/ury/database/package.html deleted file mode 100644 index 2b138b8..0000000 --- a/src/uk/org/ury/database/package.html +++ /dev/null @@ -1,15 +0,0 @@ - - - - - uk.org.ury.database - - -

    Database services for the URY Presenter Suite.

    -

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

    - - \ No newline at end of file diff --git a/src/uk/org/ury/frontend/FrontendApplet.java b/src/uk/org/ury/frontend/FrontendApplet.java index 8e0e229..375a260 100644 --- a/src/uk/org/ury/frontend/FrontendApplet.java +++ b/src/uk/org/ury/frontend/FrontendApplet.java @@ -11,7 +11,7 @@ import javax.swing.UIManager; import javax.swing.UnsupportedLookAndFeelException; import uk.org.ury.frontend.exceptions.LoadFailureException; -import uk.org.ury.testrig.Launcher; +import uk.org.ury.frontend.testrig.Launcher; /** * A frame that hosts a FrontendModulePanel, used for serving frontend panels in diff --git a/src/uk/org/ury/frontend/FrontendFrame.java b/src/uk/org/ury/frontend/FrontendFrame.java index 1683c9b..24a12cb 100644 --- a/src/uk/org/ury/frontend/FrontendFrame.java +++ b/src/uk/org/ury/frontend/FrontendFrame.java @@ -14,330 +14,270 @@ import javax.swing.UnsupportedLookAndFeelException; import uk.org.ury.frontend.exceptions.LoadFailureException; /** - * 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). * * @author Matt Windsor - * + * */ -public class FrontendFrame extends JFrame implements FrontendMaster -{ - /** - * - */ - - private static final long serialVersionUID = 740928181256928433L; - - private FrontendBanner banner; - private FrontendModulePanel child; - private FrontendControlPanel cpanel; - - - /** - * 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. - * - * @param moduleName The fully qualified class-name of the module, - * minus the leading "uk.org.ury." domain. - */ - - public - FrontendFrame (String moduleName) - { - super ("URY newBAPS"); - try - { - loadModule (moduleName); - } - catch (LoadFailureException e) - { - fatalError (e.getMessage ()); - } - } - - - /** - * Set up the user interface of the frame. - */ - - public void - setupUI () - { - try - { - // Set System L&F - UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName ()); - } - catch (UnsupportedLookAndFeelException e) - { - // handle exception - } - catch (ClassNotFoundException e) - { - // handle exception - } - catch (InstantiationException e) - { - // handle exception - } - catch (IllegalAccessException e) - { - // handle exception - } - - setDefaultCloseOperation (JFrame.EXIT_ON_CLOSE); - - Container cp = getContentPane (); - - // Banner - System.out.println (child); - banner = new FrontendBanner (child.getModuleName ()); - - // Composition - - cp.add (banner, BorderLayout.NORTH); - cp.add (child, BorderLayout.CENTER); - - setPreferredSize (new Dimension (800, 600)); - setMinimumSize (new Dimension (800, 600)); - - pack (); - setVisible (true); - } - - - /** - * 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. - * - * @param 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. - */ - - @Override - public void - loadModule (String moduleName) - throws LoadFailureException - { - Class moduleClass = null; - - try - { - moduleClass = Class.forName ("uk.org.ury." + moduleName); - } - catch (ClassNotFoundException e) - { - throw new LoadFailureException ("Could not load module: " - + e.getMessage ()); - } - - - if (FrontendModule.class.isAssignableFrom (moduleClass) == false) - { - throw new LoadFailureException ("Could not load module: Not a FrontendModule"); - } - else - { - FrontendModulePanel temp = child; - - try - { - child = ((FrontendModule) moduleClass.newInstance ()).runFrontend (this); - } - catch (InstantiationException e) - { - throw new LoadFailureException ("Could not load module: " - + e.getMessage ()); - } - catch (IllegalAccessException e) - { - throw new LoadFailureException ("Could not load module: " - + e.getMessage ()); - } - - if (temp != null) - remove (temp); - - add (child); - child.setMaster (this); - - if (banner != null) - banner.setTitle (child.getModuleName ()); - - pack (); - } - } - - - /** - * 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. - * - * @param moduleName The fully qualified class-name of the module, - * minus the leading "uk.org.ury." domain. - * - * @param 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. - */ - - @Override - public void - loadModule (String moduleName, String cPanelName) - throws LoadFailureException - { - FrontendModulePanel newParent = child; - loadModule (moduleName); - FrontendModulePanel newChild = child; - - loadControlPanel (cPanelName, newParent, newChild); - } - - - /** - * Load and install a control panel class given the class name. - * - * @param cPanelName The fully qualified class-name of the control - * panel to load, minus the leading - * "uk.org.ury." domain. - * - * @param parent The parent panel in the relationship modelled - * by the control panel interface. - * - * @param child The child panel in the relationship modelled - * by the control panel interface. - * - * @throws LoadFailureException if the class is - * not found, or is not an implementor of - * FrontendControlPanel. - */ - - private void - loadControlPanel (String cPanelName, FrontendModulePanel parent, - FrontendModulePanel child) - throws LoadFailureException - { - Class cPanelClass = null; - - try - { - cPanelClass = Class.forName ("uk.org.ury." + cPanelName); - } - catch (ClassNotFoundException e) - { - throw new LoadFailureException ("Could not load control panel: " - + e.getMessage ()); - } - - - if (FrontendControlPanel.class.isAssignableFrom (cPanelClass)) - { - FrontendControlPanel temp = cpanel; - - try - { - cpanel = ((FrontendControlPanel) cPanelClass.newInstance ()); - } - catch (InstantiationException e) - { - throw new LoadFailureException ("Could not load control panel: " - + e.getMessage ()); - } - catch (IllegalAccessException e) - { - throw new LoadFailureException ("Could not load control panel: " - + e.getMessage ()); - } - - if (temp != null) - remove (temp); - - cpanel.setPanels (parent, child); - cpanel.setMaster (this); - cpanel.setPreviousCPanel (temp); - - add (cpanel, BorderLayout.SOUTH); - pack (); - } - } - - - /** - * Restore an existing module and control panel into the frontend - * frame. - * - * @param mpanel The module panel to restore. - * - * @param cpanel The control panel to restore, if any. A null - * value signifies a lack of control panel. - * - * @throws IllegalArgumentException if the mpanel is null. - */ - - @Override - public void - restoreModule (FrontendModulePanel mpanel, - FrontendControlPanel cpanel) - { - if (mpanel == null) - throw new IllegalArgumentException ("mpanel is null."); - - remove (child); - remove (this.cpanel); - - child = mpanel; - add (child); - banner.setTitle (child.getModuleName ()); - - if (cpanel != null) - add (cpanel, BorderLayout.SOUTH); - - this.cpanel = cpanel; - - pack (); - repaint (); - } - - - /** - * Report a fatal error, - * - * @param message The message, eg the exception message, to report - * to the user. - */ - - @Override - public void - fatalError (String message) - { - FrontendError.reportFatal (message, this); - } - - - /** - * @return the resource directory. - */ - - @Override - public String - getResourceDirectory () - { - return "res/"; - } +public class FrontendFrame extends JFrame implements FrontendMaster { + /** + * + */ + private static final long serialVersionUID = 740928181256928433L; + + private FrontendBanner banner; + private FrontendModulePanel child; + private FrontendControlPanel cpanel; + + /** + * 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. + * + * @param moduleName + * The fully qualified class-name of the module, minus the + * leading "uk.org.ury." domain. + */ + public FrontendFrame(String moduleName) { + super("URY newBAPS"); + try { + loadModule(moduleName); + } catch (LoadFailureException e) { + fatalError(e.getMessage()); + } + } + + /** + * Set up the user interface of the frame. + */ + public void setupUI() { + try { + // Set System L&F + UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName()); + } catch (UnsupportedLookAndFeelException e) { + // handle exception + } catch (ClassNotFoundException e) { + // handle exception + } catch (InstantiationException e) { + // handle exception + } catch (IllegalAccessException e) { + // handle exception + } + + setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); + + Container cp = getContentPane(); + + // Banner + System.out.println(child); + banner = new FrontendBanner(child.getModuleName()); + + // Composition + cp.add(banner, BorderLayout.NORTH); + cp.add(child, BorderLayout.CENTER); + + setPreferredSize(new Dimension(800, 600)); + setMinimumSize(new Dimension(800, 600)); + + pack(); + setVisible(true); + } + + /** + * 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. + * + * @param 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. + */ + @Override + public void loadModule(String moduleName) throws LoadFailureException { + Class moduleClass = null; + + try { + moduleClass = Class.forName("uk.org.ury.frontend.modules." + + moduleName); + } catch (ClassNotFoundException e) { + throw new LoadFailureException("Could not load module: " + + e.getMessage()); + } + + if (FrontendModule.class.isAssignableFrom(moduleClass) == false) { + throw new LoadFailureException( + "Could not load module: Not a FrontendModule"); + } else { + FrontendModulePanel temp = child; + + try { + child = ((FrontendModule) moduleClass.newInstance()) + .runFrontend(this); + } catch (InstantiationException e) { + throw new LoadFailureException("Could not load module: " + + e.getMessage()); + } catch (IllegalAccessException e) { + throw new LoadFailureException("Could not load module: " + + e.getMessage()); + } + + if (temp != null) + remove(temp); + + add(child); + child.setMaster(this); + + if (banner != null) + banner.setTitle(child.getModuleName()); + + pack(); + } + } + + /** + * 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. + * + * @param moduleName + * The fully qualified class-name of the module, minus the + * leading "uk.org.ury." domain. + * + * @param 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. + */ + @Override + public void loadModule(String moduleName, String cPanelName) + throws LoadFailureException { + FrontendModulePanel newParent = child; + loadModule(moduleName); + FrontendModulePanel newChild = child; + + loadControlPanel(cPanelName, newParent, newChild); + } + + /** + * Load and install a control panel class given the class name. + * + * @param cPanelName + * The fully qualified class-name of the control panel to load, + * minus the leading "uk.org.ury." domain. + * + * @param parent + * The parent panel in the relationship modelled by the control + * panel interface. + * + * @param child + * The child panel in the relationship modelled by the control + * panel interface. + * + * @throws LoadFailureException + * if the class is not found, or is not an implementor of + * FrontendControlPanel. + */ + private void loadControlPanel(String cPanelName, + FrontendModulePanel parent, FrontendModulePanel child) + throws LoadFailureException { + Class cPanelClass = null; + + try { + cPanelClass = Class.forName("uk.org.ury.frontend.cpanels." + cPanelName); + } catch (ClassNotFoundException e) { + throw new LoadFailureException("Could not load control panel: " + + e.getMessage()); + } + + if (FrontendControlPanel.class.isAssignableFrom(cPanelClass)) { + FrontendControlPanel temp = cpanel; + + try { + cpanel = ((FrontendControlPanel) cPanelClass.newInstance()); + } catch (InstantiationException e) { + throw new LoadFailureException("Could not load control panel: " + + e.getMessage()); + } catch (IllegalAccessException e) { + throw new LoadFailureException("Could not load control panel: " + + e.getMessage()); + } + + if (temp != null) + remove(temp); + + cpanel.setPanels(parent, child); + cpanel.setMaster(this); + cpanel.setPreviousCPanel(temp); + + add(cpanel, BorderLayout.SOUTH); + pack(); + } + } + + /** + * Restore an existing module and control panel into the frontend frame. + * + * @param mpanel + * The module panel to restore. + * + * @param cpanel + * The control panel to restore, if any. A null value signifies a + * lack of control panel. + * + * @throws IllegalArgumentException + * if the mpanel is null. + */ + @Override + public void restoreModule(FrontendModulePanel mpanel, + FrontendControlPanel cpanel) { + if (mpanel == null) + throw new IllegalArgumentException("mpanel is null."); + + remove(child); + remove(this.cpanel); + + child = mpanel; + add(child); + banner.setTitle(child.getModuleName()); + + if (cpanel != null) + add(cpanel, BorderLayout.SOUTH); + + this.cpanel = cpanel; + + pack(); + repaint(); + } + + /** + * Report a fatal error, + * + * @param message + * The message, eg the exception message, to report to the user. + */ + @Override + public void fatalError(String message) { + FrontendError.reportFatal(message, this); + } + + /** + * @return the resource directory. + */ + @Override + public String getResourceDirectory() { + return "res/"; + } } diff --git a/src/uk/org/ury/frontend/FrontendModule.java b/src/uk/org/ury/frontend/FrontendModule.java index 4d1e3bf..8298ac5 100644 --- a/src/uk/org/ury/frontend/FrontendModule.java +++ b/src/uk/org/ury/frontend/FrontendModule.java @@ -4,38 +4,32 @@ package uk.org.ury.frontend; /** - * Interface for all system modules that are to be reachable from - * the frontend array. + * Interface for all system modules that are to be reachable from the frontend + * array. * * Frontend-exposed modules must: * * - be runnable standalone, as either an application or an applet; * - * - contain their user interface in a subclass of FrontendModulePanel - * which can be embedded either in a FrontendFrame, a web page - * or another module; - * + * - contain their user interface in a subclass of FrontendModulePanel which can + * be embedded either in a FrontendFrame, a web page or another module; + * * - use the frontend error reporting systems. * - * An abstract implementation of this interface, - * AbstractFrontendModule, is provided to simplify the creation of - * frontend modules. + * An abstract implementation of this interface, AbstractFrontendModule, is + * provided to simplify the creation of frontend modules. * * @author Matt Windsor - * + * */ - -public interface FrontendModule -{ - /** - * Begin execution of the frontend module. - * - * @param master The FrontendMaster driving the frontend. - * - * @return the frontend panel to insert into the - * FrontendMaster. - */ - - public FrontendModulePanel - runFrontend (FrontendMaster master); +public interface FrontendModule { + /** + * Begin execution of the frontend module. + * + * @param master + * The FrontendMaster driving the frontend. + * + * @return the frontend panel to insert into the FrontendMaster. + */ + public FrontendModulePanel runFrontend(FrontendMaster master); } diff --git a/src/uk/org/ury/frontend/client/Client.java b/src/uk/org/ury/frontend/client/Client.java new file mode 100644 index 0000000..9606d89 --- /dev/null +++ b/src/uk/org/ury/frontend/client/Client.java @@ -0,0 +1,60 @@ +package uk.org.ury.frontend.client; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStreamReader; + +import java.net.MalformedURLException; +import java.net.URL; +import java.net.URLConnection; + +import java.util.Map; + +import uk.org.ury.common.protocol.ProtocolUtils; +import uk.org.ury.common.protocol.exceptions.DecodeFailureException; + +public class Client { + /** + * Get a raw response from the server. + * + * @param file + * The "file", including path and query string, to fetch from the + * server. + * + * @return The response from the server, as a key-value map. + * + * @throws DecodeFailureException + * if the decode failed. + */ + public Map get(String file) throws DecodeFailureException { + URL url = null; + URLConnection uc = null; + String result = ""; + + try { + url = new URL("http://localhost:8000" + file); + } catch (MalformedURLException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + + try { + uc = url.openConnection(); + + BufferedReader in = new BufferedReader(new InputStreamReader( + uc.getInputStream())); + + String inputLine; + + for (inputLine = in.readLine(); inputLine != null; inputLine = in + .readLine()) { + result += inputLine; + } + } catch (IOException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + + return ProtocolUtils.decode(result); + } +} diff --git a/src/uk/org/ury/frontend/client/test/ClientTest.java b/src/uk/org/ury/frontend/client/test/ClientTest.java new file mode 100644 index 0000000..d75a0ac --- /dev/null +++ b/src/uk/org/ury/frontend/client/test/ClientTest.java @@ -0,0 +1,57 @@ +/** + * + */ +package uk.org.ury.frontend.client.test; + +import java.util.Map; + +import junit.framework.Assert; + +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +import uk.org.ury.common.protocol.Directive; +import uk.org.ury.common.protocol.exceptions.DecodeFailureException; +import uk.org.ury.frontend.client.Client; + +/** + * JUnit test for the low-level client logic. + * + * @author Matt Windsor + */ +public class ClientTest { + + /** + * @throws java.lang.Exception + */ + @Before + public void setUp() throws Exception { + } + + /** + * @throws java.lang.Exception + */ + @After + public void tearDown() throws Exception { + } + + /** + * Test method for {@link uk.org.ury.frontend.client.Client#get(java.lang.String)}. + */ + @Test + public void testGet() { + Client client = new Client(); + + Map response = null; + + try { + response = client.get("/server/ServerRequestHandler?function=test"); + } catch (DecodeFailureException e) { + e.printStackTrace(); + } + + Assert.assertEquals("Test succeeded.", + response.get(Directive.INFO.toString())); + } +} diff --git a/src/uk/org/ury/frontend/cpanels/menu/DemoControlPanel.java b/src/uk/org/ury/frontend/cpanels/menu/DemoControlPanel.java new file mode 100644 index 0000000..7ef0907 --- /dev/null +++ b/src/uk/org/ury/frontend/cpanels/menu/DemoControlPanel.java @@ -0,0 +1,47 @@ +package uk.org.ury.frontend.cpanels.menu; + + +import uk.org.ury.frontend.FrontendControlPanel; +import uk.org.ury.frontend.exceptions.UICreationFailureException; + + +/** + * Control panel for the demo system. + * + * @author Matt Windsor + * + */ + +public class DemoControlPanel extends FrontendControlPanel +{ + + /** + * + */ + private static final long serialVersionUID = 7558888612002013312L; + + + /** + * Constructs a new DemoControlPanel. + * + * @throws UICreationFailureException if the UI creation fails. + */ + + public + DemoControlPanel () + throws UICreationFailureException + { + super ("demo_control_panel.xml"); + } + + + /** + * Go back to the previous module. + */ + + public void + back () + { + master.restoreModule (parent, prevCPanel); + } +} diff --git a/src/uk/org/ury/frontend/cpanels/menu/demo_control_panel.xml b/src/uk/org/ury/frontend/cpanels/menu/demo_control_panel.xml new file mode 100644 index 0000000..a9b5329 --- /dev/null +++ b/src/uk/org/ury/frontend/cpanels/menu/demo_control_panel.xml @@ -0,0 +1,7 @@ + + + +