From d547f87da5f68c12dede7c9d45618cae11ff5699 Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Fri, 18 Mar 2011 08:28:09 +0000 Subject: Mega-commit to the rescue! Added Javadoc snapshot (admittedly old); show UI now fixed-layout; UI uses system selection colours for accents; now uses bapsserver password and can thus talk to show database relations; removed member relation dependencies until further notice; attempted to get application and applet launchers working but having issues with the latter; started working on a server communicating via a minimal implementation of HTTP 1.1 (standardisation required eventually). --- Design/roles.dot | 93 ++ Design/roles.dot~ | 17 + Design/roles.eps | 948 ++++++++++++++++++ doc/allclasses-frame.html | 113 +++ doc/allclasses-noframe.html | 113 +++ doc/constant-values.html | 174 ++++ doc/deprecated-list.html | 146 +++ doc/help-doc.html | 223 +++++ doc/index-files/index-1.html | 154 +++ doc/index-files/index-10.html | 185 ++++ doc/index-files/index-11.html | 162 +++ doc/index-files/index-12.html | 145 +++ doc/index-files/index-13.html | 150 +++ doc/index-files/index-14.html | 172 ++++ doc/index-files/index-15.html | 199 ++++ doc/index-files/index-16.html | 148 +++ doc/index-files/index-17.html | 149 +++ doc/index-files/index-18.html | 163 +++ doc/index-files/index-2.html | 148 +++ doc/index-files/index-3.html | 160 +++ doc/index-files/index-4.html | 167 ++++ doc/index-files/index-5.html | 156 +++ doc/index-files/index-6.html | 189 ++++ doc/index-files/index-7.html | 224 +++++ doc/index-files/index-8.html | 152 +++ doc/index-files/index-9.html | 154 +++ doc/index.html | 39 + doc/overview-frame.html | 62 ++ doc/overview-summary.html | 191 ++++ doc/overview-tree.html | 227 +++++ doc/package-list | 11 + doc/resources/inherit.gif | Bin 0 -> 57 bytes doc/serialized-form.html | 1050 ++++++++++++++++++++ doc/stylesheet.css | 29 + doc/uk/org/ury/config/Auth.html | 291 ++++++ doc/uk/org/ury/config/ConfigReader.html | 315 ++++++ doc/uk/org/ury/config/Database.html | 315 ++++++ doc/uk/org/ury/config/class-use/Auth.html | 188 ++++ doc/uk/org/ury/config/class-use/ConfigReader.html | 179 ++++ doc/uk/org/ury/config/class-use/Database.html | 180 ++++ doc/uk/org/ury/config/package-frame.html | 36 + doc/uk/org/ury/config/package-summary.html | 165 +++ doc/uk/org/ury/config/package-tree.html | 153 +++ doc/uk/org/ury/config/package-use.html | 195 ++++ doc/uk/org/ury/database/DatabaseDriver.html | 322 ++++++ doc/uk/org/ury/database/DatabaseItem.html | 299 ++++++ doc/uk/org/ury/database/UserClass.html | 376 +++++++ .../org/ury/database/class-use/DatabaseDriver.html | 221 ++++ .../org/ury/database/class-use/DatabaseItem.html | 209 ++++ doc/uk/org/ury/database/class-use/UserClass.html | 204 ++++ .../exceptions/ConnectionFailureException.html | 269 +++++ .../exceptions/MissingCredentialsException.html | 275 +++++ .../exceptions/MissingPropertyException.html | 271 +++++ .../database/exceptions/QueryFailureException.html | 269 +++++ .../class-use/ConnectionFailureException.html | 179 ++++ .../class-use/MissingCredentialsException.html | 206 ++++ .../class-use/MissingPropertyException.html | 180 ++++ .../class-use/QueryFailureException.html | 279 ++++++ .../org/ury/database/exceptions/package-frame.html | 38 + .../ury/database/exceptions/package-summary.html | 174 ++++ .../org/ury/database/exceptions/package-tree.html | 158 +++ .../org/ury/database/exceptions/package-use.html | 287 ++++++ doc/uk/org/ury/database/package-frame.html | 45 + doc/uk/org/ury/database/package-summary.html | 179 ++++ doc/uk/org/ury/database/package-tree.html | 163 +++ doc/uk/org/ury/database/package-use.html | 228 +++++ .../org/ury/frontend/AbstractFrontendModule.html | 376 +++++++ doc/uk/org/ury/frontend/FrontendAppletPanel.html | 495 +++++++++ doc/uk/org/ury/frontend/FrontendBanner.html | 375 +++++++ doc/uk/org/ury/frontend/FrontendControlPanel.html | 436 ++++++++ doc/uk/org/ury/frontend/FrontendError.html | 286 ++++++ doc/uk/org/ury/frontend/FrontendFrame.html | 495 +++++++++ doc/uk/org/ury/frontend/FrontendMaster.html | 307 ++++++ doc/uk/org/ury/frontend/FrontendModule.html | 236 +++++ doc/uk/org/ury/frontend/FrontendModulePanel.html | 444 +++++++++ doc/uk/org/ury/frontend/FrontendPanel.html | 406 ++++++++ doc/uk/org/ury/frontend/FrontendSubBanner.html | 383 +++++++ doc/uk/org/ury/frontend/HintField.html | 390 ++++++++ .../frontend/class-use/AbstractFrontendModule.html | 209 ++++ .../frontend/class-use/FrontendAppletPanel.html | 181 ++++ .../org/ury/frontend/class-use/FrontendBanner.html | 144 +++ .../frontend/class-use/FrontendControlPanel.html | 270 +++++ .../org/ury/frontend/class-use/FrontendError.html | 144 +++ .../org/ury/frontend/class-use/FrontendFrame.html | 181 ++++ .../org/ury/frontend/class-use/FrontendMaster.html | 365 +++++++ .../org/ury/frontend/class-use/FrontendModule.html | 277 ++++++ .../frontend/class-use/FrontendModulePanel.html | 367 +++++++ .../org/ury/frontend/class-use/FrontendPanel.html | 291 ++++++ .../ury/frontend/class-use/FrontendSubBanner.html | 144 +++ doc/uk/org/ury/frontend/class-use/HintField.html | 144 +++ .../exceptions/UICreationFailureException.html | 268 +++++ .../class-use/UICreationFailureException.html | 296 ++++++ .../org/ury/frontend/exceptions/package-frame.html | 32 + .../ury/frontend/exceptions/package-summary.html | 157 +++ .../org/ury/frontend/exceptions/package-tree.html | 158 +++ .../org/ury/frontend/exceptions/package-use.html | 227 +++++ doc/uk/org/ury/frontend/package-frame.html | 63 ++ doc/uk/org/ury/frontend/package-summary.html | 219 ++++ doc/uk/org/ury/frontend/package-tree.html | 199 ++++ doc/uk/org/ury/frontend/package-use.html | 348 +++++++ doc/uk/org/ury/library/LibraryItem.html | 242 +++++ doc/uk/org/ury/library/LibraryItemProperty.html | 670 +++++++++++++ doc/uk/org/ury/library/LibraryTableModel.html | 362 +++++++ doc/uk/org/ury/library/LibraryUtils.html | 277 ++++++ doc/uk/org/ury/library/class-use/LibraryItem.html | 224 +++++ .../ury/library/class-use/LibraryItemProperty.html | 203 ++++ .../ury/library/class-use/LibraryTableModel.html | 144 +++ doc/uk/org/ury/library/class-use/LibraryUtils.html | 144 +++ .../library/exceptions/EmptySearchException.html | 272 +++++ .../exceptions/class-use/EmptySearchException.html | 210 ++++ .../org/ury/library/exceptions/package-frame.html | 32 + .../ury/library/exceptions/package-summary.html | 158 +++ .../org/ury/library/exceptions/package-tree.html | 158 +++ doc/uk/org/ury/library/exceptions/package-use.html | 191 ++++ doc/uk/org/ury/library/package-frame.html | 47 + doc/uk/org/ury/library/package-summary.html | 180 ++++ doc/uk/org/ury/library/package-tree.html | 168 ++++ doc/uk/org/ury/library/package-use.html | 195 ++++ doc/uk/org/ury/library/viewer/LibraryViewer.html | 460 +++++++++ .../org/ury/library/viewer/LibraryViewerPanel.html | 424 ++++++++ .../library/viewer/class-use/LibraryViewer.html | 179 ++++ .../viewer/class-use/LibraryViewerPanel.html | 144 +++ doc/uk/org/ury/library/viewer/package-frame.html | 34 + doc/uk/org/ury/library/viewer/package-summary.html | 161 +++ doc/uk/org/ury/library/viewer/package-tree.html | 179 ++++ doc/uk/org/ury/library/viewer/package-use.html | 170 ++++ doc/uk/org/ury/show/ShowChannel.html | 371 +++++++ doc/uk/org/ury/show/ShowItem.html | 278 ++++++ doc/uk/org/ury/show/ShowItemProperty.html | 382 +++++++ doc/uk/org/ury/show/ShowUtils.html | 350 +++++++ doc/uk/org/ury/show/class-use/ShowChannel.html | 195 ++++ doc/uk/org/ury/show/class-use/ShowItem.html | 224 +++++ .../org/ury/show/class-use/ShowItemProperty.html | 203 ++++ doc/uk/org/ury/show/class-use/ShowUtils.html | 144 +++ doc/uk/org/ury/show/package-frame.html | 47 + doc/uk/org/ury/show/package-summary.html | 180 ++++ doc/uk/org/ury/show/package-tree.html | 168 ++++ doc/uk/org/ury/show/package-use.html | 195 ++++ doc/uk/org/ury/show/viewer/ChannelPanel.html | 353 +++++++ .../org/ury/show/viewer/LibraryControlPanel.html | 397 ++++++++ doc/uk/org/ury/show/viewer/ShowViewer.html | 462 +++++++++ doc/uk/org/ury/show/viewer/ShowViewerPanel.html | 424 ++++++++ doc/uk/org/ury/show/viewer/TrackBin.html | 353 +++++++ .../ury/show/viewer/class-use/ChannelPanel.html | 144 +++ .../show/viewer/class-use/LibraryControlPanel.html | 144 +++ .../org/ury/show/viewer/class-use/ShowViewer.html | 179 ++++ .../ury/show/viewer/class-use/ShowViewerPanel.html | 144 +++ doc/uk/org/ury/show/viewer/class-use/TrackBin.html | 144 +++ doc/uk/org/ury/show/viewer/package-frame.html | 40 + doc/uk/org/ury/show/viewer/package-summary.html | 173 ++++ doc/uk/org/ury/show/viewer/package-tree.html | 181 ++++ doc/uk/org/ury/show/viewer/package-use.html | 170 ++++ doc/uk/org/ury/testrig/DemoControlPanel.html | 397 ++++++++ doc/uk/org/ury/testrig/DemoMenu.html | 426 ++++++++ doc/uk/org/ury/testrig/DemoMenuPanel.html | 390 ++++++++ .../ury/testrig/class-use/DemoControlPanel.html | 144 +++ doc/uk/org/ury/testrig/class-use/DemoMenu.html | 144 +++ .../org/ury/testrig/class-use/DemoMenuPanel.html | 144 +++ doc/uk/org/ury/testrig/package-frame.html | 36 + doc/uk/org/ury/testrig/package-summary.html | 165 +++ doc/uk/org/ury/testrig/package-tree.html | 178 ++++ doc/uk/org/ury/testrig/package-use.html | 144 +++ res/conf.xml | 6 +- src/uk/org/ury/client/Client.java | 65 ++ src/uk/org/ury/client/test/ClientTest.java | 64 ++ src/uk/org/ury/config/ConfigReader.java | 4 +- src/uk/org/ury/database/DatabaseDriver.java | 29 +- src/uk/org/ury/database/DatabaseItem.java | 30 + .../org/ury/frontend/AbstractFrontendModule.java | 11 +- src/uk/org/ury/frontend/FrontendApplet.java | 343 +++++++ src/uk/org/ury/frontend/FrontendControlPanel.java | 18 +- src/uk/org/ury/frontend/FrontendError.java | 15 +- src/uk/org/ury/frontend/FrontendFrame.java | 125 ++- src/uk/org/ury/frontend/FrontendMaster.java | 45 +- src/uk/org/ury/frontend/FrontendModulePanel.java | 10 +- src/uk/org/ury/frontend/FrontendPanel.java | 42 +- src/uk/org/ury/frontend/FrontendSubBanner.java | 5 +- .../frontend/exceptions/LoadFailureException.java | 44 + .../exceptions/UICreationFailureException.java | 44 + src/uk/org/ury/library/LibraryRequestHandler.java | 144 +++ src/uk/org/ury/library/LibraryUtils.java | 112 ++- 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 | 95 +- .../org/ury/library/viewer/LibraryViewerPanel.java | 10 +- .../org/ury/library/viewer/library_viewer_gui.xml | 12 +- src/uk/org/ury/server/RequestHandler.java | 44 + src/uk/org/ury/server/Server.java | 432 ++++++++ src/uk/org/ury/server/ServerProtocol.java | 37 + src/uk/org/ury/server/ServerRequestHandler.java | 96 ++ .../server/exceptions/HandleFailureException.java | 46 + src/uk/org/ury/server/protocol/Directive.java | 69 ++ src/uk/org/ury/show/ShowChannel.java | 41 +- src/uk/org/ury/show/ShowUtils.java | 80 +- src/uk/org/ury/show/item/ShowItem.java | 68 ++ src/uk/org/ury/show/item/ShowItemProperty.java | 26 + src/uk/org/ury/show/viewer/ChannelPanel.java | 52 +- .../org/ury/show/viewer/LibraryControlPanel.java | 15 + src/uk/org/ury/show/viewer/ShowViewer.java | 131 ++- src/uk/org/ury/show/viewer/ShowViewerPanel.java | 44 +- src/uk/org/ury/show/viewer/TrackBin.java | 51 +- src/uk/org/ury/show/viewer/channel_panel.xml | 2 +- .../org/ury/show/viewer/library_control_panel.xml | 14 +- src/uk/org/ury/show/viewer/show_viewer_gui.xml | 59 +- 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 | 2 +- src/uk/org/ury/testrig/ApplicationLauncher.java | 32 + src/uk/org/ury/testrig/DemoControlPanel.java | 14 + src/uk/org/ury/testrig/DemoMenu.java | 100 +- 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 | 8 +- 214 files changed, 39166 insertions(+), 453 deletions(-) create mode 100644 Design/roles.dot create mode 100644 Design/roles.dot~ create mode 100644 Design/roles.eps create mode 100644 doc/allclasses-frame.html create mode 100644 doc/allclasses-noframe.html create mode 100644 doc/constant-values.html create mode 100644 doc/deprecated-list.html create mode 100644 doc/help-doc.html create mode 100644 doc/index-files/index-1.html create mode 100644 doc/index-files/index-10.html create mode 100644 doc/index-files/index-11.html create mode 100644 doc/index-files/index-12.html create mode 100644 doc/index-files/index-13.html create mode 100644 doc/index-files/index-14.html create mode 100644 doc/index-files/index-15.html create mode 100644 doc/index-files/index-16.html create mode 100644 doc/index-files/index-17.html create mode 100644 doc/index-files/index-18.html create mode 100644 doc/index-files/index-2.html create mode 100644 doc/index-files/index-3.html create mode 100644 doc/index-files/index-4.html create mode 100644 doc/index-files/index-5.html create mode 100644 doc/index-files/index-6.html create mode 100644 doc/index-files/index-7.html create mode 100644 doc/index-files/index-8.html create mode 100644 doc/index-files/index-9.html create mode 100644 doc/index.html create mode 100644 doc/overview-frame.html create mode 100644 doc/overview-summary.html create mode 100644 doc/overview-tree.html create mode 100644 doc/package-list create mode 100644 doc/resources/inherit.gif create mode 100644 doc/serialized-form.html create mode 100644 doc/stylesheet.css create mode 100644 doc/uk/org/ury/config/Auth.html create mode 100644 doc/uk/org/ury/config/ConfigReader.html create mode 100644 doc/uk/org/ury/config/Database.html create mode 100644 doc/uk/org/ury/config/class-use/Auth.html create mode 100644 doc/uk/org/ury/config/class-use/ConfigReader.html create mode 100644 doc/uk/org/ury/config/class-use/Database.html create mode 100644 doc/uk/org/ury/config/package-frame.html create mode 100644 doc/uk/org/ury/config/package-summary.html create mode 100644 doc/uk/org/ury/config/package-tree.html create mode 100644 doc/uk/org/ury/config/package-use.html create mode 100644 doc/uk/org/ury/database/DatabaseDriver.html create mode 100644 doc/uk/org/ury/database/DatabaseItem.html create mode 100644 doc/uk/org/ury/database/UserClass.html create mode 100644 doc/uk/org/ury/database/class-use/DatabaseDriver.html create mode 100644 doc/uk/org/ury/database/class-use/DatabaseItem.html create mode 100644 doc/uk/org/ury/database/class-use/UserClass.html create mode 100644 doc/uk/org/ury/database/exceptions/ConnectionFailureException.html create mode 100644 doc/uk/org/ury/database/exceptions/MissingCredentialsException.html create mode 100644 doc/uk/org/ury/database/exceptions/MissingPropertyException.html create mode 100644 doc/uk/org/ury/database/exceptions/QueryFailureException.html create mode 100644 doc/uk/org/ury/database/exceptions/class-use/ConnectionFailureException.html create mode 100644 doc/uk/org/ury/database/exceptions/class-use/MissingCredentialsException.html create mode 100644 doc/uk/org/ury/database/exceptions/class-use/MissingPropertyException.html create mode 100644 doc/uk/org/ury/database/exceptions/class-use/QueryFailureException.html create mode 100644 doc/uk/org/ury/database/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/database/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/database/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/database/exceptions/package-use.html create mode 100644 doc/uk/org/ury/database/package-frame.html create mode 100644 doc/uk/org/ury/database/package-summary.html create mode 100644 doc/uk/org/ury/database/package-tree.html create mode 100644 doc/uk/org/ury/database/package-use.html create mode 100644 doc/uk/org/ury/frontend/AbstractFrontendModule.html create mode 100644 doc/uk/org/ury/frontend/FrontendAppletPanel.html create mode 100644 doc/uk/org/ury/frontend/FrontendBanner.html create mode 100644 doc/uk/org/ury/frontend/FrontendControlPanel.html create mode 100644 doc/uk/org/ury/frontend/FrontendError.html create mode 100644 doc/uk/org/ury/frontend/FrontendFrame.html create mode 100644 doc/uk/org/ury/frontend/FrontendMaster.html create mode 100644 doc/uk/org/ury/frontend/FrontendModule.html create mode 100644 doc/uk/org/ury/frontend/FrontendModulePanel.html create mode 100644 doc/uk/org/ury/frontend/FrontendPanel.html create mode 100644 doc/uk/org/ury/frontend/FrontendSubBanner.html create mode 100644 doc/uk/org/ury/frontend/HintField.html create mode 100644 doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html create mode 100644 doc/uk/org/ury/frontend/class-use/FrontendAppletPanel.html create mode 100644 doc/uk/org/ury/frontend/class-use/FrontendBanner.html create mode 100644 doc/uk/org/ury/frontend/class-use/FrontendControlPanel.html create mode 100644 doc/uk/org/ury/frontend/class-use/FrontendError.html create mode 100644 doc/uk/org/ury/frontend/class-use/FrontendFrame.html create mode 100644 doc/uk/org/ury/frontend/class-use/FrontendMaster.html create mode 100644 doc/uk/org/ury/frontend/class-use/FrontendModule.html create mode 100644 doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html create mode 100644 doc/uk/org/ury/frontend/class-use/FrontendPanel.html create mode 100644 doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html create mode 100644 doc/uk/org/ury/frontend/class-use/HintField.html create mode 100644 doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html create mode 100644 doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html create mode 100644 doc/uk/org/ury/frontend/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/frontend/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/frontend/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/frontend/exceptions/package-use.html create mode 100644 doc/uk/org/ury/frontend/package-frame.html create mode 100644 doc/uk/org/ury/frontend/package-summary.html create mode 100644 doc/uk/org/ury/frontend/package-tree.html create mode 100644 doc/uk/org/ury/frontend/package-use.html create mode 100644 doc/uk/org/ury/library/LibraryItem.html create mode 100644 doc/uk/org/ury/library/LibraryItemProperty.html create mode 100644 doc/uk/org/ury/library/LibraryTableModel.html create mode 100644 doc/uk/org/ury/library/LibraryUtils.html create mode 100644 doc/uk/org/ury/library/class-use/LibraryItem.html create mode 100644 doc/uk/org/ury/library/class-use/LibraryItemProperty.html create mode 100644 doc/uk/org/ury/library/class-use/LibraryTableModel.html create mode 100644 doc/uk/org/ury/library/class-use/LibraryUtils.html create mode 100644 doc/uk/org/ury/library/exceptions/EmptySearchException.html create mode 100644 doc/uk/org/ury/library/exceptions/class-use/EmptySearchException.html create mode 100644 doc/uk/org/ury/library/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/library/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/library/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/library/exceptions/package-use.html create mode 100644 doc/uk/org/ury/library/package-frame.html create mode 100644 doc/uk/org/ury/library/package-summary.html create mode 100644 doc/uk/org/ury/library/package-tree.html create mode 100644 doc/uk/org/ury/library/package-use.html create mode 100644 doc/uk/org/ury/library/viewer/LibraryViewer.html create mode 100644 doc/uk/org/ury/library/viewer/LibraryViewerPanel.html create mode 100644 doc/uk/org/ury/library/viewer/class-use/LibraryViewer.html create mode 100644 doc/uk/org/ury/library/viewer/class-use/LibraryViewerPanel.html create mode 100644 doc/uk/org/ury/library/viewer/package-frame.html create mode 100644 doc/uk/org/ury/library/viewer/package-summary.html create mode 100644 doc/uk/org/ury/library/viewer/package-tree.html create mode 100644 doc/uk/org/ury/library/viewer/package-use.html create mode 100644 doc/uk/org/ury/show/ShowChannel.html create mode 100644 doc/uk/org/ury/show/ShowItem.html create mode 100644 doc/uk/org/ury/show/ShowItemProperty.html create mode 100644 doc/uk/org/ury/show/ShowUtils.html create mode 100644 doc/uk/org/ury/show/class-use/ShowChannel.html create mode 100644 doc/uk/org/ury/show/class-use/ShowItem.html create mode 100644 doc/uk/org/ury/show/class-use/ShowItemProperty.html create mode 100644 doc/uk/org/ury/show/class-use/ShowUtils.html create mode 100644 doc/uk/org/ury/show/package-frame.html create mode 100644 doc/uk/org/ury/show/package-summary.html create mode 100644 doc/uk/org/ury/show/package-tree.html create mode 100644 doc/uk/org/ury/show/package-use.html create mode 100644 doc/uk/org/ury/show/viewer/ChannelPanel.html create mode 100644 doc/uk/org/ury/show/viewer/LibraryControlPanel.html create mode 100644 doc/uk/org/ury/show/viewer/ShowViewer.html create mode 100644 doc/uk/org/ury/show/viewer/ShowViewerPanel.html create mode 100644 doc/uk/org/ury/show/viewer/TrackBin.html create mode 100644 doc/uk/org/ury/show/viewer/class-use/ChannelPanel.html create mode 100644 doc/uk/org/ury/show/viewer/class-use/LibraryControlPanel.html create mode 100644 doc/uk/org/ury/show/viewer/class-use/ShowViewer.html create mode 100644 doc/uk/org/ury/show/viewer/class-use/ShowViewerPanel.html create mode 100644 doc/uk/org/ury/show/viewer/class-use/TrackBin.html create mode 100644 doc/uk/org/ury/show/viewer/package-frame.html create mode 100644 doc/uk/org/ury/show/viewer/package-summary.html create mode 100644 doc/uk/org/ury/show/viewer/package-tree.html create mode 100644 doc/uk/org/ury/show/viewer/package-use.html create mode 100644 doc/uk/org/ury/testrig/DemoControlPanel.html create mode 100644 doc/uk/org/ury/testrig/DemoMenu.html create mode 100644 doc/uk/org/ury/testrig/DemoMenuPanel.html create mode 100644 doc/uk/org/ury/testrig/class-use/DemoControlPanel.html create mode 100644 doc/uk/org/ury/testrig/class-use/DemoMenu.html create mode 100644 doc/uk/org/ury/testrig/class-use/DemoMenuPanel.html create mode 100644 doc/uk/org/ury/testrig/package-frame.html create mode 100644 doc/uk/org/ury/testrig/package-summary.html create mode 100644 doc/uk/org/ury/testrig/package-tree.html create mode 100644 doc/uk/org/ury/testrig/package-use.html create mode 100644 src/uk/org/ury/client/Client.java create mode 100644 src/uk/org/ury/client/test/ClientTest.java create mode 100644 src/uk/org/ury/frontend/FrontendApplet.java create mode 100644 src/uk/org/ury/frontend/exceptions/LoadFailureException.java create mode 100644 src/uk/org/ury/frontend/exceptions/UICreationFailureException.java create mode 100644 src/uk/org/ury/library/LibraryRequestHandler.java create mode 100644 src/uk/org/ury/library/item/LibraryItem.java create mode 100644 src/uk/org/ury/library/item/LibraryItemProperty.java create mode 100644 src/uk/org/ury/library/viewer/LibraryTableModel.java create mode 100644 src/uk/org/ury/server/RequestHandler.java create mode 100644 src/uk/org/ury/server/Server.java create mode 100644 src/uk/org/ury/server/ServerProtocol.java create mode 100644 src/uk/org/ury/server/ServerRequestHandler.java create mode 100644 src/uk/org/ury/server/exceptions/HandleFailureException.java create mode 100644 src/uk/org/ury/server/protocol/Directive.java create mode 100644 src/uk/org/ury/show/item/ShowItem.java create mode 100644 src/uk/org/ury/show/item/ShowItemProperty.java create mode 100644 src/uk/org/ury/show/viewer/show_viewer_gui_old.xml create mode 100644 src/uk/org/ury/show/viewer/show_viewer_gui_panels.xml create mode 100644 src/uk/org/ury/testrig/ApplicationLauncher.java create mode 100644 src/uk/org/ury/testrig/DemoMenuPanel.java create mode 100644 src/uk/org/ury/testrig/Launcher.java diff --git a/Design/roles.dot b/Design/roles.dot new file mode 100644 index 0000000..8194939 --- /dev/null +++ b/Design/roles.dot @@ -0,0 +1,93 @@ +digraph Roles +{ + node [style = filled, + fillcolor = white, + color = white]; + label = "Roles, their privilege levels and module mapping."; + // LOGON PHASE + subgraph cluster_1 + { + label = "Before entering the system..." + style = filled; + pencolor = white; + fillcolor = crimson; + labeljust = l; + // User + User -> LogOn; + LogOn [label = "Log on with username and password"]; + } + // USER CLASSES + subgraph cluster_2 + { + label = "I am a..."; + style = filled; + pencolor = white; + fillcolor = gold; + labeljust = l; + // StdUser (unprivileged) + StdUser [label = "standard user."] + LogOn -> StdUser; + // LibraryMgr (privileged) + LibraryMgr [label = "library manager."] + LogOn -> LibraryMgr; + // Admin (super-privileged) + Admin [label = "administrator."] + LogOn -> Admin; + } + // ROLES + subgraph cluster_3 + { + label = "I want to..."; + style = filled; + pencolor = white; + fillcolor = chartreuse; + labeljust = l; + node [shape = rectangle]; + // CEditShow + CEditShow [label = "create or edit\na show."]; + StdUser -> CEditShow; + LibraryMgr -> CEditShow; + Admin -> CEditShow; + // PlayShow + PlayShow [label = "present\na show."]; + StdUser -> PlayShow; + LibraryMgr -> PlayShow; + Admin -> PlayShow; + // MUserTracks + MUserTracks [label = "manage or upload\nmy personal tracks."]; + StdUser -> MUserTracks; + LibraryMgr -> MUserTracks; + Admin -> MUserTracks; + // MLibrary + MLibrary [label = "manage\nthe track library."]; + LibraryMgr -> MLibrary; + Admin -> MLibrary; + // Configure + Configure [label = "configure\nthe system."]; + Admin -> Configure; + } + // MODULES + subgraph cluster_4 + { + label = "The module for this task is..."; + style = filled; + pencolor = white; + fillcolor = cornflowerblue; + labeljust = l; + // ShowEditor + ShowEditor; + CEditShow -> ShowEditor; + // ShowPlayout + ShowPlayout; + PlayShow -> ShowPlayout; + // CollectionEditor + CollectionEditor; + MUserTracks -> CollectionEditor; + // LibraryEditor + LibraryEditor; + MLibrary -> LibraryEditor; + // SystemSettings + SystemSettings; + Configure -> SystemSettings; + } +} \ No newline at end of file diff --git a/Design/roles.dot~ b/Design/roles.dot~ new file mode 100644 index 0000000..98f05d8 --- /dev/null +++ b/Design/roles.dot~ @@ -0,0 +1,17 @@ +digraph +{ + // LOGON PHASE + User -> LogOn; + LogOn -> StdUser; + LogOn -> LibraryMgr; + // USER CLASSES + // - StdUser (unprivileged) + StdUser -> CreateEditShow; + StdUser -> PlayShow; + StdUser -> ManageUserTracks; + // - LibraryMgr (privileged) + LibraryMgr -> CreateEditShow; + LibraryMgr -> PlayShow; + LibraryMgr -> ManageUserTracks; + LibraryMgr -> ManageLibrary; +} \ No newline at end of file diff --git a/Design/roles.eps b/Design/roles.eps new file mode 100644 index 0000000..7a82983 --- /dev/null +++ b/Design/roles.eps @@ -0,0 +1,948 @@ +%!PS-Adobe-3.0 EPSF-3.0 +%%Creator: graphviz version 2.26.3 (20100126.1600) +%%Title: Roles +%%Pages: 1 +%%BoundingBox: 36 36 974 510 +%%EndComments +save +%%BeginProlog +/DotDict 200 dict def +DotDict begin + +/setupLatin1 { +mark +/EncodingVector 256 array def + EncodingVector 0 + +ISOLatin1Encoding 0 255 getinterval putinterval +EncodingVector 45 /hyphen put + +% Set up ISO Latin 1 character encoding +/starnetISO { + dup dup findfont dup length dict begin + { 1 index /FID ne { def }{ pop pop } ifelse + } forall + /Encoding EncodingVector def + currentdict end definefont +} def +/Times-Roman starnetISO def +/Times-Italic starnetISO def +/Times-Bold starnetISO def +/Times-BoldItalic starnetISO def +/Helvetica starnetISO def +/Helvetica-Oblique starnetISO def +/Helvetica-Bold starnetISO def +/Helvetica-BoldOblique starnetISO def +/Courier starnetISO def +/Courier-Oblique starnetISO def +/Courier-Bold starnetISO def +/Courier-BoldOblique starnetISO def +cleartomark +} bind def + +%%BeginResource: procset graphviz 0 0 +/coord-font-family /Times-Roman def +/default-font-family /Times-Roman def +/coordfont coord-font-family findfont 8 scalefont def + +/InvScaleFactor 1.0 def +/set_scale { + dup 1 exch div /InvScaleFactor exch def + scale +} bind def + +% styles +/solid { [] 0 setdash } bind def +/dashed { [9 InvScaleFactor mul dup ] 0 setdash } bind def +/dotted { [1 InvScaleFactor mul 6 InvScaleFactor mul] 0 setdash } bind def +/invis {/fill {newpath} def /stroke {newpath} def /show {pop newpath} def} bind def +/bold { 2 setlinewidth } bind def +/filled { } bind def +/unfilled { } bind def +/rounded { } bind def +/diagonals { } bind def + +% hooks for setting color +/nodecolor { sethsbcolor } bind def +/edgecolor { sethsbcolor } bind def +/graphcolor { sethsbcolor } bind def +/nopcolor {pop pop pop} bind def + +/beginpage { % i j npages + /npages exch def + /j exch def + /i exch def + /str 10 string def + npages 1 gt { + gsave + coordfont setfont + 0 0 moveto + (\() show i str cvs show (,) show j str cvs show (\)) show + grestore + } if +} bind def + +/set_font { + findfont exch + scalefont setfont +} def + +% draw text fitted to its expected width +/alignedtext { % width text + /text exch def + /width exch def + gsave + width 0 gt { + [] 0 setdash + text stringwidth pop width exch sub text length div 0 text ashow + } if + grestore +} def + +/boxprim { % xcorner ycorner xsize ysize + 4 2 roll + moveto + 2 copy + exch 0 rlineto + 0 exch rlineto + pop neg 0 rlineto + closepath +} bind def + +/ellipse_path { + /ry exch def + /rx exch def + /y exch def + /x exch def + matrix currentmatrix + newpath + x y translate + rx ry scale + 0 0 1 0 360 arc + setmatrix +} bind def + +/endpage { showpage } bind def +/showpage { } def + +/layercolorseq + [ % layer color sequence - darkest to lightest + [0 0 0] + [.2 .8 .8] + [.4 .8 .8] + [.6 .8 .8] + [.8 .8 .8] + ] +def + +/layerlen layercolorseq length def + +/setlayer {/maxlayer exch def /curlayer exch def + layercolorseq curlayer 1 sub layerlen mod get + aload pop sethsbcolor + /nodecolor {nopcolor} def + /edgecolor {nopcolor} def + /graphcolor {nopcolor} def +} bind def + +/onlayer { curlayer ne {invis} if } def + +/onlayers { + /myupper exch def + /mylower exch def + curlayer mylower lt + curlayer myupper gt + or + {invis} if +} def + +/curlayer 0 def + +%%EndResource +%%EndProlog +%%BeginSetup +14 default-font-family set_font +1 setmiterlimit +% /arrowlength 10 def +% /arrowwidth 5 def + +% make sure pdfmark is harmless for PS-interpreters other than Distiller +/pdfmark where {pop} {userdict /pdfmark /cleartomark load put} ifelse +% make '<<' and '>>' safe on PS Level 1 devices +/languagelevel where {pop languagelevel}{1} ifelse +2 lt { + userdict (<<) cvn ([) cvn load put + userdict (>>) cvn ([) cvn load put +} if + +%%EndSetup +setupLatin1 +%%Page: 1 1 +%%PageBoundingBox: 36 36 974 510 +%%PageOrientation: Portrait +0 0 1 beginpage +gsave +36 36 938 474 boxprim clip newpath +1 1 set_scale 0 rotate 40 41 translate +0 0 0 graphcolor +14 /Times-Roman set_font +287.5 9.4 moveto 355 (Roles, their privilege levels and module mapping.) alignedtext +% cluster_1 +gsave +0.96471 0.90588 0.86275 graphcolor +newpath 320 304 moveto +320 458 lineto +732 458 lineto +732 304 lineto +closepath fill +1 setlinewidth +filled +0 0 1 graphcolor +newpath 320 304 moveto +320 458 lineto +732 458 lineto +732 304 lineto +closepath stroke +0 0 0 graphcolor +14 /Times-Roman set_font +328 441.4 moveto 210 (Before entering the system...) alignedtext +grestore +% cluster_2 +gsave +0.13725 1 1 graphcolor +newpath 239 216 moveto +239 296 lineto +815 296 lineto +815 216 lineto +closepath fill +1 setlinewidth +filled +0 0 1 graphcolor +newpath 239 216 moveto +239 296 lineto +815 296 lineto +815 216 lineto +closepath stroke +0 0 0 graphcolor +14 /Times-Roman set_font +247 279.4 moveto 59 (I am a...) alignedtext +grestore +% cluster_3 +gsave +0.24706 1 1 graphcolor +newpath 128 122 moveto +128 208 lineto +796 208 lineto +796 122 lineto +closepath fill +1 setlinewidth +filled +0 0 1 graphcolor +newpath 128 122 moveto +128 208 lineto +796 208 lineto +796 122 lineto +closepath stroke +0 0 0 graphcolor +14 /Times-Roman set_font +136 191.4 moveto 79 (I want to...) alignedtext +grestore +% cluster_4 +gsave +0.60392 0.57647 0.92941 graphcolor +newpath 8 34 moveto +8 114 lineto +922 114 lineto +922 34 lineto +closepath fill +1 setlinewidth +filled +0 0 1 graphcolor +newpath 8 34 moveto +8 114 lineto +922 114 lineto +922 34 lineto +closepath stroke +0 0 0 graphcolor +14 /Times-Roman set_font +16 97.4 moveto 205 (The module for this task is...) alignedtext +grestore +% User +gsave +0 0 1 nodecolor +526 405 34.86 18.38 ellipse_path fill +1 setlinewidth +filled +0 0 1 nodecolor +526 405 34.86 18.38 ellipse_path stroke +0 0 0 nodecolor +14 /Times-Roman set_font +509 401.4 moveto 34 (User) alignedtext +grestore +% LogOn +gsave +0 0 1 nodecolor +526 331 197.99 18.38 ellipse_path fill +1 setlinewidth +filled +0 0 1 nodecolor +526 331 197.99 18.38 ellipse_path stroke +0 0 0 nodecolor +14 /Times-Roman set_font +394 327.4 moveto 264 (Log on with username and password) alignedtext +grestore +% User->LogOn +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 526 386.33 moveto +526 378.26 526 368.65 526 359.71 curveto +stroke +0 0 0 edgecolor +newpath 529.5 359.67 moveto +526 349.67 lineto +522.5 359.67 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 529.5 359.67 moveto +526 349.67 lineto +522.5 359.67 lineto +closepath stroke +grestore +% StdUser +gsave +0 0 1 nodecolor +723 243 84.15 18.38 ellipse_path fill +1 setlinewidth +filled +0 0 1 nodecolor +723 243 84.15 18.38 ellipse_path stroke +0 0 0 nodecolor +14 /Times-Roman set_font +671.5 239.4 moveto 103 (standard user.) alignedtext +grestore +% LogOn->StdUser +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 585.07 313.33 moveto +599.95 308.28 615.74 302.39 630 296 curveto +649.17 287.41 669.55 276.07 686.33 266.08 curveto +stroke +0 0 0 edgecolor +newpath 688.5 268.86 moveto +695.25 260.7 lineto +684.88 262.87 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 688.5 268.86 moveto +695.25 260.7 lineto +684.88 262.87 lineto +closepath stroke +grestore +% LibraryMgr +gsave +0 0 1 nodecolor +526 243 94.96 18.38 ellipse_path fill +1 setlinewidth +filled +0 0 1 nodecolor +526 243 94.96 18.38 ellipse_path stroke +0 0 0 nodecolor +14 /Times-Roman set_font +466.5 239.4 moveto 119 (library manager.) alignedtext +grestore +% LogOn->LibraryMgr +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 526 312.34 moveto +526 300.55 526 285.09 526 271.76 curveto +stroke +0 0 0 edgecolor +newpath 529.5 271.64 moveto +526 261.64 lineto +522.5 271.64 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 529.5 271.64 moveto +526 261.64 lineto +522.5 271.64 lineto +closepath stroke +grestore +% Admin +gsave +0 0 1 nodecolor +330 243 82.94 18.38 ellipse_path fill +1 setlinewidth +filled +0 0 1 nodecolor +330 243 82.94 18.38 ellipse_path stroke +0 0 0 nodecolor +14 /Times-Roman set_font +279 239.4 moveto 102 (administrator.) alignedtext +grestore +% LogOn->Admin +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 466.64 313.28 moveto +451.84 308.25 436.15 302.38 422 296 curveto +403 287.43 382.84 276.09 366.25 266.11 curveto +stroke +0 0 0 edgecolor +newpath 367.79 262.94 moveto +357.43 260.72 lineto +364.14 268.92 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 367.79 262.94 moveto +357.43 260.72 lineto +364.14 268.92 lineto +closepath stroke +grestore +% CEditShow +gsave +0 0 1 nodecolor +newpath 788 174 moveto +674 174 lineto +674 130 lineto +788 130 lineto +closepath fill +1 setlinewidth +filled +0 0 1 nodecolor +newpath 788 174 moveto +674 174 lineto +674 130 lineto +788 130 lineto +closepath stroke +0 0 0 nodecolor +14 /Times-Roman set_font +682 157.4 moveto 98 (create or edit) alignedtext +0 0 0 nodecolor +14 /Times-Roman set_font +704.5 139.4 moveto 53 (a show.) alignedtext +grestore +% StdUser->CEditShow +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 724.66 224.14 moveto +725.67 212.64 726.99 197.63 728.16 184.29 curveto +stroke +0 0 0 edgecolor +newpath 731.67 184.3 moveto +729.06 174.04 lineto +724.7 183.69 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 731.67 184.3 moveto +729.06 174.04 lineto +724.7 183.69 lineto +closepath stroke +grestore +% PlayShow +gsave +0 0 1 nodecolor +newpath 656 174 moveto +586 174 lineto +586 130 lineto +656 130 lineto +closepath fill +1 setlinewidth +filled +0 0 1 nodecolor +newpath 656 174 moveto +586 174 lineto +586 130 lineto +656 130 lineto +closepath stroke +0 0 0 nodecolor +14 /Times-Roman set_font +593.5 157.4 moveto 55 (present) alignedtext +0 0 0 nodecolor +14 /Times-Roman set_font +594.5 139.4 moveto 53 (a show.) alignedtext +grestore +% StdUser->PlayShow +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 689.96 225.88 moveto +681.4 220.7 672.49 214.62 665 208 curveto +656.51 200.49 648.45 191.18 641.61 182.31 curveto +stroke +0 0 0 edgecolor +newpath 644.23 179.96 moveto +635.45 174.03 lineto +638.61 184.14 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 644.23 179.96 moveto +635.45 174.03 lineto +638.61 184.14 lineto +closepath stroke +grestore +% MUserTracks +gsave +0 0 1 nodecolor +newpath 568 174 moveto +410 174 lineto +410 130 lineto +568 130 lineto +closepath fill +1 setlinewidth +filled +0 0 1 nodecolor +newpath 568 174 moveto +410 174 lineto +410 130 lineto +568 130 lineto +closepath stroke +0 0 0 nodecolor +14 /Times-Roman set_font +424.5 157.4 moveto 129 (manage or upload) alignedtext +0 0 0 nodecolor +14 /Times-Roman set_font +417.5 139.4 moveto 143 (my personal tracks.) alignedtext +grestore +% StdUser->MUserTracks +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 675.04 227.76 moveto +660.66 223.55 644.78 219.25 630 216 curveto +606.73 210.89 599.31 216.35 577 208 curveto +559 201.26 540.79 190.48 525.65 180.17 curveto +stroke +0 0 0 edgecolor +newpath 527.31 177.06 moveto +517.11 174.18 lineto +523.29 182.79 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 527.31 177.06 moveto +517.11 174.18 lineto +523.29 182.79 lineto +closepath stroke +grestore +% LibraryMgr->CEditShow +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 582.33 228.06 moveto +597.76 224.05 614.51 219.78 630 216 curveto +645.5 212.22 650.73 215.14 665 208 curveto +678.62 201.18 691.81 190.98 702.77 181.14 curveto +stroke +0 0 0 edgecolor +newpath 705.39 183.48 moveto +710.32 174.1 lineto +700.62 178.36 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 705.39 183.48 moveto +710.32 174.1 lineto +700.62 178.36 lineto +closepath stroke +grestore +% LibraryMgr->PlayShow +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 554.95 225.37 moveto +562.48 220.2 570.34 214.24 577 208 curveto +585.2 200.31 593.13 191.02 599.94 182.23 curveto +stroke +0 0 0 edgecolor +newpath 602.9 184.13 moveto +606.1 174.03 lineto +597.3 179.92 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 602.9 184.13 moveto +606.1 174.03 lineto +597.3 179.92 lineto +closepath stroke +grestore +% LibraryMgr->MUserTracks +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 518.33 224.14 moveto +513.56 212.42 507.31 197.04 501.81 183.49 curveto +stroke +0 0 0 edgecolor +newpath 504.97 181.98 moveto +497.96 174.04 lineto +498.48 184.62 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 504.97 181.98 moveto +497.96 174.04 lineto +498.48 184.62 lineto +closepath stroke +grestore +% MLibrary +gsave +0 0 1 nodecolor +newpath 392 174 moveto +254 174 lineto +254 130 lineto +392 130 lineto +closepath fill +1 setlinewidth +filled +0 0 1 nodecolor +newpath 392 174 moveto +254 174 lineto +254 130 lineto +392 130 lineto +closepath stroke +0 0 0 nodecolor +14 /Times-Roman set_font +294.5 157.4 moveto 57 (manage) alignedtext +0 0 0 nodecolor +14 /Times-Roman set_font +262 139.4 moveto 122 (the track library.) alignedtext +grestore +% LibraryMgr->MLibrary +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 466.64 228.47 moveto +440.48 221.64 412.99 213.76 401 208 curveto +385.72 200.66 370.26 190.31 357.19 180.5 curveto +stroke +0 0 0 edgecolor +newpath 359.03 177.5 moveto +348.97 174.17 lineto +354.76 183.05 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 359.03 177.5 moveto +348.97 174.17 lineto +354.76 183.05 lineto +closepath stroke +grestore +% Admin->CEditShow +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 374.87 227.37 moveto +389.69 222.87 406.39 218.51 422 216 curveto +448.67 211.72 639.8 217.73 665 208 curveto +679.81 202.29 693.63 191.75 704.76 181.35 curveto +stroke +0 0 0 edgecolor +newpath 707.33 183.74 moveto +712.02 174.23 lineto +702.43 178.74 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 707.33 183.74 moveto +712.02 174.23 lineto +702.43 178.74 lineto +closepath stroke +grestore +% Admin->PlayShow +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 375.37 227.4 moveto +390.07 222.96 406.57 218.62 422 216 curveto +439 213.11 561.69 215.94 577 208 curveto +587.95 202.32 597.05 192.57 604.08 182.77 curveto +stroke +0 0 0 edgecolor +newpath 607.11 184.52 moveto +609.71 174.25 lineto +601.28 180.66 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 607.11 184.52 moveto +609.71 174.25 lineto +601.28 180.66 lineto +closepath stroke +grestore +% Admin->MUserTracks +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 365.79 226.3 moveto +377.18 220.73 389.74 214.33 401 208 curveto +416.42 199.32 432.89 189.11 447.37 179.8 curveto +stroke +0 0 0 edgecolor +newpath 449.61 182.52 moveto +456.09 174.14 lineto +445.8 176.65 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 449.61 182.52 moveto +456.09 174.14 lineto +445.8 176.65 lineto +closepath stroke +grestore +% Admin->MLibrary +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 328.55 224.14 moveto +327.66 212.64 326.51 197.63 325.48 184.29 curveto +stroke +0 0 0 edgecolor +newpath 328.95 183.74 moveto +324.7 174.04 lineto +321.97 184.27 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 328.95 183.74 moveto +324.7 174.04 lineto +321.97 184.27 lineto +closepath stroke +grestore +% Configure +gsave +0 0 1 nodecolor +newpath 236 174 moveto +136 174 lineto +136 130 lineto +236 130 lineto +closepath fill +1 setlinewidth +filled +0 0 1 nodecolor +newpath 236 174 moveto +136 174 lineto +136 130 lineto +236 130 lineto +closepath stroke +0 0 0 nodecolor +14 /Times-Roman set_font +152 157.4 moveto 68 (configure) alignedtext +0 0 0 nodecolor +14 /Times-Roman set_font +144 139.4 moveto 84 (the system.) alignedtext +grestore +% Admin->Configure +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 283.89 227.61 moveto +270.83 222.31 256.92 215.72 245 208 curveto +233.59 200.61 222.42 190.86 212.92 181.56 curveto +stroke +0 0 0 edgecolor +newpath 215.21 178.91 moveto +205.69 174.27 lineto +210.24 183.83 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 215.21 178.91 moveto +205.69 174.27 lineto +210.24 183.83 lineto +closepath stroke +grestore +% ShowEditor +gsave +0 0 1 nodecolor +844 61 70.21 18.38 ellipse_path fill +1 setlinewidth +filled +0 0 1 nodecolor +844 61 70.21 18.38 ellipse_path stroke +0 0 0 nodecolor +14 /Times-Roman set_font +802 57.4 moveto 84 (ShowEditor) alignedtext +grestore +% CEditShow->ShowEditor +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 758.35 129.97 moveto +775.08 116.5 796.5 99.25 813.74 85.37 curveto +stroke +0 0 0 edgecolor +newpath 816.23 87.86 moveto +821.82 78.86 lineto +811.84 82.41 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 816.23 87.86 moveto +821.82 78.86 lineto +811.84 82.41 lineto +closepath stroke +grestore +% ShowPlayout +gsave +0 0 1 nodecolor +679 61 77.07 18.38 ellipse_path fill +1 setlinewidth +filled +0 0 1 nodecolor +679 61 77.07 18.38 ellipse_path stroke +0 0 0 nodecolor +14 /Times-Roman set_font +632.5 57.4 moveto 93 (ShowPlayout) alignedtext +grestore +% PlayShow->ShowPlayout +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 635.04 129.97 moveto +643.05 117.41 653.15 101.55 661.65 88.21 curveto +stroke +0 0 0 edgecolor +newpath 664.82 89.77 moveto +667.24 79.45 lineto +658.91 86 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 664.82 89.77 moveto +667.24 79.45 lineto +658.91 86 lineto +closepath stroke +grestore +% CollectionEditor +gsave +0 0 1 nodecolor +489 61 94.75 18.38 ellipse_path fill +1 setlinewidth +filled +0 0 1 nodecolor +489 61 94.75 18.38 ellipse_path stroke +0 0 0 nodecolor +14 /Times-Roman set_font +430 57.4 moveto 118 (CollectionEditor) alignedtext +grestore +% MUserTracks->CollectionEditor +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 489 129.97 moveto +489 117.97 489 102.97 489 90.03 curveto +stroke +0 0 0 edgecolor +newpath 492.5 89.75 moveto +489 79.75 lineto +485.5 89.75 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 492.5 89.75 moveto +489 79.75 lineto +485.5 89.75 lineto +closepath stroke +grestore +% LibraryEditor +gsave +0 0 1 nodecolor +295 61 80.82 18.38 ellipse_path fill +1 setlinewidth +filled +0 0 1 nodecolor +295 61 80.82 18.38 ellipse_path stroke +0 0 0 nodecolor +14 /Times-Roman set_font +245.5 57.4 moveto 99 (LibraryEditor) alignedtext +grestore +% MLibrary->LibraryEditor +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 316.22 129.97 moveto +312.49 117.85 307.82 102.67 303.81 89.64 curveto +stroke +0 0 0 edgecolor +newpath 307.06 88.28 moveto +300.77 79.75 lineto +300.37 90.34 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 307.06 88.28 moveto +300.77 79.75 lineto +300.37 90.34 lineto +closepath stroke +grestore +% SystemSettings +gsave +0 0 1 nodecolor +106 61 90.01 18.38 ellipse_path fill +1 setlinewidth +filled +0 0 1 nodecolor +106 61 90.01 18.38 ellipse_path stroke +0 0 0 nodecolor +14 /Times-Roman set_font +50 57.4 moveto 112 (SystemSettings) alignedtext +grestore +% Configure->SystemSettings +gsave +1 setlinewidth +0 0 0 edgecolor +newpath 166.63 129.97 moveto +155.27 117.04 140.84 100.64 128.92 87.07 curveto +stroke +0 0 0 edgecolor +newpath 131.45 84.65 moveto +122.22 79.45 lineto +126.2 89.27 lineto +closepath fill +1 setlinewidth +solid +0 0 0 edgecolor +newpath 131.45 84.65 moveto +122.22 79.45 lineto +126.2 89.27 lineto +closepath stroke +grestore +endpage +showpage +grestore +%%PageTrailer +%%EndPage: 1 +%%Trailer +end +restore +%%EOF diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html new file mode 100644 index 0000000..5b817fb --- /dev/null +++ b/doc/allclasses-frame.html @@ -0,0 +1,113 @@ + + + + + + +All Classes + + + + + + + + + + + +All Classes +
+ + + + + +
AbstractFrontendModule +
+Auth +
+ChannelPanel +
+ConfigReader +
+ConnectionFailureException +
+Database +
+DatabaseDriver +
+DatabaseItem +
+DemoControlPanel +
+DemoMenu +
+DemoMenuPanel +
+EmptySearchException +
+FrontendAppletPanel +
+FrontendBanner +
+FrontendControlPanel +
+FrontendError +
+FrontendFrame +
+FrontendMaster +
+FrontendModule +
+FrontendModulePanel +
+FrontendPanel +
+FrontendSubBanner +
+HintField +
+LibraryControlPanel +
+LibraryItem +
+LibraryItemProperty +
+LibraryTableModel +
+LibraryUtils +
+LibraryViewer +
+LibraryViewerPanel +
+MissingCredentialsException +
+MissingPropertyException +
+QueryFailureException +
+ShowChannel +
+ShowItem +
+ShowItemProperty +
+ShowUtils +
+ShowViewer +
+ShowViewerPanel +
+TrackBin +
+UICreationFailureException +
+UserClass +
+
+ + + diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html new file mode 100644 index 0000000..b680097 --- /dev/null +++ b/doc/allclasses-noframe.html @@ -0,0 +1,113 @@ + + + + + + +All Classes + + + + + + + + + + + +All Classes +
+ + + + + +
AbstractFrontendModule +
+Auth +
+ChannelPanel +
+ConfigReader +
+ConnectionFailureException +
+Database +
+DatabaseDriver +
+DatabaseItem +
+DemoControlPanel +
+DemoMenu +
+DemoMenuPanel +
+EmptySearchException +
+FrontendAppletPanel +
+FrontendBanner +
+FrontendControlPanel +
+FrontendError +
+FrontendFrame +
+FrontendMaster +
+FrontendModule +
+FrontendModulePanel +
+FrontendPanel +
+FrontendSubBanner +
+HintField +
+LibraryControlPanel +
+LibraryItem +
+LibraryItemProperty +
+LibraryTableModel +
+LibraryUtils +
+LibraryViewer +
+LibraryViewerPanel +
+MissingCredentialsException +
+MissingPropertyException +
+QueryFailureException +
+ShowChannel +
+ShowItem +
+ShowItemProperty +
+ShowUtils +
+ShowViewer +
+ShowViewerPanel +
+TrackBin +
+UICreationFailureException +
+UserClass +
+
+ + + diff --git a/doc/constant-values.html b/doc/constant-values.html new file mode 100644 index 0000000..2d64792 --- /dev/null +++ b/doc/constant-values.html @@ -0,0 +1,174 @@ + + + + + + +Constant Field Values + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Constant Field Values

+
+
+Contents + + + + + + +
+uk.org.*
+ +

+ + + + + + + + + + + + +
uk.org.ury.show.ShowUtils
+public static final intNUM_CHANNELS3
+ +

+ +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html new file mode 100644 index 0000000..65a757f --- /dev/null +++ b/doc/deprecated-list.html @@ -0,0 +1,146 @@ + + + + + + +Deprecated List + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Deprecated API

+
+
+Contents + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/help-doc.html b/doc/help-doc.html new file mode 100644 index 0000000..52d4416 --- /dev/null +++ b/doc/help-doc.html @@ -0,0 +1,223 @@ + + + + + + +API Help + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Overview

+
+ +

+The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

+

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

+
+

+Use

+
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object. +
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/index-files/index-1.html b/doc/index-files/index-1.html new file mode 100644 index 0000000..fe3d35a --- /dev/null +++ b/doc/index-files/index-1.html @@ -0,0 +1,154 @@ + + + + + + +A-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+A

+
+
AbstractFrontendModule - Class in uk.org.ury.frontend
An abstract implementation of the FrontendModule interface.
AbstractFrontendModule() - +Constructor for class uk.org.ury.frontend.AbstractFrontendModule +
  +
add(int, ShowItem) - +Method in class uk.org.ury.show.ShowChannel +
Add a new item to the channel. +
add(ShowItem) - +Method in class uk.org.ury.show.ShowChannel +
Add a new item to the end of the channel. +
Auth - Class in uk.org.ury.config
A login authorisation configuration
Auth(String, String) - +Constructor for class uk.org.ury.config.Auth +
Create a login auth object +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-10.html b/doc/index-files/index-10.html new file mode 100644 index 0000000..aa8a428 --- /dev/null +++ b/doc/index-files/index-10.html @@ -0,0 +1,185 @@ + + + + + + +L-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+L

+
+
LibraryControlPanel - Class in uk.org.ury.show.viewer
Control panel for the demo system.
LibraryControlPanel() - +Constructor for class uk.org.ury.show.viewer.LibraryControlPanel +
Construct a new LibraryControlPanel. +
LibraryItem - Class in uk.org.ury.library
An item in the URY library.
LibraryItem(Map<LibraryItemProperty, String>) - +Constructor for class uk.org.ury.library.LibraryItem +
  +
LibraryItemProperty - Enum in uk.org.ury.library
The parameters that are stored in the LibraryItem.
LibraryTableModel - Class in uk.org.ury.library
A table model for the library viewer.
LibraryTableModel(List<LibraryItem>) - +Constructor for class uk.org.ury.library.LibraryTableModel +
Construct a new table model. +
LibraryUtils - Class in uk.org.ury.library
A set of common utility routines to facilitate the extraction of + library items from the library areas of the URY database.
LibraryUtils() - +Constructor for class uk.org.ury.library.LibraryUtils +
  +
LibraryViewer - Class in uk.org.ury.library.viewer
 
LibraryViewer() - +Constructor for class uk.org.ury.library.viewer.LibraryViewer +
Construct a new LibraryViewer as a frontend object. +
LibraryViewerPanel - Class in uk.org.ury.library.viewer
Frontend panel providing access to an underlying library viewer.
LibraryViewerPanel(LibraryViewer, FrontendMaster) - +Constructor for class uk.org.ury.library.viewer.LibraryViewerPanel +
Construct a new LibraryViewerPanel. +
loadModule(String) - +Method in class uk.org.ury.frontend.FrontendAppletPanel +
Load a module into the frontend frame. +
loadModule(String, String) - +Method in class uk.org.ury.frontend.FrontendAppletPanel +
Load a module into the frontend frame, additionally installing + a control panel to communicate with the previous module. +
loadModule(String) - +Method in class uk.org.ury.frontend.FrontendFrame +
Load a module into the frontend frame. +
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. +
loadModule(String) - +Method in interface uk.org.ury.frontend.FrontendMaster +
Load a module into the frontend frame. +
loadModule(String, String) - +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 +
  +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-11.html b/doc/index-files/index-11.html new file mode 100644 index 0000000..414c5ef --- /dev/null +++ b/doc/index-files/index-11.html @@ -0,0 +1,162 @@ + + + + + + +M-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+M

+
+
main(String[]) - +Static method in class uk.org.ury.testrig.DemoMenu +
Main method. +
MissingCredentialsException - Exception in uk.org.ury.database.exceptions
Exception thrown when the database credentials required to + log into the URY database under a user class are missing, + and thus the log-in cannot continue.
MissingCredentialsException() - +Constructor for exception uk.org.ury.database.exceptions.MissingCredentialsException +
Construct a new MissingCredentialsException with a + default reason. +
MissingCredentialsException(String) - +Constructor for exception uk.org.ury.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 +
Construct a new MissingPropertyException with a + default reason. +
MissingPropertyException(String) - +Constructor for exception uk.org.ury.database.exceptions.MissingPropertyException +
Construct a new MissingPropertyException. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-12.html b/doc/index-files/index-12.html new file mode 100644 index 0000000..d0810f7 --- /dev/null +++ b/doc/index-files/index-12.html @@ -0,0 +1,145 @@ + + + + + + +N-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+N

+
+
NUM_CHANNELS - +Static variable in class uk.org.ury.show.ShowUtils +
The number of channels reserved for show items. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-13.html b/doc/index-files/index-13.html new file mode 100644 index 0000000..a6f269e --- /dev/null +++ b/doc/index-files/index-13.html @@ -0,0 +1,150 @@ + + + + + + +Q-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+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 +
Construct a new QueryFailureException with a + default reason. +
QueryFailureException(String) - +Constructor for exception uk.org.ury.database.exceptions.QueryFailureException +
Construct a new QueryFailureException. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-14.html b/doc/index-files/index-14.html new file mode 100644 index 0000000..f405e56 --- /dev/null +++ b/doc/index-files/index-14.html @@ -0,0 +1,172 @@ + + + + + + +R-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+R

+
+
reportFatal(String, FrontendFrame) - +Static method in class uk.org.ury.frontend.FrontendError +
Create an error dialogue to report a fatal error. +
reportFatal(String, FrontendAppletPanel) - +Static method in class uk.org.ury.frontend.FrontendError +
  +
restoreModule(FrontendModulePanel, FrontendControlPanel) - +Method in class uk.org.ury.frontend.FrontendAppletPanel +
Restore an existing module and control panel into the frontend + frame. +
restoreModule(FrontendModulePanel, FrontendControlPanel) - +Method in class uk.org.ury.frontend.FrontendFrame +
Restore an existing module and control panel into the frontend + frame. +
restoreModule(FrontendModulePanel, FrontendControlPanel) - +Method in interface uk.org.ury.frontend.FrontendMaster +
Restore an existing module and control panel into the frontend + master. +
run() - +Method in class uk.org.ury.testrig.DemoMenu +
Run the demo menu, creating a user interface. +
runFrontend(FrontendMaster) - +Method in interface uk.org.ury.frontend.FrontendModule +
Begin execution of the frontend module. +
runFrontend(FrontendMaster) - +Method in class uk.org.ury.library.viewer.LibraryViewer +
Run the library viewer frontend. +
runFrontend(FrontendMaster) - +Method in class uk.org.ury.show.viewer.ShowViewer +
Run the library viewer frontend. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-15.html b/doc/index-files/index-15.html new file mode 100644 index 0000000..e56cc06 --- /dev/null +++ b/doc/index-files/index-15.html @@ -0,0 +1,199 @@ + + + + + + +S-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+S

+
+
search(DatabaseDriver, String) - +Static method in class uk.org.ury.library.LibraryUtils +
Perform a library search. +
search() - +Method in class uk.org.ury.library.viewer.LibraryViewerPanel +
Action method for performing a search, bound by the UI XML + manifest to the search field and button. +
search() - +Method in class uk.org.ury.show.viewer.ShowViewerPanel +
Initialise the library viewer for the purposes of adding tracks + and/or browsing the library. +
setMaster(FrontendMaster) - +Method in class uk.org.ury.frontend.FrontendPanel +
Set the frontend master. +
setPanels(FrontendModulePanel, FrontendModulePanel) - +Method in class uk.org.ury.frontend.FrontendControlPanel +
Set the parent and child panels that this ControlPanel + facilitates intercommunication. +
setPreviousCPanel(FrontendControlPanel) - +Method in class uk.org.ury.frontend.FrontendControlPanel +
Set the previous control panel (if any), so that it can be + restored when this control panel returns control to the + parent. +
setText(String) - +Method in class uk.org.ury.frontend.FrontendSubBanner +
  +
setTitle(String) - +Method in class uk.org.ury.frontend.FrontendBanner +
Change the title displayed on the banner. +
ShowChannel - Class in uk.org.ury.show
A channel of ShowItems in a show.
ShowChannel() - +Constructor for class uk.org.ury.show.ShowChannel +
Construct a new, empty channel. +
ShowItem - Class in uk.org.ury.show
An item in the show database.
ShowItem(Map<ShowItemProperty, String>) - +Constructor for class uk.org.ury.show.ShowItem +
Construct a new ShowItem. +
ShowItemProperty - Enum in uk.org.ury.show
Enumeration of the parameters that are stored in a ShowItem.
ShowUtils - Class in uk.org.ury.show
A set of common utility routines to facilitate the extraction of + show items from the show storage areas of the URY database.
ShowUtils() - +Constructor for class uk.org.ury.show.ShowUtils +
  +
ShowViewer - Class in uk.org.ury.show.viewer
Frontend module for viewing show details.
ShowViewer() - +Constructor for class uk.org.ury.show.viewer.ShowViewer +
Construct a new ShowViewer as a frontend object. +
ShowViewerPanel - Class in uk.org.ury.show.viewer
Frontend panel providing access to an underlying lshow viewer.
ShowViewerPanel(ShowViewer, FrontendMaster) - +Constructor for class uk.org.ury.show.viewer.ShowViewerPanel +
Construct a new ShowViewerPanel. +
sql - +Variable in enum uk.org.ury.library.LibraryItemProperty +
  +
sql - +Variable in enum uk.org.ury.show.ShowItemProperty +
  +
start() - +Method in class uk.org.ury.library.viewer.LibraryViewer +
Run the library viewer frontend as an applet. +
start() - +Method in class uk.org.ury.show.viewer.ShowViewer +
Run the library viewer frontend as an applet. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-16.html b/doc/index-files/index-16.html new file mode 100644 index 0000000..0e7c50a --- /dev/null +++ b/doc/index-files/index-16.html @@ -0,0 +1,148 @@ + + + + + + +T-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+T

+
+
toString() - +Method in class uk.org.ury.show.ShowItem +
  +
TrackBin - Class in uk.org.ury.show.viewer
A panel displaying track bin contents.
TrackBin(String) - +Constructor for class uk.org.ury.show.viewer.TrackBin +
Construct a new TrackBin. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-17.html b/doc/index-files/index-17.html new file mode 100644 index 0000000..91dc96d --- /dev/null +++ b/doc/index-files/index-17.html @@ -0,0 +1,149 @@ + + + + + + +U-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+U

+
+
UICreationFailureException - Exception in uk.org.ury.frontend.exceptions
Exception thrown when the creation of a UI element fails.
UICreationFailureException() - +Constructor for exception uk.org.ury.frontend.exceptions.UICreationFailureException +
Construct a new UICreationFailureException with a + default reason. +
UICreationFailureException(String) - +Constructor for exception uk.org.ury.frontend.exceptions.UICreationFailureException +
Construct a new UICreationFailureException. +
uk.org.ury.config - package uk.org.ury.config
 
uk.org.ury.database - package uk.org.ury.database
 
uk.org.ury.database.exceptions - package uk.org.ury.database.exceptions
 
uk.org.ury.frontend - package uk.org.ury.frontend
 
uk.org.ury.frontend.exceptions - package uk.org.ury.frontend.exceptions
 
uk.org.ury.library - package uk.org.ury.library
 
uk.org.ury.library.exceptions - package uk.org.ury.library.exceptions
 
uk.org.ury.library.viewer - package uk.org.ury.library.viewer
 
uk.org.ury.show - package uk.org.ury.show
 
uk.org.ury.show.viewer - package uk.org.ury.show.viewer
 
uk.org.ury.testrig - package uk.org.ury.testrig
 
UserClass - Enum in uk.org.ury.database
The various user classes of the database driver.
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-18.html b/doc/index-files/index-18.html new file mode 100644 index 0000000..2d007e7 --- /dev/null +++ b/doc/index-files/index-18.html @@ -0,0 +1,163 @@ + + + + + + +V-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+V

+
+
valueOf(String) - +Static method in enum uk.org.ury.database.UserClass +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum uk.org.ury.library.LibraryItemProperty +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum uk.org.ury.show.ShowItemProperty +
Returns the enum constant of this type with the specified name. +
values() - +Static method in enum uk.org.ury.database.UserClass +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum uk.org.ury.library.LibraryItemProperty +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum uk.org.ury.show.ShowItemProperty +
Returns an array containing the constants of this enum type, in +the order they are declared. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-2.html b/doc/index-files/index-2.html new file mode 100644 index 0000000..a4248ea --- /dev/null +++ b/doc/index-files/index-2.html @@ -0,0 +1,148 @@ + + + + + + +B-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+B

+
+
back() - +Method in class uk.org.ury.show.viewer.LibraryControlPanel +
Go back to the previous module. +
back() - +Method in class uk.org.ury.testrig.DemoControlPanel +
Go back to the previous module. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-3.html b/doc/index-files/index-3.html new file mode 100644 index 0000000..5bfa492 --- /dev/null +++ b/doc/index-files/index-3.html @@ -0,0 +1,160 @@ + + + + + + +C-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+C

+
+
ChannelPanel - Class in uk.org.ury.show.viewer
A panel displaying channel informstion.
ChannelPanel(int, ShowChannel) - +Constructor for class uk.org.ury.show.viewer.ChannelPanel +
Construct a new ChannelPanel. +
configName - +Variable in enum uk.org.ury.database.UserClass +
The name of the tag in the configuration file that contains + the credentials for this user class. +
ConfigReader - Class in uk.org.ury.config
Reads in an XML config file and creates config objects
ConfigReader(String) - +Constructor for class uk.org.ury.config.ConfigReader +
Read in the config file and create the Database and Auth configuration objects. +
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 +
Construct a new ConnectionFailureException with a + default reason. +
ConnectionFailureException(String) - +Constructor for exception uk.org.ury.database.exceptions.ConnectionFailureException +
Construct a new ConnectionFailureException. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-4.html b/doc/index-files/index-4.html new file mode 100644 index 0000000..392ef08 --- /dev/null +++ b/doc/index-files/index-4.html @@ -0,0 +1,167 @@ + + + + + + +D-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+D

+
+
Database - Class in uk.org.ury.config
A Database Server configuration
Database(String, int, String) - +Constructor for class uk.org.ury.config.Database +
Create a database object +
DatabaseDriver - Class in uk.org.ury.database
A database connection manager that connects to the URY databases + using suitably privileged accounts, and handles the processing + of SQL queries.
DatabaseDriver(ConfigReader, UserClass) - +Constructor for class uk.org.ury.database.DatabaseDriver +
Construct a new DatabaseDriver with the given user class. +
DatabaseItem<E,T> - Class in uk.org.ury.database
An abstract class presenting a template for objects serving as + a data structure for collections of properties retrieved from + a SQL database.
DatabaseItem(Map<E, T>) - +Constructor for class uk.org.ury.database.DatabaseItem +
Construct a new item from an existing list of properties. +
DemoControlPanel - Class in uk.org.ury.testrig
Control panel for the demo system.
DemoControlPanel() - +Constructor for class uk.org.ury.testrig.DemoControlPanel +
Constructs a new DemoControlPanel. +
DemoMenu - Class in uk.org.ury.testrig
Application frontend, for testing early-stage frontend code.
DemoMenu() - +Constructor for class uk.org.ury.testrig.DemoMenu +
  +
DemoMenuPanel - Class in uk.org.ury.testrig
 
DemoMenuPanel(FrontendMaster) - +Constructor for class uk.org.ury.testrig.DemoMenuPanel +
Construct a new DemoMenuPanel. +
doSearch(String) - +Method in class uk.org.ury.library.viewer.LibraryViewer +
Do a library search. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-5.html b/doc/index-files/index-5.html new file mode 100644 index 0000000..17a9150 --- /dev/null +++ b/doc/index-files/index-5.html @@ -0,0 +1,156 @@ + + + + + + +E-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+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 +
Construct a new EmptySearchException with a + default reason. +
EmptySearchException(String) - +Constructor for exception uk.org.ury.library.exceptions.EmptySearchException +
Construct a new EmptySearchException. +
executeQuery(String, int) - +Method in class uk.org.ury.database.DatabaseDriver +
Execute an unprepared SQL statement with no arguments. +
executeQuery(String, Object[], int) - +Method in class uk.org.ury.database.DatabaseDriver +
Perform a SQL statement with arguments. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-6.html b/doc/index-files/index-6.html new file mode 100644 index 0000000..d73164c --- /dev/null +++ b/doc/index-files/index-6.html @@ -0,0 +1,189 @@ + + + + + + +F-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+F

+
+
fatalError(String) - +Method in class uk.org.ury.frontend.FrontendAppletPanel +
Report a fatal error, +
fatalError(String) - +Method in class uk.org.ury.frontend.FrontendFrame +
Report a fatal error, +
fatalError(String) - +Method in interface uk.org.ury.frontend.FrontendMaster +
Report a fatal error, +
FrontendAppletPanel - Class in uk.org.ury.frontend
A frame that hosts a FrontendModulePanel, used for serving frontend + panels in a window (application mode).
FrontendAppletPanel(FrontendModulePanel) - +Constructor for class uk.org.ury.frontend.FrontendAppletPanel +
  +
FrontendBanner - Class in uk.org.ury.frontend
A banner, displaying a title, intended for use at the top of the + frontend frame.
FrontendBanner(String) - +Constructor for class uk.org.ury.frontend.FrontendBanner +
Construct a new banner. +
FrontendControlPanel - Class in uk.org.ury.frontend
Abstract class for frontend module control panels.
FrontendControlPanel(String) - +Constructor for class uk.org.ury.frontend.FrontendControlPanel +
Alternative constructor allowing an XML file to be used to + create the layout of the ControlPanel. +
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(FrontendModulePanel) - +Constructor for class uk.org.ury.frontend.FrontendFrame +
  +
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) - +Constructor for class uk.org.ury.frontend.FrontendModulePanel +
Construct a new, blank FrontendModulePanel. +
FrontendModulePanel(FrontendModule, String, FrontendMaster) - +Constructor for class uk.org.ury.frontend.FrontendModulePanel +
Construct a FrontendModulePanel using an XML layout manifest. +
FrontendPanel - Class in uk.org.ury.frontend
An extension of JPanel providing common functionality for user + interface panels in the URY system frontend.
FrontendPanel(FrontendMaster) - +Constructor for class uk.org.ury.frontend.FrontendPanel +
Construct a new, blank FrontendPanel. +
FrontendPanel(String, FrontendMaster) - +Constructor for class uk.org.ury.frontend.FrontendPanel +
Construct a new FrontendPanel from an XML layout. +
FrontendSubBanner - Class in uk.org.ury.frontend
A banner, displaying a title, intended for use at the top of + subsections.
FrontendSubBanner() - +Constructor for class uk.org.ury.frontend.FrontendSubBanner +
Construct a new FrontendSubBanner. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-7.html b/doc/index-files/index-7.html new file mode 100644 index 0000000..f6447e1 --- /dev/null +++ b/doc/index-files/index-7.html @@ -0,0 +1,224 @@ + + + + + + +G-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+G

+
+
get(E) - +Method in class uk.org.ury.database.DatabaseItem +
Query this item for a property. +
get(int) - +Method in class uk.org.ury.show.ShowChannel +
Retrieve an item from the channel. +
getBins() - +Method in class uk.org.ury.show.viewer.ShowViewer +
  +
getChannelList(DatabaseDriver, int, int) - +Static method in class uk.org.ury.show.ShowUtils +
Given a show and a channel, retrieve a list of all show items + bound to that channel for the show. +
getChannels() - +Method in class uk.org.ury.show.viewer.ShowViewer +
  +
getColumnClass(int) - +Method in class uk.org.ury.library.LibraryTableModel +
  +
getColumnCount() - +Method in class uk.org.ury.library.LibraryTableModel +
  +
getColumnName(int) - +Method in class uk.org.ury.library.LibraryTableModel +
  +
getDatabase() - +Method in class uk.org.ury.config.ConfigReader +
Get the database configuration +
getDb() - +Method in class uk.org.ury.config.Database +
Get the name of the database +
getElementAt(int) - +Method in class uk.org.ury.show.ShowChannel +
List model retrieval wrapper for get. +
getHost() - +Method in class uk.org.ury.config.Database +
Get the hostname of the database server +
getLibraryList() - +Method in class uk.org.ury.library.viewer.LibraryViewer +
  +
getModule() - +Method in class uk.org.ury.frontend.FrontendModulePanel +
Retrieve the module that this panel is serving as a view into. +
getName() - +Method in class uk.org.ury.frontend.FrontendModulePanel +
  +
getName() - +Method in class uk.org.ury.library.viewer.LibraryViewerPanel +
  +
getName() - +Method in class uk.org.ury.show.viewer.ShowViewerPanel +
  +
getName() - +Method in class uk.org.ury.testrig.DemoMenuPanel +
  +
getPass() - +Method in class uk.org.ury.config.Auth +
Get the password of the login +
getPort() - +Method in class uk.org.ury.config.Database +
Get the port the database server is running on +
getPublicFolders(DatabaseDriver) - +Static method in class uk.org.ury.show.ShowUtils +
Return the names of the public track folders, or "bins". +
getRoAuth() - +Method in class uk.org.ury.config.ConfigReader +
Get the read only login auth configuration +
getRowCount() - +Method in class uk.org.ury.library.LibraryTableModel +
  +
getRwAuth() - +Method in class uk.org.ury.config.ConfigReader +
Get the read write login auth configuration +
getSize() - +Method in class uk.org.ury.show.ShowChannel +
  +
getUser() - +Method in class uk.org.ury.config.Auth +
Get the username of the login +
getValueAt(int, int) - +Method in class uk.org.ury.library.LibraryTableModel +
  +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-8.html b/doc/index-files/index-8.html new file mode 100644 index 0000000..285f452 --- /dev/null +++ b/doc/index-files/index-8.html @@ -0,0 +1,152 @@ + + + + + + +H-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+H

+
+
has(E) - +Method in class uk.org.ury.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() - +Constructor for class uk.org.ury.frontend.HintField +
Construct a new HintField with no initial hint. +
HintField(String) - +Constructor for class uk.org.ury.frontend.HintField +
Construct a new HintField. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index-files/index-9.html b/doc/index-files/index-9.html new file mode 100644 index 0000000..3b1e941 --- /dev/null +++ b/doc/index-files/index-9.html @@ -0,0 +1,154 @@ + + + + + + +I-Index + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+

+I

+
+
init() - +Method in class uk.org.ury.frontend.AbstractFrontendModule +
Initialise the module as an applet. +
init() - +Method in class uk.org.ury.library.viewer.LibraryViewer +
Initialise the library viewer frontend as an applet. +
init() - +Method in class uk.org.ury.show.viewer.ShowViewer +
Initialise the library viewer frontend as an applet. +
init() - +Method in class uk.org.ury.testrig.DemoMenu +
Initialise the menu as an applet. +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N Q R S T U V
+ + + diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..158e2d8 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,39 @@ + + + + + + +Generated Documentation (Untitled) + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/doc/overview-frame.html b/doc/overview-frame.html new file mode 100644 index 0000000..785bbe5 --- /dev/null +++ b/doc/overview-frame.html @@ -0,0 +1,62 @@ + + + + + + +Overview List + + + + + + + + + + + + + + + +
+
+ + + + + +
All Classes +

+ +Packages +
+uk.org.ury.config +
+uk.org.ury.database +
+uk.org.ury.database.exceptions +
+uk.org.ury.frontend +
+uk.org.ury.frontend.exceptions +
+uk.org.ury.library +
+uk.org.ury.library.exceptions +
+uk.org.ury.library.viewer +
+uk.org.ury.show +
+uk.org.ury.show.viewer +
+uk.org.ury.testrig +
+

+ +

+  + + diff --git a/doc/overview-summary.html b/doc/overview-summary.html new file mode 100644 index 0000000..a6deb18 --- /dev/null +++ b/doc/overview-summary.html @@ -0,0 +1,191 @@ + + + + + + +Overview + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
 Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages
uk.org.ury.config 
uk.org.ury.database 
uk.org.ury.database.exceptions 
uk.org.ury.frontend 
uk.org.ury.frontend.exceptions 
uk.org.ury.library 
uk.org.ury.library.exceptions 
uk.org.ury.library.viewer 
uk.org.ury.show 
uk.org.ury.show.viewer 
uk.org.ury.testrig 
+ +

+ 

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
 Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/overview-tree.html b/doc/overview-tree.html new file mode 100644 index 0000000..e85da6d --- /dev/null +++ b/doc/overview-tree.html @@ -0,0 +1,227 @@ + + + + + + +Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
uk.org.ury.config, uk.org.ury.database, uk.org.ury.database.exceptions, uk.org.ury.frontend, uk.org.ury.frontend.exceptions, uk.org.ury.library, uk.org.ury.library.exceptions, uk.org.ury.library.viewer, uk.org.ury.show, uk.org.ury.show.viewer, uk.org.ury.testrig
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/package-list b/doc/package-list new file mode 100644 index 0000000..651f7ca --- /dev/null +++ b/doc/package-list @@ -0,0 +1,11 @@ +uk.org.ury.config +uk.org.ury.database +uk.org.ury.database.exceptions +uk.org.ury.frontend +uk.org.ury.frontend.exceptions +uk.org.ury.library +uk.org.ury.library.exceptions +uk.org.ury.library.viewer +uk.org.ury.show +uk.org.ury.show.viewer +uk.org.ury.testrig diff --git a/doc/resources/inherit.gif b/doc/resources/inherit.gif new file mode 100644 index 0000000..c814867 Binary files /dev/null and b/doc/resources/inherit.gif differ diff --git a/doc/serialized-form.html b/doc/serialized-form.html new file mode 100644 index 0000000..b98d4ce --- /dev/null +++ b/doc/serialized-form.html @@ -0,0 +1,1050 @@ + + + + + + +Serialized Form + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Serialized Form

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

+ + + + + +
+Class uk.org.ury.database.exceptions.ConnectionFailureException extends java.lang.Exception implements Serializable
+ +

+serialVersionUID: -7353531873142099828L + +

+ +

+ + + + + +
+Class uk.org.ury.database.exceptions.MissingCredentialsException extends java.lang.Exception implements Serializable
+ +

+serialVersionUID: -397479334359858162L + +

+ +

+ + + + + +
+Class uk.org.ury.database.exceptions.MissingPropertyException extends java.lang.Exception implements Serializable
+ +

+serialVersionUID: -7353531873142099828L + +

+ +

+ + + + + +
+Class uk.org.ury.database.exceptions.QueryFailureException extends java.lang.Exception implements Serializable
+ +

+serialVersionUID: -7353531873142099828L + +

+

+ + + + + +
+Package uk.org.ury.frontend
+ +

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

+serialVersionUID: 5309585577127763538L + +

+ +

+ + + + + +
+Class uk.org.ury.frontend.FrontendAppletPanel extends javax.swing.JFrame implements Serializable
+ +

+serialVersionUID: 740928181256928433L + +

+ + + + + +
+Serialized Fields
+ +

+banner

+
+FrontendBanner banner
+
+
+
+
+
+

+child

+
+FrontendModulePanel child
+
+
+
+
+
+

+cpanel

+
+FrontendControlPanel cpanel
+
+
+
+
+ +

+ + + + + +
+Class uk.org.ury.frontend.FrontendBanner extends javax.swing.JPanel implements Serializable
+ +

+serialVersionUID: -3636933349004358394L + +

+ + + + + +
+Serialized Fields
+ +

+titleLabel

+
+javax.swing.JLabel titleLabel
+
+
+
+
+ +

+ + + + + +
+Class uk.org.ury.frontend.FrontendControlPanel extends FrontendPanel implements Serializable
+ +

+serialVersionUID: -5628250552779928189L + +

+ + + + + +
+Serialized Fields
+ +

+prevCPanel

+
+FrontendControlPanel prevCPanel
+
+
+
+
+
+

+parent

+
+FrontendModulePanel parent
+
+
+
+
+
+

+child

+
+FrontendModulePanel child
+
+
+
+
+ +

+ + + + + +
+Class uk.org.ury.frontend.FrontendFrame extends javax.swing.JFrame implements Serializable
+ +

+serialVersionUID: 740928181256928433L + +

+ + + + + +
+Serialized Fields
+ +

+banner

+
+FrontendBanner banner
+
+
+
+
+
+

+child

+
+FrontendModulePanel child
+
+
+
+
+
+

+cpanel

+
+FrontendControlPanel cpanel
+
+
+
+
+ +

+ + + + + +
+Class uk.org.ury.frontend.FrontendModulePanel extends FrontendPanel implements Serializable
+ +

+serialVersionUID: 5616222530691425635L + +

+ + + + + +
+Serialized Fields
+ +

+module

+
+FrontendModule module
+
+
+
+
+ +

+ + + + + +
+Class uk.org.ury.frontend.FrontendPanel extends javax.swing.JPanel implements Serializable
+ +

+serialVersionUID: -4481079599056565279L + +

+ + + + + +
+Serialized Fields
+ +

+master

+
+FrontendMaster master
+
+
+
+
+ +

+ + + + + +
+Class uk.org.ury.frontend.FrontendSubBanner extends javax.swing.JLabel implements Serializable
+ +

+serialVersionUID: 7843563245601622086L + +

+ +

+ + + + + +
+Class uk.org.ury.frontend.HintField extends javax.swing.JTextArea implements Serializable
+ +

+serialVersionUID: -6221888920919127273L + +

+

+ + + + + +
+Package uk.org.ury.frontend.exceptions
+ +

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

+serialVersionUID: -7353531873142099828L + +

+

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

+ + + + + +
+Class uk.org.ury.library.LibraryTableModel extends javax.swing.table.AbstractTableModel implements Serializable
+ +

+serialVersionUID: -1744980619128903509L + +

+ + + + + +
+Serialized Fields
+ +

+data

+
+java.util.List<E> data
+
+
+
+
+
+ + + + + +
+Package uk.org.ury.library.exceptions
+ +

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

+serialVersionUID: -397479334359858162L + +

+

+ + + + + +
+Package uk.org.ury.library.viewer
+ +

+ + + + + +
+Class uk.org.ury.library.viewer.LibraryViewer extends AbstractFrontendModule implements Serializable
+ +

+serialVersionUID: -2782366476480563739L + +

+ + + + + +
+Serialized Fields
+ +

+dd

+
+DatabaseDriver dd
+
+
+
+
+
+

+libraryList

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

+panel

+
+LibraryViewerPanel panel
+
+
+
+
+
+

+config

+
+ConfigReader config
+
+
+
+
+ +

+ + + + + +
+Class uk.org.ury.library.viewer.LibraryViewerPanel extends FrontendModulePanel implements Serializable
+ +

+serialVersionUID: -2441616418398056712L + +

+ + + + + +
+Serialized Fields
+ +

+resultsTable

+
+javax.swing.JTable resultsTable
+
+
+
+
+
+

+resultsPane

+
+javax.swing.JScrollPane resultsPane
+
+
+
+
+
+

+messagePanel

+
+javax.swing.JPanel messagePanel
+
+
+
+
+
+

+messageLabel

+
+javax.swing.JLabel messageLabel
+
+
+
+
+
+

+searchingPanel

+
+javax.swing.JPanel searchingPanel
+
+
+
+
+
+

+searchField

+
+javax.swing.JTextField searchField
+
+
+
+
+
+

+searchButton

+
+javax.swing.JButton searchButton
+
+
+
+
+
+

+searchFailureMessage

+
+java.lang.String searchFailureMessage
+
+
+
+
+
+ + + + + +
+Package uk.org.ury.show
+ +

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

+serialVersionUID: -4651104185166068150L + +

+ + + + + +
+Serialized Fields
+ +

+items

+
+java.util.List<E> items
+
+
+
+
+
+ + + + + +
+Package uk.org.ury.show.viewer
+ +

+ + + + + +
+Class uk.org.ury.show.viewer.ChannelPanel extends javax.swing.JPanel implements Serializable
+ +

+serialVersionUID: 897125684384350966L + +

+ + + + + +
+Serialized Fields
+ +

+channelName

+
+javax.swing.JLabel channelName
+
+
+
+
+
+

+itemList

+
+javax.swing.JList itemList
+
+
+
+
+
+

+playButton

+
+javax.swing.JButton playButton
+
+
+
+
+
+

+pauseButton

+
+javax.swing.JButton pauseButton
+
+
+
+
+
+

+stopButton

+
+javax.swing.JButton stopButton
+
+
+
+
+ +

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

+serialVersionUID: -4260057656619439704L + +

+ +

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

+serialVersionUID: -2782366476480563739L + +

+ + + + + +
+Serialized Fields
+ +

+dd

+
+DatabaseDriver dd
+
+
+
+
+
+

+channels

+
+ShowChannel[] channels
+
+
+
+
+
+

+panel

+
+ShowViewerPanel panel
+
+
+
+
+
+

+config

+
+ConfigReader config
+
+
+
+
+ +

+ + + + + +
+Class uk.org.ury.show.viewer.ShowViewerPanel extends FrontendModulePanel implements Serializable
+ +

+serialVersionUID: -2441616418398056712L + +

+ + + + + +
+Serialized Fields
+ +

+channelGroupPanel

+
+javax.swing.JPanel channelGroupPanel
+
+
+
+
+
+

+binGroupPanel

+
+javax.swing.JPanel binGroupPanel
+
+
+
+
+ +

+ + + + + +
+Class uk.org.ury.show.viewer.TrackBin extends javax.swing.JPanel implements Serializable
+ +

+serialVersionUID: -5414923374901972511L + +

+ + + + + +
+Serialized Fields
+ +

+binName

+
+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.DemoMenu extends javax.swing.JApplet implements Serializable
+ +

+serialVersionUID: -5264235507636809476L + +

+ + + + + +
+Serialized Fields
+ +

+master

+
+FrontendMaster master
+
+
+
+
+ +

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

+serialVersionUID: 5268978856289909262L + +

+ +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/stylesheet.css b/doc/stylesheet.css new file mode 100644 index 0000000..6ea9e51 --- /dev/null +++ b/doc/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/doc/uk/org/ury/config/Auth.html b/doc/uk/org/ury/config/Auth.html new file mode 100644 index 0000000..7413bf2 --- /dev/null +++ b/doc/uk/org/ury/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.config +
+Class Auth

+
+java.lang.Object
+  extended by uk.org.ury.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/config/ConfigReader.html b/doc/uk/org/ury/config/ConfigReader.html new file mode 100644 index 0000000..6c49f23 --- /dev/null +++ b/doc/uk/org/ury/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.config +
+Class ConfigReader

+
+java.lang.Object
+  extended by uk.org.ury.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/config/Database.html b/doc/uk/org/ury/config/Database.html new file mode 100644 index 0000000..521acf8 --- /dev/null +++ b/doc/uk/org/ury/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.config +
+Class Database

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

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

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

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

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

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

+
+ + + + + + + + + +
+Packages that use ConfigReader
uk.org.ury.database  
+  +

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

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

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

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

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

+ + + + + + + + + +
Methods in uk.org.ury.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/config/package-frame.html b/doc/uk/org/ury/config/package-frame.html new file mode 100644 index 0000000..d6cd433 --- /dev/null +++ b/doc/uk/org/ury/config/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +uk.org.ury.config + + + + + + + + + + + +uk.org.ury.config + + + + +
+Classes  + +
+Auth +
+ConfigReader +
+Database
+ + + + diff --git a/doc/uk/org/ury/config/package-summary.html b/doc/uk/org/ury/config/package-summary.html new file mode 100644 index 0000000..5b97c6b --- /dev/null +++ b/doc/uk/org/ury/config/package-summary.html @@ -0,0 +1,165 @@ + + + + + + +uk.org.ury.config + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

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

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

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

+Uses of Package
uk.org.ury.config

+
+ + + + + + + + + + + + + +
+Packages that use uk.org.ury.config
uk.org.ury.config  
uk.org.ury.database  
+  +

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

+ + + + + + + + +
+Classes in uk.org.ury.config used by uk.org.ury.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/database/DatabaseDriver.html b/doc/uk/org/ury/database/DatabaseDriver.html new file mode 100644 index 0000000..4527254 --- /dev/null +++ b/doc/uk/org/ury/database/DatabaseDriver.html @@ -0,0 +1,322 @@ + + + + + + +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.database +
+Class DatabaseDriver

+
+java.lang.Object
+  extended by uk.org.ury.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/database/DatabaseItem.html b/doc/uk/org/ury/database/DatabaseItem.html new file mode 100644 index 0000000..7223386 --- /dev/null +++ b/doc/uk/org/ury/database/DatabaseItem.html @@ -0,0 +1,299 @@ + + + + + + +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.database +
+Class DatabaseItem<E,T>

+
+java.lang.Object
+  extended by uk.org.ury.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
+ 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.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/database/UserClass.html b/doc/uk/org/ury/database/UserClass.html new file mode 100644 index 0000000..9a96ac2 --- /dev/null +++ b/doc/uk/org/ury/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.database +
+Enum UserClass

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

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

+
+ + + + + + + + + + + + + +
+Packages that use DatabaseDriver
uk.org.ury.library  
uk.org.ury.show  
+  +

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

+ + + + + + + + + +
Methods in uk.org.ury.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.show
+  +

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

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

+
+ + + + + + + + + + + + + +
+Packages that use DatabaseItem
uk.org.ury.library  
uk.org.ury.show  
+  +

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

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

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

+ + + + + + + + + +
Subclasses of DatabaseItem in uk.org.ury.show
+ 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/database/class-use/UserClass.html b/doc/uk/org/ury/database/class-use/UserClass.html new file mode 100644 index 0000000..cf5ee95 --- /dev/null +++ b/doc/uk/org/ury/database/class-use/UserClass.html @@ -0,0 +1,204 @@ + + + + + + +Uses of Class uk.org.ury.database.UserClass + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

+
+ + + + + + + + + +
+Packages that use UserClass
uk.org.ury.database  
+  +

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

+ + + + + + + + + + + + + +
Methods in uk.org.ury.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.database with parameters of type UserClass
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/database/exceptions/ConnectionFailureException.html b/doc/uk/org/ury/database/exceptions/ConnectionFailureException.html new file mode 100644 index 0000000..d0cd1f3 --- /dev/null +++ b/doc/uk/org/ury/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.database.exceptions +
+Class ConnectionFailureException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.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/database/exceptions/MissingCredentialsException.html b/doc/uk/org/ury/database/exceptions/MissingCredentialsException.html new file mode 100644 index 0000000..4d22eed --- /dev/null +++ b/doc/uk/org/ury/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.database.exceptions +
+Class MissingCredentialsException

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

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.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/database/exceptions/QueryFailureException.html b/doc/uk/org/ury/database/exceptions/QueryFailureException.html new file mode 100644 index 0000000..91bd6b3 --- /dev/null +++ b/doc/uk/org/ury/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.database.exceptions +
+Class QueryFailureException

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

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

+
+ + + + + + + + + +
+Packages that use ConnectionFailureException
uk.org.ury.database  
+  +

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

+ + + + + + + + +
Constructors in uk.org.ury.database that throw ConnectionFailureException
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/database/exceptions/class-use/MissingCredentialsException.html b/doc/uk/org/ury/database/exceptions/class-use/MissingCredentialsException.html new file mode 100644 index 0000000..25e5d29 --- /dev/null +++ b/doc/uk/org/ury/database/exceptions/class-use/MissingCredentialsException.html @@ -0,0 +1,206 @@ + + + + + + +Uses of Class uk.org.ury.database.exceptions.MissingCredentialsException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

+
+ + + + + + + + + + + + + +
+Packages that use MissingCredentialsException
uk.org.ury.config  
uk.org.ury.database  
+  +

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

+ + + + + + + + +
Constructors in uk.org.ury.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.database
+  +

+ + + + + + + + +
Constructors in uk.org.ury.database that throw MissingCredentialsException
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/database/exceptions/class-use/MissingPropertyException.html b/doc/uk/org/ury/database/exceptions/class-use/MissingPropertyException.html new file mode 100644 index 0000000..208c82b --- /dev/null +++ b/doc/uk/org/ury/database/exceptions/class-use/MissingPropertyException.html @@ -0,0 +1,180 @@ + + + + + + +Uses of Class uk.org.ury.database.exceptions.MissingPropertyException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

+
+ + + + + + + + + +
+Packages that use MissingPropertyException
uk.org.ury.database  
+  +

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

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

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

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use QueryFailureException
uk.org.ury.library  
uk.org.ury.library.viewer  
uk.org.ury.show  
uk.org.ury.show.viewer  
+  +

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

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

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

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

+ + + + + + + + + + + + + +
Methods in uk.org.ury.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.show.viewer
+  +

+ + + + + + + + + +
Methods in uk.org.ury.show.viewer 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/database/exceptions/package-frame.html b/doc/uk/org/ury/database/exceptions/package-frame.html new file mode 100644 index 0000000..efb585b --- /dev/null +++ b/doc/uk/org/ury/database/exceptions/package-frame.html @@ -0,0 +1,38 @@ + + + + + + +uk.org.ury.database.exceptions + + + + + + + + + + + +uk.org.ury.database.exceptions + + + + +
+Exceptions  + +
+ConnectionFailureException +
+MissingCredentialsException +
+MissingPropertyException +
+QueryFailureException
+ + + + diff --git a/doc/uk/org/ury/database/exceptions/package-summary.html b/doc/uk/org/ury/database/exceptions/package-summary.html new file mode 100644 index 0000000..bc46e69 --- /dev/null +++ b/doc/uk/org/ury/database/exceptions/package-summary.html @@ -0,0 +1,174 @@ + + + + + + +uk.org.ury.database.exceptions + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

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

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

+

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

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

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

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use uk.org.ury.database.exceptions
uk.org.ury.config  
uk.org.ury.database  
uk.org.ury.library  
uk.org.ury.library.viewer  
uk.org.ury.show  
uk.org.ury.show.viewer  
+  +

+ + + + + + + + +
+Classes in uk.org.ury.database.exceptions used by uk.org.ury.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.database.exceptions used by uk.org.ury.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.database.exceptions used by uk.org.ury.library
QueryFailureException + +
+          Exception thrown when the database backend fails to execute + a query.
+  +

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

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

+ + + + + + + + +
+Classes in uk.org.ury.database.exceptions used by uk.org.ury.show.viewer
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/database/package-frame.html b/doc/uk/org/ury/database/package-frame.html new file mode 100644 index 0000000..415958a --- /dev/null +++ b/doc/uk/org/ury/database/package-frame.html @@ -0,0 +1,45 @@ + + + + + + +uk.org.ury.database + + + + + + + + + + + +uk.org.ury.database + + + + +
+Classes  + +
+DatabaseDriver +
+DatabaseItem
+ + + + + + +
+Enums  + +
+UserClass
+ + + + diff --git a/doc/uk/org/ury/database/package-summary.html b/doc/uk/org/ury/database/package-summary.html new file mode 100644 index 0000000..cf09ad9 --- /dev/null +++ b/doc/uk/org/ury/database/package-summary.html @@ -0,0 +1,179 @@ + + + + + + +uk.org.ury.database + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.database +

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

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

+Uses of Package
uk.org.ury.database

+
+ + + + + + + + + + + + + + + + + +
+Packages that use uk.org.ury.database
uk.org.ury.database  
uk.org.ury.library  
uk.org.ury.show  
+  +

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

+ + + + + + + + + + + +
+Classes in uk.org.ury.database used by uk.org.ury.library
DatabaseDriver + +
+          A database connection manager that connects to the URY databases + using suitably privileged accounts, and handles the processing + of SQL queries.
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.database used by uk.org.ury.show
DatabaseDriver + +
+          A database connection manager that connects to the URY databases + using suitably privileged accounts, and handles the processing + of SQL queries.
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/frontend/AbstractFrontendModule.html b/doc/uk/org/ury/frontend/AbstractFrontendModule.html new file mode 100644 index 0000000..ed3e866 --- /dev/null +++ b/doc/uk/org/ury/frontend/AbstractFrontendModule.html @@ -0,0 +1,376 @@ + + + + + + +AbstractFrontendModule + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend +
+Class AbstractFrontendModule

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

+An abstract implementation of the FrontendModule interface. +

+ +

+

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

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

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

+AbstractFrontendModule

+
+public AbstractFrontendModule()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

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

+

+
Overrides:
init in class java.applet.Applet
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/FrontendAppletPanel.html b/doc/uk/org/ury/frontend/FrontendAppletPanel.html new file mode 100644 index 0000000..c382fa0 --- /dev/null +++ b/doc/uk/org/ury/frontend/FrontendAppletPanel.html @@ -0,0 +1,495 @@ + + + + + + +FrontendAppletPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend +
+Class FrontendAppletPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by java.awt.Window
+              extended by java.awt.Frame
+                  extended by javax.swing.JFrame
+                      extended by uk.org.ury.frontend.FrontendAppletPanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, FrontendMaster
+
+
+
+
public class FrontendAppletPanel
extends javax.swing.JFrame
implements FrontendMaster
+ + +

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

+ +

+

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

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JFrame
EXIT_ON_CLOSE
+  + + + + + + + +
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
FrontendAppletPanel(FrontendModulePanel parent) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidfatalError(java.lang.String message) + +
+          Report a fatal error,
+ voidloadModule(java.lang.String moduleName) + +
+          Load a module into the frontend frame.
+ voidloadModule(java.lang.String moduleName, + java.lang.String cPanelName) + +
+          Load a module into the frontend frame, additionally installing + a control panel to communicate with the previous module.
+ voidrestoreModule(FrontendModulePanel mpanel, + FrontendControlPanel cpanel) + +
+          Restore an existing module and control panel into the frontend + frame.
+  + + + + + + + +
Methods inherited from class javax.swing.JFrame
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
+  + + + + + + + +
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
+  + + + + + + + +
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
+  +

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

+FrontendAppletPanel

+
+public FrontendAppletPanel(FrontendModulePanel parent)
+
+
+ + + + + + + + +
+Method Detail
+ +

+loadModule

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

+

+
Specified by:
loadModule in interface FrontendMaster
+
+
+
Parameters:
moduleName - The fully qualified class-name of the module, + minus the leading "uk.org.ury." domain.
+
+
+
+ +

+loadModule

+
+public void loadModule(java.lang.String moduleName,
+                       java.lang.String cPanelName)
+
+
Load a module into the frontend frame, additionally installing + a control panel to communicate with the previous module. + + 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.
+
+
+
+ +

+restoreModule

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

+

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

+fatalError

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

+

+
Specified by:
fatalError in interface FrontendMaster
+
+
+
Parameters:
message - The message, eg the exception message, to report + to the user.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/FrontendBanner.html b/doc/uk/org/ury/frontend/FrontendBanner.html new file mode 100644 index 0000000..07f7a10 --- /dev/null +++ b/doc/uk/org/ury/frontend/FrontendBanner.html @@ -0,0 +1,375 @@ + + + + + + +FrontendBanner + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend +
+Class FrontendBanner

+
+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.FrontendBanner
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
+
public class FrontendBanner
extends javax.swing.JPanel
+ + +

+A banner, displaying a title, intended for use at the top of the + frontend frame. +

+ +

+

+
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
FrontendBanner(java.lang.String title) + +
+          Construct a new banner.
+  + + + + + + + + + + + +
+Method Summary
+ voidsetTitle(java.lang.String title) + +
+          Change the title displayed on the banner.
+  + + + + + + + +
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
+ +

+FrontendBanner

+
+public FrontendBanner(java.lang.String title)
+
+
Construct a new banner. +

+

+
Parameters:
title - The initial title to display in the banner.
+
+ + + + + + + + +
+Method Detail
+ +

+setTitle

+
+public void setTitle(java.lang.String title)
+
+
Change the title displayed on the banner. +

+

+
Parameters:
title - The new title to display.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/FrontendControlPanel.html b/doc/uk/org/ury/frontend/FrontendControlPanel.html new file mode 100644 index 0000000..f8bc49b --- /dev/null +++ b/doc/uk/org/ury/frontend/FrontendControlPanel.html @@ -0,0 +1,436 @@ + + + + + + +FrontendControlPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend +
+Class FrontendControlPanel

+
+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
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
Direct Known Subclasses:
DemoControlPanel, LibraryControlPanel
+
+
+
+
public abstract class FrontendControlPanel
extends FrontendPanel
+ + +

+Abstract class for frontend module control panels. + + Control panels are installed as a means of exposing module + intercommunication to the user. For example, when the library + viewer is launched from the playout module, a control panel + is installed allowing the user to add library items to the + playout 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
FrontendControlPanel(java.lang.String xmlPath) + +
+          Alternative constructor allowing an XML file to be used to + create the layout of the ControlPanel.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voidsetPanels(FrontendModulePanel parent, + FrontendModulePanel child) + +
+          Set the parent and child panels that this ControlPanel + facilitates intercommunication.
+ voidsetPreviousCPanel(FrontendControlPanel cpanel) + +
+          Set the previous control panel (if any), so that it can be + restored when this control panel returns control to the + parent.
+  + + + + + + + +
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
+ +

+FrontendControlPanel

+
+public FrontendControlPanel(java.lang.String xmlPath)
+                     throws UICreationFailureException
+
+
Alternative constructor allowing an XML file to be used to + create the layout of the ControlPanel. + + This is provided for the benefit of subclasses of this class + that use it in their default constructors. +

+

+
Parameters:
xmlPath - The path, relative from this source file, to the + XML file from which this panel will read its + layout. +
Throws: +
UICreationFailureException - if the UI creation fails.
+
+ + + + + + + + +
+Method Detail
+ +

+setPanels

+
+public void setPanels(FrontendModulePanel parent,
+                      FrontendModulePanel child)
+
+
Set the parent and child panels that this ControlPanel + facilitates intercommunication. +

+

+
Parameters:
parent - The panel belonging to the parent module, + or the module that was switched out in place of + the child.
child - The panel belonging to the child module, + or the module that was switched in in place of + the parent.
+
+
+
+ +

+setPreviousCPanel

+
+public void setPreviousCPanel(FrontendControlPanel cpanel)
+
+
Set the previous control panel (if any), so that it can be + restored when this control panel returns control to the + parent. +

+

+
Parameters:
cpanel - The previous control panel.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/FrontendError.html b/doc/uk/org/ury/frontend/FrontendError.html new file mode 100644 index 0000000..0ee5c70 --- /dev/null +++ b/doc/uk/org/ury/frontend/FrontendError.html @@ -0,0 +1,286 @@ + + + + + + +FrontendError + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend +
+Class FrontendError

+
+java.lang.Object
+  extended by uk.org.ury.frontend.FrontendError
+
+
+
+
public class FrontendError
extends java.lang.Object
+ + +

+Factory for descriptive error dialogues. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
FrontendError() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static voidreportFatal(java.lang.String message, + FrontendAppletPanel panel) + +
+           
+static voidreportFatal(java.lang.String message, + FrontendFrame frame) + +
+          Create an error dialogue to report a fatal error.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+FrontendError

+
+public FrontendError()
+
+
+ + + + + + + + +
+Method Detail
+ +

+reportFatal

+
+public static void reportFatal(java.lang.String message,
+                               FrontendFrame frame)
+
+
Create an error dialogue to report a fatal error. +

+

+
Parameters:
message - The message, eg the exception message, + to report to the user.
+
+
+
+ +

+reportFatal

+
+public static void reportFatal(java.lang.String message,
+                               FrontendAppletPanel panel)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/FrontendFrame.html b/doc/uk/org/ury/frontend/FrontendFrame.html new file mode 100644 index 0000000..9b82f52 --- /dev/null +++ b/doc/uk/org/ury/frontend/FrontendFrame.html @@ -0,0 +1,495 @@ + + + + + + +FrontendFrame + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend +
+Class FrontendFrame

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by java.awt.Window
+              extended by java.awt.Frame
+                  extended by javax.swing.JFrame
+                      extended by uk.org.ury.frontend.FrontendFrame
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, FrontendMaster
+
+
+
+
public class FrontendFrame
extends javax.swing.JFrame
implements FrontendMaster
+ + +

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

+ +

+

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

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JFrame
EXIT_ON_CLOSE
+  + + + + + + + +
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
FrontendFrame(FrontendModulePanel parent) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidfatalError(java.lang.String message) + +
+          Report a fatal error,
+ voidloadModule(java.lang.String moduleName) + +
+          Load a module into the frontend frame.
+ voidloadModule(java.lang.String moduleName, + java.lang.String cPanelName) + +
+          Load a module into the frontend frame, additionally installing + a control panel to communicate with the previous module.
+ voidrestoreModule(FrontendModulePanel mpanel, + FrontendControlPanel cpanel) + +
+          Restore an existing module and control panel into the frontend + frame.
+  + + + + + + + +
Methods inherited from class javax.swing.JFrame
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
+  + + + + + + + +
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
+  + + + + + + + +
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
+  +

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

+FrontendFrame

+
+public FrontendFrame(FrontendModulePanel parent)
+
+
+ + + + + + + + +
+Method Detail
+ +

+loadModule

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

+

+
Specified by:
loadModule in interface FrontendMaster
+
+
+
Parameters:
moduleName - The fully qualified class-name of the module, + minus the leading "uk.org.ury." domain.
+
+
+
+ +

+loadModule

+
+public void loadModule(java.lang.String moduleName,
+                       java.lang.String cPanelName)
+
+
Load a module into the frontend frame, additionally installing + a control panel to communicate with the previous module. + + 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.
+
+
+
+ +

+restoreModule

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

+

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

+fatalError

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

+

+
Specified by:
fatalError in interface FrontendMaster
+
+
+
Parameters:
message - The message, eg the exception message, to report + to the user.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/FrontendMaster.html b/doc/uk/org/ury/frontend/FrontendMaster.html new file mode 100644 index 0000000..485ebb1 --- /dev/null +++ b/doc/uk/org/ury/frontend/FrontendMaster.html @@ -0,0 +1,307 @@ + + + + + + +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
+ + + +
+ +

+ +uk.org.ury.frontend +
+Interface FrontendMaster

+
+
All Known Implementing Classes:
FrontendAppletPanel, FrontendFrame
+
+
+
+
public interface FrontendMaster
+ + +

+Interface for classes providing the parent unit of a frontend + session. + + This includes the FrontendFrame used in application mode as + well as applets. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidfatalError(java.lang.String message) + +
+          Report a fatal error,
+ voidloadModule(java.lang.String moduleName) + +
+          Load a module into the frontend frame.
+ voidloadModule(java.lang.String moduleName, + java.lang.String cPanelName) + +
+          Load a module into the frontend frame, additionally installing + a control panel to communicate with the previous module.
+ voidrestoreModule(FrontendModulePanel mpanel, + FrontendControlPanel cpanel) + +
+          Restore an existing module and control panel into the frontend + master.
+  +

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

+loadModule

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

+

+
Parameters:
moduleName - The fully qualified class-name of the module, + minus the leading "uk.org.ury." domain.
+
+
+
+ +

+loadModule

+
+void loadModule(java.lang.String moduleName,
+                java.lang.String cPanelName)
+
+
Load a module into the frontend frame, additionally installing + a control panel to communicate with the previous module. + + 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.
cPanelName - The fully qualified class-name of the control + panel to install, minus the leading + "uk.org.ury." domain.
+
+
+
+ +

+restoreModule

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

+

+
Parameters:
mpanel - The module panel to restore.
cpanel - The control panel to restore. +
Throws: +
java.lang.IllegalArgumentException - if either are null.
+
+
+
+ +

+fatalError

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

+

+
Parameters:
message - The message, eg the exception message, to report + to the user.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/FrontendModule.html b/doc/uk/org/ury/frontend/FrontendModule.html new file mode 100644 index 0000000..765faeb --- /dev/null +++ b/doc/uk/org/ury/frontend/FrontendModule.html @@ -0,0 +1,236 @@ + + + + + + +FrontendModule + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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 +
+Interface FrontendModule

+
+
All Known Implementing Classes:
AbstractFrontendModule, LibraryViewer, ShowViewer
+
+
+
+
public interface FrontendModule
+ + +

+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; + + - use the frontend error reporting systems. + + An abstract implementation of this interface, + AbstractFrontendModule, is provided to simplify the creation of + frontend modules. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + + +
+Method Summary
+ FrontendModulePanelrunFrontend(FrontendMaster master) + +
+          Begin execution of the frontend module.
+  +

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

+runFrontend

+
+FrontendModulePanel runFrontend(FrontendMaster master)
+
+
Begin execution of the frontend module. +

+

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

+ +uk.org.ury.frontend +
+Class FrontendModulePanel

+
+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
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
Direct Known Subclasses:
DemoMenuPanel, LibraryViewerPanel, ShowViewerPanel
+
+
+
+
public abstract class FrontendModulePanel
extends FrontendPanel
+ + +

+A frontend user interface panel. + + All frontend user interfaces should subclass this as their main + interface space, so that frontend panels can include each other + and panels can be embedded into application frames or applets. +

+ +

+

+
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
FrontendModulePanel(FrontendModule module, + FrontendMaster master) + +
+          Construct a new, blank FrontendModulePanel.
FrontendModulePanel(FrontendModule module, + java.lang.String xmlPath, + FrontendMaster master) + +
+          Construct a FrontendModulePanel using an XML layout manifest.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ FrontendModulegetModule() + +
+          Retrieve the module that this panel is serving as a view into.
+abstract  java.lang.StringgetName() + +
+           
+  + + + + + + + +
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, 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
+ +

+FrontendModulePanel

+
+public FrontendModulePanel(FrontendModule module,
+                           FrontendMaster master)
+
+
Construct a new, blank FrontendModulePanel. +

+

+
Parameters:
module - the module that the panel is viewing.
master - The FrontendMaster driving the frontend.
+
+
+ +

+FrontendModulePanel

+
+public FrontendModulePanel(FrontendModule module,
+                           java.lang.String xmlPath,
+                           FrontendMaster master)
+                    throws UICreationFailureException
+
+
Construct a FrontendModulePanel using an XML layout manifest. +

+

+
Parameters:
module - the module that the panel is viewing.
xmlPath - The path, relative from this source file, to the + XML file from which this panel will read its + layout.
master - The FrontendMaster driving the frontend. +
Throws: +
UICreationFailureException - if the UI creation fails.
+
+ + + + + + + + +
+Method Detail
+ +

+getName

+
+public abstract java.lang.String getName()
+
+
+
Overrides:
getName in class java.awt.Component
+
+
+ +
Returns:
the name of the panel module.
+
+
+
+ +

+getModule

+
+public FrontendModule getModule()
+
+
Retrieve the module that this panel is serving as a view into. +

+

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

+ +uk.org.ury.frontend +
+Class FrontendPanel

+
+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
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
Direct Known Subclasses:
FrontendControlPanel, FrontendModulePanel
+
+
+
+
public class FrontendPanel
extends javax.swing.JPanel
+ + +

+An extension of JPanel providing common functionality for user + interface panels in the URY system frontend. +

+ +

+

+
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
FrontendPanel(FrontendMaster master) + +
+          Construct a new, blank FrontendPanel.
FrontendPanel(java.lang.String xmlPath, + FrontendMaster master) + +
+          Construct a new FrontendPanel from an XML layout.
+  + + + + + + + + + + + +
+Method Summary
+ voidsetMaster(FrontendMaster master) + +
+          Set the frontend master.
+  + + + + + + + +
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
+ +

+FrontendPanel

+
+public FrontendPanel(FrontendMaster master)
+
+
Construct a new, blank FrontendPanel. +

+

+
Parameters:
master - The FrontendMaster driving the frontend.
+
+
+ +

+FrontendPanel

+
+public FrontendPanel(java.lang.String xmlPath,
+                     FrontendMaster master)
+              throws UICreationFailureException
+
+
Construct a new FrontendPanel from an XML layout. + + This is the preferred means of constructing FrontendPanels, and + uses SWIXml to construct the panel layout. +

+

+
Parameters:
xmlPath - The path, relative from this source file, to the + XML file from which this panel will read its + layout.
master - The FrontendMaster driving the frontend. +
Throws: +
UICreationFailureException - if the UI creation fails.
+
+ + + + + + + + +
+Method Detail
+ +

+setMaster

+
+public void setMaster(FrontendMaster master)
+
+
Set the frontend master. +

+

+
Parameters:
master - The new frontend master to use.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/FrontendSubBanner.html b/doc/uk/org/ury/frontend/FrontendSubBanner.html new file mode 100644 index 0000000..ece999f --- /dev/null +++ b/doc/uk/org/ury/frontend/FrontendSubBanner.html @@ -0,0 +1,383 @@ + + + + + + +FrontendSubBanner + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend +
+Class FrontendSubBanner

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

+A banner, displaying a title, intended for use at the top of + subsections. +

+ +

+

+
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 javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
FrontendSubBanner() + +
+          Construct a new FrontendSubBanner.
+  + + + + + + + + + + + +
+Method Summary
+ voidsetText(java.lang.String text) + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.JLabel
getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setUI, setVerticalAlignment, setVerticalTextPosition, 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, 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
+ +

+FrontendSubBanner

+
+public FrontendSubBanner()
+
+
Construct a new FrontendSubBanner. +

+

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

+setText

+
+public void setText(java.lang.String text)
+
+
+
Overrides:
setText in class javax.swing.JLabel
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/HintField.html b/doc/uk/org/ury/frontend/HintField.html new file mode 100644 index 0000000..6fca8b2 --- /dev/null +++ b/doc/uk/org/ury/frontend/HintField.html @@ -0,0 +1,390 @@ + + + + + + +HintField + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend +
+Class HintField

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.text.JTextComponent
+                  extended by javax.swing.JTextArea
+                      extended by uk.org.ury.frontend.HintField
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable
+
+
+
+
public class HintField
extends javax.swing.JTextArea
+ + +

+A non-editable text area displaying a hint about how to use a + frontend screen. +

+ +

+

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

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.text.JTextComponent
javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding
+  + + + + + + + + +
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.text.JTextComponent
DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY
+  + + + + + + + +
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
HintField() + +
+          Construct a new HintField with no initial hint.
HintField(java.lang.String hint) + +
+          Construct a new HintField.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class javax.swing.JTextArea
append, getAccessibleContext, getColumns, getLineCount, getLineEndOffset, getLineOfOffset, getLineStartOffset, getLineWrap, getPreferredScrollableViewportSize, getPreferredSize, getRows, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getTabSize, getUIClassID, getWrapStyleWord, insert, replaceRange, setColumns, setFont, setLineWrap, setRows, setTabSize, setWrapStyleWord
+  + + + + + + + +
Methods inherited from class javax.swing.text.JTextComponent
addCaretListener, addInputMethodListener, addKeymap, copy, cut, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDocument, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write
+  + + + + + + + +
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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, 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, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, 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, 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, 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, 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
+ +

+HintField

+
+public HintField()
+
+
Construct a new HintField with no initial hint. +

+

+
+ +

+HintField

+
+public HintField(java.lang.String hint)
+
+
Construct a new HintField. +

+

+
Parameters:
hint - The hint to display in the HintField.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/AbstractFrontendModule.html b/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html new file mode 100644 index 0000000..63f5b79 --- /dev/null +++ b/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Class uk.org.ury.frontend.AbstractFrontendModule + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

+
+ + + + + + + + + + + + + +
+Packages that use AbstractFrontendModule
uk.org.ury.library.viewer  
uk.org.ury.show.viewer  
+  +

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

+ + + + + + + + + +
Subclasses of AbstractFrontendModule in uk.org.ury.library.viewer
+ classLibraryViewer + +
+           
+  +

+ + + + + +
+Uses of AbstractFrontendModule in uk.org.ury.show.viewer
+  +

+ + + + + + + + + +
Subclasses of AbstractFrontendModule in uk.org.ury.show.viewer
+ classShowViewer + +
+          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/class-use/FrontendAppletPanel.html b/doc/uk/org/ury/frontend/class-use/FrontendAppletPanel.html new file mode 100644 index 0000000..bb11d5c --- /dev/null +++ b/doc/uk/org/ury/frontend/class-use/FrontendAppletPanel.html @@ -0,0 +1,181 @@ + + + + + + +Uses of Class uk.org.ury.frontend.FrontendAppletPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

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

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

+

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

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

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

+

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

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

+
+ + + + + + + + + + + + + + + + + +
+Packages that use FrontendControlPanel
uk.org.ury.frontend  
uk.org.ury.show.viewer  
uk.org.ury.testrig  
+  +

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

+ + + + + + + + + + + + + + + + + + + + + +
Methods in uk.org.ury.frontend with parameters of type FrontendControlPanel
+ voidFrontendAppletPanel.restoreModule(FrontendModulePanel mpanel, + FrontendControlPanel cpanel) + +
+          Restore an existing module and control panel into the frontend + frame.
+ voidFrontendMaster.restoreModule(FrontendModulePanel mpanel, + FrontendControlPanel cpanel) + +
+          Restore an existing module and control panel into the frontend + master.
+ voidFrontendFrame.restoreModule(FrontendModulePanel mpanel, + FrontendControlPanel cpanel) + +
+          Restore an existing module and control panel into the frontend + frame.
+ voidFrontendControlPanel.setPreviousCPanel(FrontendControlPanel cpanel) + +
+          Set the previous control panel (if any), so that it can be + restored when this control panel returns control to the + parent.
+  +

+ + + + + +
+Uses of FrontendControlPanel in uk.org.ury.show.viewer
+  +

+ + + + + + + + + +
Subclasses of FrontendControlPanel in uk.org.ury.show.viewer
+ classLibraryControlPanel + +
+          Control panel for the demo system.
+  +

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

+ + + + + + + + + +
Subclasses of FrontendControlPanel in uk.org.ury.testrig
+ classDemoControlPanel + +
+          Control panel for the demo system.
+  +

+

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

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

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

+

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

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

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

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

+ + + + + + + + + +
Methods in uk.org.ury.frontend with parameters of type FrontendFrame
+static voidFrontendError.reportFatal(java.lang.String message, + FrontendFrame frame) + +
+          Create an error dialogue to report a fatal error.
+  +

+

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

+Uses of Interface
uk.org.ury.frontend.FrontendMaster

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use FrontendMaster
uk.org.ury.frontend  
uk.org.ury.library.viewer  
uk.org.ury.show.viewer  
uk.org.ury.testrig  
+  +

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

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

+ + + + + + + + + + + + + +
Methods in uk.org.ury.frontend with parameters of type FrontendMaster
+ FrontendModulePanelFrontendModule.runFrontend(FrontendMaster master) + +
+          Begin execution of the frontend module.
+ voidFrontendPanel.setMaster(FrontendMaster master) + +
+          Set the frontend master.
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in uk.org.ury.frontend with parameters of type FrontendMaster
FrontendModulePanel(FrontendModule module, + FrontendMaster master) + +
+          Construct a new, blank FrontendModulePanel.
FrontendModulePanel(FrontendModule module, + java.lang.String xmlPath, + FrontendMaster master) + +
+          Construct a FrontendModulePanel using an XML layout manifest.
FrontendPanel(FrontendMaster master) + +
+          Construct a new, blank FrontendPanel.
FrontendPanel(java.lang.String xmlPath, + FrontendMaster master) + +
+          Construct a new FrontendPanel from an XML layout.
+  +

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

+ + + + + + + + + +
Methods in uk.org.ury.library.viewer with parameters of type FrontendMaster
+ FrontendModulePanelLibraryViewer.runFrontend(FrontendMaster master) + +
+          Run the library viewer frontend.
+  +

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

+ + + + + +
+Uses of FrontendMaster in uk.org.ury.show.viewer
+  +

+ + + + + + + + + +
Methods in uk.org.ury.show.viewer with parameters of type FrontendMaster
+ FrontendModulePanelShowViewer.runFrontend(FrontendMaster master) + +
+          Run the library viewer frontend.
+  +

+ + + + + + + + +
Constructors in uk.org.ury.show.viewer with parameters of type FrontendMaster
ShowViewerPanel(ShowViewer viewer, + FrontendMaster master) + +
+          Construct a new ShowViewerPanel.
+  +

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

+ + + + + + + + +
Constructors in uk.org.ury.testrig with parameters of type FrontendMaster
DemoMenuPanel(FrontendMaster inMaster) + +
+          Construct a new DemoMenuPanel.
+  +

+

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

+Uses of Interface
uk.org.ury.frontend.FrontendModule

+
+ + + + + + + + + + + + + + + + + +
+Packages that use FrontendModule
uk.org.ury.frontend  
uk.org.ury.library.viewer  
uk.org.ury.show.viewer  
+  +

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

+ + + + + + + + + +
Classes in uk.org.ury.frontend that implement FrontendModule
+ classAbstractFrontendModule + +
+          An abstract implementation of the FrontendModule interface.
+  +

+ + + + + + + + + +
Methods in uk.org.ury.frontend that return FrontendModule
+ FrontendModuleFrontendModulePanel.getModule() + +
+          Retrieve the module that this panel is serving as a view into.
+  +

+ + + + + + + + + + + +
Constructors in uk.org.ury.frontend with parameters of type FrontendModule
FrontendModulePanel(FrontendModule module, + FrontendMaster master) + +
+          Construct a new, blank FrontendModulePanel.
FrontendModulePanel(FrontendModule module, + java.lang.String xmlPath, + FrontendMaster master) + +
+          Construct a FrontendModulePanel using an XML layout manifest.
+  +

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

+ + + + + + + + + +
Classes in uk.org.ury.library.viewer that implement FrontendModule
+ classLibraryViewer + +
+           
+  +

+ + + + + +
+Uses of FrontendModule in uk.org.ury.show.viewer
+  +

+ + + + + + + + + +
Classes in uk.org.ury.show.viewer that implement FrontendModule
+ classShowViewer + +
+          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/class-use/FrontendModulePanel.html b/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html new file mode 100644 index 0000000..05bd4c8 --- /dev/null +++ b/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html @@ -0,0 +1,367 @@ + + + + + + +Uses of Class uk.org.ury.frontend.FrontendModulePanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use FrontendModulePanel
uk.org.ury.frontend  
uk.org.ury.library.viewer  
uk.org.ury.show.viewer  
uk.org.ury.testrig  
+  +

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

+ + + + + + + + + +
Methods in uk.org.ury.frontend that return FrontendModulePanel
+ FrontendModulePanelFrontendModule.runFrontend(FrontendMaster master) + +
+          Begin execution of the frontend module.
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in uk.org.ury.frontend with parameters of type FrontendModulePanel
+ voidFrontendAppletPanel.restoreModule(FrontendModulePanel mpanel, + FrontendControlPanel cpanel) + +
+          Restore an existing module and control panel into the frontend + frame.
+ voidFrontendMaster.restoreModule(FrontendModulePanel mpanel, + FrontendControlPanel cpanel) + +
+          Restore an existing module and control panel into the frontend + master.
+ voidFrontendFrame.restoreModule(FrontendModulePanel mpanel, + FrontendControlPanel cpanel) + +
+          Restore an existing module and control panel into the frontend + frame.
+ voidFrontendControlPanel.setPanels(FrontendModulePanel parent, + FrontendModulePanel child) + +
+          Set the parent and child panels that this ControlPanel + facilitates intercommunication.
+  +

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

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

+ + + + + + + + + +
Subclasses of FrontendModulePanel in uk.org.ury.library.viewer
+ classLibraryViewerPanel + +
+          Frontend panel providing access to an underlying library viewer.
+  +

+ + + + + + + + + +
Methods in uk.org.ury.library.viewer that return FrontendModulePanel
+ FrontendModulePanelLibraryViewer.runFrontend(FrontendMaster master) + +
+          Run the library viewer frontend.
+  +

+ + + + + +
+Uses of FrontendModulePanel in uk.org.ury.show.viewer
+  +

+ + + + + + + + + +
Subclasses of FrontendModulePanel in uk.org.ury.show.viewer
+ classShowViewerPanel + +
+          Frontend panel providing access to an underlying lshow viewer.
+  +

+ + + + + + + + + +
Methods in uk.org.ury.show.viewer that return FrontendModulePanel
+ FrontendModulePanelShowViewer.runFrontend(FrontendMaster master) + +
+          Run the library viewer frontend.
+  +

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

+ + + + + + + + + +
Subclasses of FrontendModulePanel in uk.org.ury.testrig
+ classDemoMenuPanel + +
+           
+  +

+

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

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

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use FrontendPanel
uk.org.ury.frontend  
uk.org.ury.library.viewer  
uk.org.ury.show.viewer  
uk.org.ury.testrig  
+  +

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

+ + + + + + + + + + + + + +
Subclasses of FrontendPanel in uk.org.ury.frontend
+ classFrontendControlPanel + +
+          Abstract class for frontend module control panels.
+ classFrontendModulePanel + +
+          A frontend user interface panel.
+  +

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

+ + + + + + + + + +
Subclasses of FrontendPanel in uk.org.ury.library.viewer
+ classLibraryViewerPanel + +
+          Frontend panel providing access to an underlying library viewer.
+  +

+ + + + + +
+Uses of FrontendPanel in uk.org.ury.show.viewer
+  +

+ + + + + + + + + + + + + +
Subclasses of FrontendPanel in uk.org.ury.show.viewer
+ classLibraryControlPanel + +
+          Control panel for the demo system.
+ classShowViewerPanel + +
+          Frontend panel providing access to an underlying lshow viewer.
+  +

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

+ + + + + + + + + + + + + +
Subclasses of FrontendPanel in uk.org.ury.testrig
+ classDemoControlPanel + +
+          Control panel for the demo system.
+ classDemoMenuPanel + +
+           
+  +

+

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

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

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

+

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

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

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

+

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

+ +uk.org.ury.frontend.exceptions +
+Class UICreationFailureException

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

+Exception thrown when the creation of a UI element fails. +

+ +

+

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

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

+UICreationFailureException

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

+

+
+ +

+UICreationFailureException

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

+

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

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

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use UICreationFailureException
uk.org.ury.frontend  
uk.org.ury.library.viewer  
uk.org.ury.show.viewer  
uk.org.ury.testrig  
+  +

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

+ + + + + + + + + + + + + + +
Constructors in uk.org.ury.frontend that throw UICreationFailureException
FrontendControlPanel(java.lang.String xmlPath) + +
+          Alternative constructor allowing an XML file to be used to + create the layout of the ControlPanel.
FrontendModulePanel(FrontendModule module, + java.lang.String xmlPath, + FrontendMaster master) + +
+          Construct a FrontendModulePanel using an XML layout manifest.
FrontendPanel(java.lang.String xmlPath, + FrontendMaster master) + +
+          Construct a new FrontendPanel from an XML layout.
+  +

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

+ + + + + + + + +
Constructors in uk.org.ury.library.viewer that throw UICreationFailureException
LibraryViewerPanel(LibraryViewer viewer, + FrontendMaster master) + +
+          Construct a new LibraryViewerPanel.
+  +

+ + + + + +
+Uses of UICreationFailureException in uk.org.ury.show.viewer
+  +

+ + + + + + + + + + + + + + + + + +
Constructors in uk.org.ury.show.viewer that throw UICreationFailureException
ChannelPanel(int number, + ShowChannel channel) + +
+          Construct a new ChannelPanel.
LibraryControlPanel() + +
+          Construct a new LibraryControlPanel.
ShowViewerPanel(ShowViewer viewer, + FrontendMaster master) + +
+          Construct a new ShowViewerPanel.
TrackBin(java.lang.String name) + +
+          Construct a new TrackBin.
+  +

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

+ + + + + + + + +
Constructors in uk.org.ury.testrig that throw UICreationFailureException
DemoControlPanel() + +
+          Constructs a new DemoControlPanel.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/exceptions/package-frame.html b/doc/uk/org/ury/frontend/exceptions/package-frame.html new file mode 100644 index 0000000..fbecad3 --- /dev/null +++ b/doc/uk/org/ury/frontend/exceptions/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +uk.org.ury.frontend.exceptions + + + + + + + + + + + +uk.org.ury.frontend.exceptions + + + + +
+Exceptions  + +
+UICreationFailureException
+ + + + diff --git a/doc/uk/org/ury/frontend/exceptions/package-summary.html b/doc/uk/org/ury/frontend/exceptions/package-summary.html new file mode 100644 index 0000000..500b08c --- /dev/null +++ b/doc/uk/org/ury/frontend/exceptions/package-summary.html @@ -0,0 +1,157 @@ + + + + + + +uk.org.ury.frontend.exceptions + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.frontend.exceptions +

+ + + + + + + + + +
+Exception Summary
UICreationFailureExceptionException thrown when the creation of a UI element fails.
+  + +

+

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

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

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

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use uk.org.ury.frontend.exceptions
uk.org.ury.frontend  
uk.org.ury.library.viewer  
uk.org.ury.show.viewer  
uk.org.ury.testrig  
+  +

+ + + + + + + + +
+Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.frontend
UICreationFailureException + +
+          Exception thrown when the creation of a UI element fails.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.library.viewer
UICreationFailureException + +
+          Exception thrown when the creation of a UI element fails.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.show.viewer
UICreationFailureException + +
+          Exception thrown when the creation of a UI element fails.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.testrig
UICreationFailureException + +
+          Exception thrown when the creation of a UI element fails.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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 new file mode 100644 index 0000000..6cd39ef --- /dev/null +++ b/doc/uk/org/ury/frontend/package-frame.html @@ -0,0 +1,63 @@ + + + + + + +uk.org.ury.frontend + + + + + + + + + + + +uk.org.ury.frontend + + + + +
+Interfaces  + +
+FrontendMaster +
+FrontendModule
+ + + + + + +
+Classes  + +
+AbstractFrontendModule +
+FrontendAppletPanel +
+FrontendBanner +
+FrontendControlPanel +
+FrontendError +
+FrontendFrame +
+FrontendModulePanel +
+FrontendPanel +
+FrontendSubBanner +
+HintField
+ + + + diff --git a/doc/uk/org/ury/frontend/package-summary.html b/doc/uk/org/ury/frontend/package-summary.html new file mode 100644 index 0000000..544a478 --- /dev/null +++ b/doc/uk/org/ury/frontend/package-summary.html @@ -0,0 +1,219 @@ + + + + + + +uk.org.ury.frontend + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.frontend +

+ + + + + + + + + + + + + +
+Interface Summary
FrontendMasterInterface for classes providing the parent unit of a frontend + session.
FrontendModuleInterface for all system modules that are to be reachable from + the frontend array.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
AbstractFrontendModuleAn abstract implementation of the FrontendModule interface.
FrontendAppletPanelA frame that hosts a FrontendModulePanel, used for serving frontend + panels in a window (application mode).
FrontendBannerA banner, displaying a title, intended for use at the top of the + frontend frame.
FrontendControlPanelAbstract class for frontend module control panels.
FrontendErrorFactory for descriptive error dialogues.
FrontendFrameA frame that hosts a FrontendModulePanel, used for serving frontend + panels in a window (application mode).
FrontendModulePanelA frontend user interface panel.
FrontendPanelAn extension of JPanel providing common functionality for user + interface panels in the URY system frontend.
FrontendSubBannerA banner, displaying a title, intended for use at the top of + subsections.
HintFieldA non-editable text area displaying a hint about how to use a + frontend screen.
+  + +

+

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

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

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

+Uses of Package
uk.org.ury.frontend

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use uk.org.ury.frontend
uk.org.ury.frontend  
uk.org.ury.library.viewer  
uk.org.ury.show.viewer  
uk.org.ury.testrig  
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in uk.org.ury.frontend used by uk.org.ury.frontend
FrontendAppletPanel + +
+          A frame that hosts a FrontendModulePanel, used for serving frontend + panels in a window (application mode).
FrontendControlPanel + +
+          Abstract class for frontend module control panels.
FrontendFrame + +
+          A frame that hosts a FrontendModulePanel, used for serving frontend + panels in a window (application mode).
FrontendMaster + +
+          Interface for classes providing the parent unit of a frontend + session.
FrontendModule + +
+          Interface for all system modules that are to be reachable from + the frontend array.
FrontendModulePanel + +
+          A frontend user interface panel.
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.library.viewer
AbstractFrontendModule + +
+          An abstract implementation of the FrontendModule interface.
FrontendMaster + +
+          Interface for classes providing the parent unit of a frontend + session.
FrontendModule + +
+          Interface for all system modules that are to be reachable from + the frontend array.
FrontendModulePanel + +
+          A frontend user interface panel.
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.show.viewer
AbstractFrontendModule + +
+          An abstract implementation of the FrontendModule interface.
FrontendControlPanel + +
+          Abstract class for frontend module control panels.
FrontendMaster + +
+          Interface for classes providing the parent unit of a frontend + session.
FrontendModule + +
+          Interface for all system modules that are to be reachable from + the frontend array.
FrontendModulePanel + +
+          A frontend user interface panel.
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.testrig
FrontendControlPanel + +
+          Abstract class for frontend module control panels.
FrontendMaster + +
+          Interface for classes providing the parent unit of a frontend + session.
FrontendModulePanel + +
+          A frontend user interface panel.
FrontendPanel + +
+          An extension of JPanel providing common functionality for user + interface panels in the URY system frontend.
+  +

+

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

+ +uk.org.ury.library +
+Class LibraryItem

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

+An item in the URY library. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+LibraryItem

+
+public LibraryItem(java.util.Map<LibraryItemProperty,java.lang.String> properties)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/library/LibraryItemProperty.html b/doc/uk/org/ury/library/LibraryItemProperty.html new file mode 100644 index 0000000..65a2aae --- /dev/null +++ b/doc/uk/org/ury/library/LibraryItemProperty.html @@ -0,0 +1,670 @@ + + + + + + +LibraryItemProperty + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +uk.org.ury.library +
+Enum LibraryItemProperty

+
+java.lang.Object
+  extended by java.lang.Enum<LibraryItemProperty>
+      extended by uk.org.ury.library.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
ADD_FORENAME + +
+           
ADD_MEMBER_ID + +
+           
ADD_SURNAME + +
+           
ALBUM + +
+           
ARTIST + +
+           
CD_ID + +
+           
DATE_ADDED + +
+           
DATE_EDITED + +
+           
DATE_RELEASED + +
+           
EDIT_FORENAME + +
+           
EDIT_MEMBER_ID + +
+           
EDIT_SURNAME + +
+           
FORMAT + +
+           
IS_CLEAN + +
+           
IS_DIGITISED + +
+           
LABEL + +
+           
MEDIUM + +
+           
SHELF_LETTER + +
+           
SHELF_NUMBER + +
+           
STATUS + +
+           
TITLE + +
+           
+  + + + + + + + + + + +
+Field Summary
+ java.lang.Stringsql + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+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
+
+
+
+
+
+ +

+ADD_MEMBER_ID

+
+public static final LibraryItemProperty ADD_MEMBER_ID
+
+
+
+
+
+ +

+EDIT_MEMBER_ID

+
+public static final LibraryItemProperty EDIT_MEMBER_ID
+
+
+
+
+
+ +

+ADD_FORENAME

+
+public static final LibraryItemProperty ADD_FORENAME
+
+
+
+
+
+ +

+ADD_SURNAME

+
+public static final LibraryItemProperty ADD_SURNAME
+
+
+
+
+
+ +

+EDIT_FORENAME

+
+public static final LibraryItemProperty EDIT_FORENAME
+
+
+
+
+
+ +

+EDIT_SURNAME

+
+public static final LibraryItemProperty EDIT_SURNAME
+
+
+
+
+
+ +

+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
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/library/LibraryTableModel.html b/doc/uk/org/ury/library/LibraryTableModel.html new file mode 100644 index 0000000..aa906fa --- /dev/null +++ b/doc/uk/org/ury/library/LibraryTableModel.html @@ -0,0 +1,362 @@ + + + + + + +LibraryTableModel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.library +
+Class LibraryTableModel

+
+java.lang.Object
+  extended by javax.swing.table.AbstractTableModel
+      extended by uk.org.ury.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/library/LibraryUtils.html b/doc/uk/org/ury/library/LibraryUtils.html new file mode 100644 index 0000000..57b5d23 --- /dev/null +++ b/doc/uk/org/ury/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.library +
+Class LibraryUtils

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

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

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

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

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

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

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

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

+

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

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

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

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

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

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

+

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

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

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

+

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

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

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

+

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

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

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

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

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

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

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

+

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

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

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

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

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

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

+ + + + + + + + +
+Classes in uk.org.ury.library.exceptions used by uk.org.ury.library.viewer
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/library/package-frame.html b/doc/uk/org/ury/library/package-frame.html new file mode 100644 index 0000000..d25cd99 --- /dev/null +++ b/doc/uk/org/ury/library/package-frame.html @@ -0,0 +1,47 @@ + + + + + + +uk.org.ury.library + + + + + + + + + + + +uk.org.ury.library + + + + +
+Classes  + +
+LibraryItem +
+LibraryTableModel +
+LibraryUtils
+ + + + + + +
+Enums  + +
+LibraryItemProperty
+ + + + diff --git a/doc/uk/org/ury/library/package-summary.html b/doc/uk/org/ury/library/package-summary.html new file mode 100644 index 0000000..2a764d7 --- /dev/null +++ b/doc/uk/org/ury/library/package-summary.html @@ -0,0 +1,180 @@ + + + + + + +uk.org.ury.library + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.library +

+ + + + + + + + + + + + + + + + + +
+Class Summary
LibraryItemAn item in the URY library.
LibraryTableModelA table model for the library viewer.
LibraryUtilsA set of common utility routines to facilitate the extraction of + library items from the library areas of the URY database.
+  + +

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

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

+Uses of Package
uk.org.ury.library

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

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

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

+

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

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

+

+
See Also:
Serialized Form
+
+ +

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

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

+LibraryViewer

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

+

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

+init

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

+

+
Specified by:
init in class AbstractFrontendModule
+
+
+
+
+
+
+ +

+start

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

+

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

+runFrontend

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

+doSearch

+
+public void doSearch(java.lang.String search)
+              throws EmptySearchException,
+                     QueryFailureException
+
+
Do 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). +
QueryFailureException - if the search query + fails (from LibraryUtils.search).
+
+
+
+ +

+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/library/viewer/LibraryViewerPanel.html b/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html new file mode 100644 index 0000000..b09d292 --- /dev/null +++ b/doc/uk/org/ury/library/viewer/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.library.viewer +
+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.library.viewer.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.StringgetName() + +
+           
+ 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, 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
+ +

+getName

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

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

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

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

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

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

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

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

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/library/viewer/package-frame.html b/doc/uk/org/ury/library/viewer/package-frame.html new file mode 100644 index 0000000..896ea25 --- /dev/null +++ b/doc/uk/org/ury/library/viewer/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +uk.org.ury.library.viewer + + + + + + + + + + + +uk.org.ury.library.viewer + + + + +
+Classes  + +
+LibraryViewer +
+LibraryViewerPanel
+ + + + diff --git a/doc/uk/org/ury/library/viewer/package-summary.html b/doc/uk/org/ury/library/viewer/package-summary.html new file mode 100644 index 0000000..338b637 --- /dev/null +++ b/doc/uk/org/ury/library/viewer/package-summary.html @@ -0,0 +1,161 @@ + + + + + + +uk.org.ury.library.viewer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.library.viewer +

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

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

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

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

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

+ + + + + + + + +
+Classes in uk.org.ury.library.viewer used by uk.org.ury.library.viewer
LibraryViewer + +
+           
+  +

+

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

+
+java.lang.Object
+  extended by javax.swing.AbstractListModel
+      extended by uk.org.ury.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() + +
+          Construct a new, empty channel.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidadd(int index, + ShowItem item) + +
+          Add a new item to the channel.
+ voidadd(ShowItem item) + +
+          Add a new item to the end of the channel.
+ ShowItemget(int index) + +
+          Retrieve 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()
+
+
Construct a new, empty channel. +

+

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

+add

+
+public void add(int index,
+                ShowItem item)
+
+
Add 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)
+
+
Add a new item to the end of the channel. +

+

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

+get

+
+public ShowItem get(int index)
+
+
Retrieve 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/show/ShowItem.html b/doc/uk/org/ury/show/ShowItem.html new file mode 100644 index 0000000..4e90443 --- /dev/null +++ b/doc/uk/org/ury/show/ShowItem.html @@ -0,0 +1,278 @@ + + + + + + +ShowItem + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.show +
+Class ShowItem

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

+An item in the show database. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+ShowItem

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

+

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

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+ +
Returns:
a string representation of the ShowItem.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/show/ShowItemProperty.html b/doc/uk/org/ury/show/ShowItemProperty.html new file mode 100644 index 0000000..754ac55 --- /dev/null +++ b/doc/uk/org/ury/show/ShowItemProperty.html @@ -0,0 +1,382 @@ + + + + + + +ShowItemProperty + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +uk.org.ury.show +
+Enum ShowItemProperty

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

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

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + + + + + + +
+Enum Constant Summary
NAME1 + +
+           
NAME2 + +
+           
POSITION + +
+           
+  + + + + + + + + + + +
+Field Summary
+ java.lang.Stringsql + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static ShowItemPropertyvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static ShowItemProperty[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

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

+NAME1

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

+NAME2

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

+POSITION

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

+sql

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

+values

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

+

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

+valueOf

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

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/show/ShowUtils.html b/doc/uk/org/ury/show/ShowUtils.html new file mode 100644 index 0000000..67b3d0f --- /dev/null +++ b/doc/uk/org/ury/show/ShowUtils.html @@ -0,0 +1,350 @@ + + + + + + +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.show +
+Class ShowUtils

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

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

+
+ + + + + + + + + +
+Packages that use ShowChannel
uk.org.ury.show.viewer  
+  +

+ + + + + +
+Uses of ShowChannel in uk.org.ury.show.viewer
+  +

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

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

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

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

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

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

+ + + + + + + + + +
Methods in uk.org.ury.show that return types with arguments of type ShowItem
+static java.util.List<ShowItem>ShowUtils.getChannelList(DatabaseDriver db, + int showID, + int channel) + +
+          Given a show and a channel, retrieve a list of all show items + bound to that channel for the show.
+  +

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

+

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

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

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

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

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

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

+

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

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

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

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/show/package-frame.html b/doc/uk/org/ury/show/package-frame.html new file mode 100644 index 0000000..94c7b4d --- /dev/null +++ b/doc/uk/org/ury/show/package-frame.html @@ -0,0 +1,47 @@ + + + + + + +uk.org.ury.show + + + + + + + + + + + +uk.org.ury.show + + + + +
+Classes  + +
+ShowChannel +
+ShowItem +
+ShowUtils
+ + + + + + +
+Enums  + +
+ShowItemProperty
+ + + + diff --git a/doc/uk/org/ury/show/package-summary.html b/doc/uk/org/ury/show/package-summary.html new file mode 100644 index 0000000..4a77c20 --- /dev/null +++ b/doc/uk/org/ury/show/package-summary.html @@ -0,0 +1,180 @@ + + + + + + +uk.org.ury.show + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.show +

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

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

+Uses of Package
uk.org.ury.show

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

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

+ + + + + + + + +
+Classes in uk.org.ury.show used by uk.org.ury.show.viewer
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/show/viewer/ChannelPanel.html b/doc/uk/org/ury/show/viewer/ChannelPanel.html new file mode 100644 index 0000000..1ca879b --- /dev/null +++ b/doc/uk/org/ury/show/viewer/ChannelPanel.html @@ -0,0 +1,353 @@ + + + + + + +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.show.viewer +
+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.show.viewer.ChannelPanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
+
public class ChannelPanel
extends javax.swing.JPanel
+ + +

+A panel displaying channel informstion. +

+ +

+

+
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 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/show/viewer/LibraryControlPanel.html b/doc/uk/org/ury/show/viewer/LibraryControlPanel.html new file mode 100644 index 0000000..ac29d4e --- /dev/null +++ b/doc/uk/org/ury/show/viewer/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.show.viewer +
+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.show.viewer.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/show/viewer/ShowViewer.html b/doc/uk/org/ury/show/viewer/ShowViewer.html new file mode 100644 index 0000000..88e4fd6 --- /dev/null +++ b/doc/uk/org/ury/show/viewer/ShowViewer.html @@ -0,0 +1,462 @@ + + + + + + +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.show.viewer +
+Class ShowViewer

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by java.awt.Panel
+              extended by java.applet.Applet
+                  extended by javax.swing.JApplet
+                      extended by uk.org.ury.frontend.AbstractFrontendModule
+                          extended by uk.org.ury.show.viewer.ShowViewer
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, 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
+
See Also:
Serialized Form
+
+ +

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

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

+ShowViewer

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

+

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

+init

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

+

+
Specified by:
init in class AbstractFrontendModule
+
+
+
+
+
+
+ +

+start

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

+

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

+runFrontend

+
+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/show/viewer/ShowViewerPanel.html b/doc/uk/org/ury/show/viewer/ShowViewerPanel.html new file mode 100644 index 0000000..93481b1 --- /dev/null +++ b/doc/uk/org/ury/show/viewer/ShowViewerPanel.html @@ -0,0 +1,424 @@ + + + + + + +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.show.viewer +
+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.show.viewer.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 lshow 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
ShowViewerPanel(ShowViewer viewer, + FrontendMaster master) + +
+          Construct a new ShowViewerPanel.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.StringgetName() + +
+           
+ 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, 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. +

+

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

+getName

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

+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/show/viewer/TrackBin.html b/doc/uk/org/ury/show/viewer/TrackBin.html new file mode 100644 index 0000000..f641b35 --- /dev/null +++ b/doc/uk/org/ury/show/viewer/TrackBin.html @@ -0,0 +1,353 @@ + + + + + + +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.show.viewer +
+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.show.viewer.TrackBin
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
+
public class TrackBin
extends javax.swing.JPanel
+ + +

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

+Uses of Class
uk.org.ury.show.viewer.ChannelPanel

+
+No usage of uk.org.ury.show.viewer.ChannelPanel +

+

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

+Uses of Class
uk.org.ury.show.viewer.LibraryControlPanel

+
+No usage of uk.org.ury.show.viewer.LibraryControlPanel +

+

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

+Uses of Class
uk.org.ury.show.viewer.ShowViewer

+
+ + + + + + + + + +
+Packages that use ShowViewer
uk.org.ury.show.viewer  
+  +

+ + + + + +
+Uses of ShowViewer in uk.org.ury.show.viewer
+  +

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

+Uses of Class
uk.org.ury.show.viewer.ShowViewerPanel

+
+No usage of uk.org.ury.show.viewer.ShowViewerPanel +

+

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

+Uses of Class
uk.org.ury.show.viewer.TrackBin

+
+No usage of uk.org.ury.show.viewer.TrackBin +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/show/viewer/package-frame.html b/doc/uk/org/ury/show/viewer/package-frame.html new file mode 100644 index 0000000..f643d0c --- /dev/null +++ b/doc/uk/org/ury/show/viewer/package-frame.html @@ -0,0 +1,40 @@ + + + + + + +uk.org.ury.show.viewer + + + + + + + + + + + +uk.org.ury.show.viewer + + + + +
+Classes  + +
+ChannelPanel +
+LibraryControlPanel +
+ShowViewer +
+ShowViewerPanel +
+TrackBin
+ + + + diff --git a/doc/uk/org/ury/show/viewer/package-summary.html b/doc/uk/org/ury/show/viewer/package-summary.html new file mode 100644 index 0000000..883975b --- /dev/null +++ b/doc/uk/org/ury/show/viewer/package-summary.html @@ -0,0 +1,173 @@ + + + + + + +uk.org.ury.show.viewer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.show.viewer +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ChannelPanelA panel displaying channel informstion.
LibraryControlPanelControl panel for the demo system.
ShowViewerFrontend module for viewing show details.
ShowViewerPanelFrontend panel providing access to an underlying lshow 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/show/viewer/package-tree.html b/doc/uk/org/ury/show/viewer/package-tree.html new file mode 100644 index 0000000..d33ff4b --- /dev/null +++ b/doc/uk/org/ury/show/viewer/package-tree.html @@ -0,0 +1,181 @@ + + + + + + +uk.org.ury.show.viewer Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

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

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

+ + + + + + + + +
+Classes in uk.org.ury.show.viewer used by uk.org.ury.show.viewer
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/testrig/DemoControlPanel.html b/doc/uk/org/ury/testrig/DemoControlPanel.html new file mode 100644 index 0000000..0ace755 --- /dev/null +++ b/doc/uk/org/ury/testrig/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.testrig +
+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.testrig.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/testrig/DemoMenu.html b/doc/uk/org/ury/testrig/DemoMenu.html new file mode 100644 index 0000000..ac1a762 --- /dev/null +++ b/doc/uk/org/ury/testrig/DemoMenu.html @@ -0,0 +1,426 @@ + + + + + + +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.testrig +
+Class DemoMenu

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

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

+ +

+

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

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

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

+DemoMenu

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

+main

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

+

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

+init

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

+

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

+loadModule

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

+run

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

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/testrig/DemoMenuPanel.html b/doc/uk/org/ury/testrig/DemoMenuPanel.html new file mode 100644 index 0000000..52d2a0c --- /dev/null +++ b/doc/uk/org/ury/testrig/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.testrig +
+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.testrig.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.StringgetName() + +
+           
+  + + + + + + + +
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, 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
+ +

+getName

+
+public java.lang.String getName()
+
+
+
Specified by:
getName 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/testrig/class-use/DemoControlPanel.html b/doc/uk/org/ury/testrig/class-use/DemoControlPanel.html new file mode 100644 index 0000000..2ef2ceb --- /dev/null +++ b/doc/uk/org/ury/testrig/class-use/DemoControlPanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.testrig.DemoControlPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

+

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

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

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

+

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

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

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

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/testrig/package-frame.html b/doc/uk/org/ury/testrig/package-frame.html new file mode 100644 index 0000000..48ffe63 --- /dev/null +++ b/doc/uk/org/ury/testrig/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +uk.org.ury.testrig + + + + + + + + + + + +uk.org.ury.testrig + + + + +
+Classes  + +
+DemoControlPanel +
+DemoMenu +
+DemoMenuPanel
+ + + + diff --git a/doc/uk/org/ury/testrig/package-summary.html b/doc/uk/org/ury/testrig/package-summary.html new file mode 100644 index 0000000..eeb2333 --- /dev/null +++ b/doc/uk/org/ury/testrig/package-summary.html @@ -0,0 +1,165 @@ + + + + + + +uk.org.ury.testrig + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.testrig +

+ + + + + + + + + + + + + + + + + +
+Class Summary
DemoControlPanelControl panel for the demo system.
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/testrig/package-tree.html b/doc/uk/org/ury/testrig/package-tree.html new file mode 100644 index 0000000..dd0c35b --- /dev/null +++ b/doc/uk/org/ury/testrig/package-tree.html @@ -0,0 +1,178 @@ + + + + + + +uk.org.ury.testrig Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

+Uses of Package
uk.org.ury.testrig

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

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/res/conf.xml b/res/conf.xml index e685082..893efbf 100644 --- a/res/conf.xml +++ b/res/conf.xml @@ -13,10 +13,10 @@ 5432 membership - + - xauth - rCtVyBuN + bapsserver + Bap553rv3r read_only diff --git a/src/uk/org/ury/client/Client.java b/src/uk/org/ury/client/Client.java new file mode 100644 index 0000000..f0b2679 --- /dev/null +++ b/src/uk/org/ury/client/Client.java @@ -0,0 +1,65 @@ +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.ArrayList; +import java.util.List; + +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 List of lines. + */ + + public List + get (String file) + { + URL url = null; + URLConnection uc = null; + List result = new ArrayList (); + + 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.add (inputLine); + } + } + catch (IOException e) + { + // TODO Auto-generated catch block + e.printStackTrace (); + } + + return result; + } +} diff --git a/src/uk/org/ury/client/test/ClientTest.java b/src/uk/org/ury/client/test/ClientTest.java new file mode 100644 index 0000000..085bebb --- /dev/null +++ b/src/uk/org/ury/client/test/ClientTest.java @@ -0,0 +1,64 @@ +/** + * + */ +package uk.org.ury.client.test; + +import static org.junit.Assert.*; + +import java.util.List; + +import junit.framework.Assert; + +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +import uk.org.ury.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.client.Client#get(java.lang.String)}. + */ + + @Test + public void + testGet () + { + Client client = new Client (); + + List response = client.get ("/server/ServerRequestHandler?function=test"); + + Assert.assertEquals ("INFO: Test succeeded.", response.get (2)); + } + +} diff --git a/src/uk/org/ury/config/ConfigReader.java b/src/uk/org/ury/config/ConfigReader.java index 04deb49..ed2d852 100644 --- a/src/uk/org/ury/config/ConfigReader.java +++ b/src/uk/org/ury/config/ConfigReader.java @@ -1,7 +1,5 @@ package uk.org.ury.config; -import java.io.File; - import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; @@ -54,7 +52,7 @@ public class ConfigReader { try { DocumentBuilderFactory docBuilderFactory = DocumentBuilderFactory.newInstance(); DocumentBuilder docBuilder = docBuilderFactory.newDocumentBuilder(); - Document doc = docBuilder.parse (new File(configFile)); + Document doc = docBuilder.parse (configFile); doc.getDocumentElement().normalize(); NodeList nList = doc.getElementsByTagName("auth"); diff --git a/src/uk/org/ury/database/DatabaseDriver.java b/src/uk/org/ury/database/DatabaseDriver.java index a7db32e..7c71827 100644 --- a/src/uk/org/ury/database/DatabaseDriver.java +++ b/src/uk/org/ury/database/DatabaseDriver.java @@ -35,7 +35,8 @@ public class DatabaseDriver * Construct a new DatabaseDriver with the given user class. * * @param config The config with login details. - * @param userclass The user class to log in to the database with. + * + * @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). @@ -49,7 +50,8 @@ public class DatabaseDriver */ public - DatabaseDriver (ConfigReader config, UserClass type) throws MissingCredentialsException, ConnectionFailureException + DatabaseDriver (ConfigReader config, UserClass type) + throws MissingCredentialsException, ConnectionFailureException { try { @@ -73,7 +75,8 @@ public class DatabaseDriver */ private void - connect (ConfigReader config, UserClass type) throws SQLException + connect (ConfigReader config, UserClass type) + throws SQLException { if (config == null) throw new IllegalArgumentException ("Supplied null config."); @@ -113,23 +116,18 @@ public class DatabaseDriver * @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 { - try - { - Statement st = conn.createStatement (); - st.setFetchSize (fetchSize); + Statement st = conn.createStatement (); + st.setFetchSize (fetchSize); - return st.executeQuery (sql); - } - catch (SQLException e) - { - e.printStackTrace (); - return null; - } + return st.executeQuery (sql); } @@ -154,7 +152,8 @@ public class DatabaseDriver */ public ResultSet - executeQuery (String sql, Object[] params, int fetchSize) throws SQLException + executeQuery (String sql, Object[] params, int fetchSize) + throws SQLException { PreparedStatement st = conn.prepareStatement (sql); diff --git a/src/uk/org/ury/database/DatabaseItem.java b/src/uk/org/ury/database/DatabaseItem.java index 4f6d34d..f151dbf 100644 --- a/src/uk/org/ury/database/DatabaseItem.java +++ b/src/uk/org/ury/database/DatabaseItem.java @@ -1,8 +1,11 @@ package uk.org.ury.database; +import java.util.ArrayList; +import java.util.List; import java.util.Map; import uk.org.ury.database.exceptions.MissingPropertyException; +import uk.org.ury.server.protocol.Directive; /** @@ -21,6 +24,7 @@ public abstract class DatabaseItem { private Map properties; + /** * Construct a new item from an existing list of properties. * @@ -67,4 +71,30 @@ public abstract class DatabaseItem else throw new MissingPropertyException (property.toString ()); } + + + /** + * Map down the item into a server response body. + * + * This relies on E and T having meaningful toString methods. + * + * @return a list of lines representing the response. + */ + + public List + asResponse () + { + // TODO: Fan out implementation details into separate class + + List response = new ArrayList (); + + for (E property : properties.keySet ()) + { + if (properties.get (property) != null) + response.add (property.toString () + ": " + + properties.get (property).toString ()); + } + + return response; + } } diff --git a/src/uk/org/ury/frontend/AbstractFrontendModule.java b/src/uk/org/ury/frontend/AbstractFrontendModule.java index 99ff9cf..b5b55b6 100644 --- a/src/uk/org/ury/frontend/AbstractFrontendModule.java +++ b/src/uk/org/ury/frontend/AbstractFrontendModule.java @@ -1,6 +1,5 @@ package uk.org.ury.frontend; -import javax.swing.JApplet; /** * An abstract implementation of the FrontendModule interface. @@ -9,7 +8,7 @@ import javax.swing.JApplet; * */ -public abstract class AbstractFrontendModule extends JApplet implements FrontendModule +public abstract class AbstractFrontendModule implements FrontendModule { /** @@ -17,11 +16,5 @@ public abstract class AbstractFrontendModule extends JApplet implements Frontend */ private static final long serialVersionUID = 5309585577127763538L; - - /** - * Initialise the module as an applet. - */ - - public abstract void - init (); + /* Space for rent */ } diff --git a/src/uk/org/ury/frontend/FrontendApplet.java b/src/uk/org/ury/frontend/FrontendApplet.java new file mode 100644 index 0000000..18f0c7a --- /dev/null +++ b/src/uk/org/ury/frontend/FrontendApplet.java @@ -0,0 +1,343 @@ +/** + * + */ +package uk.org.ury.frontend; + +import java.awt.BorderLayout; +import java.awt.Dimension; + +import javax.swing.JApplet; +import javax.swing.UIManager; +import javax.swing.UnsupportedLookAndFeelException; + +import uk.org.ury.frontend.exceptions.LoadFailureException; +import uk.org.ury.testrig.Launcher; + +/** + * A frame that hosts a FrontendModulePanel, used for serving frontend + * panels in a window (application mode). + * + * @author Matt Windsor + * + */ + +public class FrontendApplet extends JApplet implements FrontendMaster, Launcher +{ + /** + * + */ + + private static final long serialVersionUID = 740928181256928433L; + + private FrontendModulePanel child; + private FrontendControlPanel cpanel; + + + /** + * Main method. + * + * @param args The command-line arguments to the program. These + * will currently be ignored. + */ + + @Override + public void + init () + { + try + { + javax.swing.SwingUtilities.invokeAndWait (new Runnable() + { + public void + run () + { + try + { + loadModule (DEFAULT_MODULE_NAME); + } + catch (LoadFailureException e) + { + // TODO Auto-generated catch block + e.printStackTrace (); + } + setupUI (); + } + }); + } + catch (Exception e) + { + e.printStackTrace (); + System.err.println("createGUI didn't successfully complete"); + } + } + + + /** + * Set up the user interface of the frame. + */ + + @Override + 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 + } + + + // Composition + + add (child, BorderLayout.CENTER); + + setPreferredSize (new Dimension (800, 600)); + setMinimumSize (new Dimension (800, 600)); + + 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); + + getContentPane ().add (child, BorderLayout.CENTER); + child.setMaster (this); + + repaint (); + } + } + + + /** + * 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); + repaint (); + } + } + + + /** + * 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); + + if (cpanel != null) + add (cpanel, BorderLayout.SOUTH); + + this.cpanel = cpanel; + + 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 getCodeBase () + "res/"; + } +} \ No newline at end of file diff --git a/src/uk/org/ury/frontend/FrontendControlPanel.java b/src/uk/org/ury/frontend/FrontendControlPanel.java index 5b7f486..b79021a 100644 --- a/src/uk/org/ury/frontend/FrontendControlPanel.java +++ b/src/uk/org/ury/frontend/FrontendControlPanel.java @@ -3,6 +3,8 @@ */ package uk.org.ury.frontend; +import uk.org.ury.frontend.exceptions.UICreationFailureException; + /** * Abstract class for frontend module control panels. @@ -38,26 +40,16 @@ public abstract class FrontendControlPanel extends FrontendPanel * @param xmlPath The path, relative from this source file, to the * XML file from which this panel will read its * layout. + * + * @throws UICreationFailureException if the UI creation fails. */ public FrontendControlPanel (String xmlPath) + throws UICreationFailureException { super (xmlPath, null); } - - - /** - * Set the frontend master to which this panel is bound. - * - * @param master The master to set. - */ - - public void - setMaster (FrontendMaster master) - { - this.master = master; - } /** diff --git a/src/uk/org/ury/frontend/FrontendError.java b/src/uk/org/ury/frontend/FrontendError.java index a08b966..4a13c0a 100644 --- a/src/uk/org/ury/frontend/FrontendError.java +++ b/src/uk/org/ury/frontend/FrontendError.java @@ -29,8 +29,8 @@ public class FrontendError /** * Create an error dialogue to report a fatal error. * - * @string message The message, eg the exception message, - * to report to the user. + * @param message The message, eg the exception message, + * to report to the user. */ public static void @@ -47,4 +47,15 @@ public class FrontendError System.exit (-1); } + + + public static void + reportFatal (String message, FrontendApplet panel) + { + // TODO: Log + + // TODO: Error dialogue + + System.out.println (message); + } } diff --git a/src/uk/org/ury/frontend/FrontendFrame.java b/src/uk/org/ury/frontend/FrontendFrame.java index aabdfbd..39cb89b 100644 --- a/src/uk/org/ury/frontend/FrontendFrame.java +++ b/src/uk/org/ury/frontend/FrontendFrame.java @@ -11,6 +11,8 @@ import javax.swing.JFrame; import javax.swing.UIManager; 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). @@ -31,11 +33,39 @@ public class FrontendFrame extends JFrame implements FrontendMaster 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 (FrontendModulePanel parent) + 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 () { - super (parent.getName ()); - try { // Set System L&F @@ -43,7 +73,7 @@ public class FrontendFrame extends JFrame implements FrontendMaster } catch (UnsupportedLookAndFeelException e) { - // handle exception + // handle exception } catch (ClassNotFoundException e) { @@ -60,21 +90,19 @@ public class FrontendFrame extends JFrame implements FrontendMaster setDefaultCloseOperation (JFrame.EXIT_ON_CLOSE); - this.child = parent; - Container cp = getContentPane (); // Banner - - banner = new FrontendBanner (parent.getName ()); + System.out.println (child); + banner = new FrontendBanner (child.getName ()); // Composition cp.add (banner, BorderLayout.NORTH); - cp.add (parent, BorderLayout.CENTER); + cp.add (child, BorderLayout.CENTER); setPreferredSize (new Dimension (800, 600)); - setMinimumSize (new Dimension (800, 600)); + setMinimumSize (new Dimension (800, 600)); pack (); setVisible (true); @@ -89,11 +117,16 @@ public class FrontendFrame extends JFrame implements FrontendMaster * * @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; @@ -103,11 +136,16 @@ public class FrontendFrame extends JFrame implements FrontendMaster } catch (ClassNotFoundException e) { - FrontendError.reportFatal ("Could not load module: " + e.getMessage (), this); + throw new LoadFailureException ("Could not load module: " + + e.getMessage ()); } - if (FrontendModule.class.isAssignableFrom (moduleClass)) + if (FrontendModule.class.isAssignableFrom (moduleClass) == false) + { + throw new LoadFailureException ("Could not load module: Not a FrontendModule"); + } + else { FrontendModulePanel temp = child; @@ -117,17 +155,24 @@ public class FrontendFrame extends JFrame implements FrontendMaster } catch (InstantiationException e) { - FrontendError.reportFatal ("Could not load module: " + e.getMessage (), this); + throw new LoadFailureException ("Could not load module: " + + e.getMessage ()); } catch (IllegalAccessException e) { - FrontendError.reportFatal ("Could not load module: " + e.getMessage (), this); + throw new LoadFailureException ("Could not load module: " + + e.getMessage ()); } - remove (temp); + if (temp != null) + remove (temp); + add (child); + child.setMaster (this); + + if (banner != null) + banner.setTitle (child.getName ()); - banner.setTitle (child.getName ()); pack (); } } @@ -146,11 +191,16 @@ public class FrontendFrame extends JFrame implements FrontendMaster * @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); @@ -172,11 +222,16 @@ public class FrontendFrame extends JFrame implements FrontendMaster * * @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; @@ -186,7 +241,8 @@ public class FrontendFrame extends JFrame implements FrontendMaster } catch (ClassNotFoundException e) { - FrontendError.reportFatal ("Could not load control panel: " + e.getMessage (), this); + throw new LoadFailureException ("Could not load control panel: " + + e.getMessage ()); } @@ -200,11 +256,13 @@ public class FrontendFrame extends JFrame implements FrontendMaster } catch (InstantiationException e) { - FrontendError.reportFatal ("Could not load module: " + e.getMessage (), this); + throw new LoadFailureException ("Could not load control panel: " + + e.getMessage ()); } catch (IllegalAccessException e) { - FrontendError.reportFatal ("Could not load module: " + e.getMessage (), this); + throw new LoadFailureException ("Could not load control panel: " + + e.getMessage ()); } if (temp != null) @@ -255,4 +313,31 @@ public class FrontendFrame extends JFrame implements FrontendMaster 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/FrontendMaster.java b/src/uk/org/ury/frontend/FrontendMaster.java index c169d04..0a89e89 100644 --- a/src/uk/org/ury/frontend/FrontendMaster.java +++ b/src/uk/org/ury/frontend/FrontendMaster.java @@ -3,6 +3,8 @@ */ package uk.org.ury.frontend; +import uk.org.ury.frontend.exceptions.LoadFailureException; + /** * Interface for classes providing the parent unit of a frontend @@ -24,10 +26,15 @@ public interface FrontendMaster * * @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. */ public void - loadModule (String moduleName); + loadModule (String moduleName) + throws LoadFailureException; /** @@ -40,13 +47,18 @@ public interface FrontendMaster * @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 + * @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. */ public void - loadModule (String moduleName, String cPanelName); + loadModule (String moduleName, String cPanelName) + throws LoadFailureException; /** @@ -62,4 +74,31 @@ public interface FrontendMaster public void restoreModule (FrontendModulePanel mpanel, FrontendControlPanel cpanel); + + + /** + * Report a fatal error, + * + * @param message The message, eg the exception message, to report + * to the user. + */ + + public void + fatalError (String message); + + + /** + * Set up the frontend master's user interface. + */ + + public void + setupUI (); + + + /** + * @return the resource directory. + */ + + public String + getResourceDirectory (); } diff --git a/src/uk/org/ury/frontend/FrontendModulePanel.java b/src/uk/org/ury/frontend/FrontendModulePanel.java index 148875f..f5009c4 100644 --- a/src/uk/org/ury/frontend/FrontendModulePanel.java +++ b/src/uk/org/ury/frontend/FrontendModulePanel.java @@ -3,6 +3,8 @@ */ package uk.org.ury.frontend; +import uk.org.ury.frontend.exceptions.UICreationFailureException; + /** * A frontend user interface panel. @@ -52,11 +54,14 @@ public abstract class FrontendModulePanel extends FrontendPanel * layout. * * @param master The FrontendMaster driving the frontend. + * + * @throws UICreationFailureException if the UI creation fails. */ public FrontendModulePanel (FrontendModule module, String xmlPath, FrontendMaster master) + throws UICreationFailureException { super (xmlPath, master); this.module = module; @@ -82,9 +87,4 @@ public abstract class FrontendModulePanel extends FrontendPanel { return module; } - - - /** - * - */ } diff --git a/src/uk/org/ury/frontend/FrontendPanel.java b/src/uk/org/ury/frontend/FrontendPanel.java index 0ec8003..931f86b 100644 --- a/src/uk/org/ury/frontend/FrontendPanel.java +++ b/src/uk/org/ury/frontend/FrontendPanel.java @@ -6,11 +6,18 @@ import javax.swing.JPanel; import org.swixml.SwingEngine; +import uk.org.ury.frontend.exceptions.UICreationFailureException; + /** * An extension of JPanel providing common functionality for user * interface panels in the URY system frontend. * + * Most notably, this includes automated access to XML-based + * preparation of the user interface provided by the panel, + * using an appropriate constructor call giving the XML file from + * which the user interface form should be read. + * * @author Matt Windsor * */ @@ -27,7 +34,9 @@ public class FrontendPanel extends JPanel /** * Construct a new, blank FrontendPanel. * - * @param master The FrontendMaster driving the frontend. + * @param master The FrontendMaster driving the frontend, if any. + * For direct instantiations of this class, + * providing null here is guaranteed to be safe. */ public @@ -43,17 +52,22 @@ public class FrontendPanel extends JPanel * Construct a new FrontendPanel from an XML layout. * * This is the preferred means of constructing FrontendPanels, and - * uses SWIXml to construct the panel layout. + * uses an XML-based engine to construct the panel layout. * * @param xmlPath The path, relative from this source file, to the * XML file from which this panel will read its * layout. * - * @param master The FrontendMaster driving the frontend. + * @param master The FrontendMaster driving the frontend, if any. + * For direct instantiations of this class, + * providing null here is guaranteed to be safe. + * + * @throws UICreationFailureException if the UI creation fails. */ public FrontendPanel (String xmlPath, FrontendMaster master) + throws UICreationFailureException { super (); @@ -65,8 +79,10 @@ public class FrontendPanel extends JPanel URL path = getClass ().getResource (xmlPath); if (path == null) - FrontendError.reportFatal ("UI creation failure: XML layout " - + xmlPath + " does not exist.", null); + throw new UICreationFailureException ("UI creation failure:" + + "XML layout " + + xmlPath + + " does not exist."); SwingEngine se = new SwingEngine (this); @@ -85,7 +101,21 @@ public class FrontendPanel extends JPanel } catch (Exception e) { - FrontendError.reportFatal ("UI creation failure: " + e.getMessage (), null); + throw new UICreationFailureException ("UI creation failure: " + + e.getMessage ()); } } + + + /** + * Set the frontend master. + * + * @param master The new frontend master to use. + */ + + public void + setMaster (FrontendMaster master) + { + this.master = master; + } } diff --git a/src/uk/org/ury/frontend/FrontendSubBanner.java b/src/uk/org/ury/frontend/FrontendSubBanner.java index da162bb..6942fe1 100644 --- a/src/uk/org/ury/frontend/FrontendSubBanner.java +++ b/src/uk/org/ury/frontend/FrontendSubBanner.java @@ -2,7 +2,6 @@ package uk.org.ury.frontend; import javax.swing.BorderFactory; import javax.swing.JLabel; -import javax.swing.JTextArea; import javax.swing.UIManager; @@ -15,6 +14,10 @@ import javax.swing.UIManager; public class FrontendSubBanner extends JLabel { + /** + * + */ + private static final long serialVersionUID = 7843563245601622086L; private static final String TITLE_PREFIX = ""; private static final String TITLE_SUFFIX = ""; diff --git a/src/uk/org/ury/frontend/exceptions/LoadFailureException.java b/src/uk/org/ury/frontend/exceptions/LoadFailureException.java new file mode 100644 index 0000000..691eaa0 --- /dev/null +++ b/src/uk/org/ury/frontend/exceptions/LoadFailureException.java @@ -0,0 +1,44 @@ +/** + * + */ +package uk.org.ury.frontend.exceptions; + + +/** + * Exception thrown when the loading of a new frontend module fails. + * + * @author Matt Windsor + */ + +public class LoadFailureException extends Exception +{ + /** + * + */ + private static final long serialVersionUID = -7353531873142099828L; + + +/** + * Construct a new LoadFailureException with a + * default reason. + */ + + public + LoadFailureException () + { + super ("Module load failure."); + } + + + /** + * Construct a new LoadFailureException. + * + * @param reason The explanation for the exception. + */ + + public + LoadFailureException (String reason) + { + super (reason); + } +} diff --git a/src/uk/org/ury/frontend/exceptions/UICreationFailureException.java b/src/uk/org/ury/frontend/exceptions/UICreationFailureException.java new file mode 100644 index 0000000..6d51ef3 --- /dev/null +++ b/src/uk/org/ury/frontend/exceptions/UICreationFailureException.java @@ -0,0 +1,44 @@ +/** + * + */ +package uk.org.ury.frontend.exceptions; + + +/** + * Exception thrown when the creation of a UI element fails. + * + * @author Matt Windsor + */ + +public class UICreationFailureException extends Exception +{ + /** + * + */ + private static final long serialVersionUID = -7353531873142099828L; + + +/** + * Construct a new UICreationFailureException with a + * default reason. + */ + + public + UICreationFailureException () + { + super ("UI creation failure."); + } + + + /** + * Construct a new UICreationFailureException. + * + * @param reason The explanation for the exception. + */ + + public + UICreationFailureException (String reason) + { + super (reason); + } +} diff --git a/src/uk/org/ury/library/LibraryRequestHandler.java b/src/uk/org/ury/library/LibraryRequestHandler.java new file mode 100644 index 0000000..30bb7fc --- /dev/null +++ b/src/uk/org/ury/library/LibraryRequestHandler.java @@ -0,0 +1,144 @@ +/** + * + */ +package uk.org.ury.library; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import uk.org.ury.database.DatabaseDriver; +import uk.org.ury.database.UserClass; +import uk.org.ury.database.exceptions.ConnectionFailureException; +import uk.org.ury.database.exceptions.MissingCredentialsException; +import uk.org.ury.database.exceptions.QueryFailureException; +import uk.org.ury.library.exceptions.EmptySearchException; +import uk.org.ury.library.item.LibraryItem; +import uk.org.ury.server.Server; +import uk.org.ury.server.RequestHandler; +import uk.org.ury.server.exceptions.HandleFailureException; +import uk.org.ury.server.protocol.Directive; + +/** + * A request handler for library queries. + * + * @author Matt Windsor + */ + +public class LibraryRequestHandler implements RequestHandler +{ + /** + * 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 List + handleGetRequest (Map parameters, Server server) + throws HandleFailureException + { + List response = new ArrayList (); + + if (parameters.containsKey ("function")) + { + String function = parameters.get ("function"); + + if (function.equals ("search")) + { + doSearch (parameters, response, server); + } + else if (function.equals ("help")) + { + response.add ("INFO: Available functions:"); + response.add ("INFO: search (string) - search library for string."); + } + else + throw new HandleFailureException ("Unknown function: " + + function + ". (Try 'function=help'.)"); + + } + else + throw new HandleFailureException ("No function provided. (Try 'function=help'.)"); + + return response; + } + + + /** + * 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, + List 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 + { + for (LibraryItem li : LibraryUtils.search (dd, search)) + { + response.add (Directive.ITEM_START.toString ()); + + response.addAll (li.asResponse ()); + + response.add (Directive.ITEM_END.toString ()); + } + } + catch (QueryFailureException e) + { + throw new HandleFailureException (e.getMessage ()); + } + catch (EmptySearchException e) + { + throw new HandleFailureException (e.getMessage ()); + } + } +} diff --git a/src/uk/org/ury/library/LibraryUtils.java b/src/uk/org/ury/library/LibraryUtils.java index a280738..8a71285 100644 --- a/src/uk/org/ury/library/LibraryUtils.java +++ b/src/uk/org/ury/library/LibraryUtils.java @@ -8,12 +8,16 @@ import java.sql.SQLException; import java.util.ArrayList; import java.util.HashMap; import java.util.List; +import java.util.Map; +import java.util.Map; import uk.org.ury.database.DatabaseDriver; import uk.org.ury.database.exceptions.QueryFailureException; -import uk.org.ury.library.LibraryItemProperty; import uk.org.ury.library.exceptions.EmptySearchException; +import uk.org.ury.library.item.LibraryItem; +import uk.org.ury.library.item.LibraryItemProperty; +import uk.org.ury.server.protocol.Directive; /** @@ -77,13 +81,9 @@ public class LibraryUtils + " 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, memberid_add, memberid_lastedit," - + " digitised, clean," - + " a.fname AS fnameadd, a.sname AS snameadd, b.fname AS fnameedit, b.sname AS snameedit" + + " shelfletter, shelfnumber, cdid, digitised, clean" + " FROM rec_record AS r" + " INNER JOIN rec_track AS t ON (r.recordid = t.recordid)" - + " INNER JOIN member AS a ON (a.memberid = r.memberid_add)" - + " LEFT JOIN member AS b ON (b.memberid = r.memberid_lastedit)" + " WHERE t.title ILIKE ?" + " OR t.artist ILIKE ?" + " OR r.title ILIKE ?" @@ -126,7 +126,7 @@ public class LibraryUtils { // Translate SQL columns into a list of properties. - HashMap properties = new HashMap (); + Map properties = new HashMap (); for (LibraryItemProperty p : LibraryItemProperty.values ()) { @@ -144,4 +144,102 @@ public class LibraryUtils return new LibraryItem (properties); } + + + /** + * Construct items from a server response body. + * + * @param response The list of strings that constitute the response. + * + * @return a list of LibraryItems corresponding to the item + * stanzas in the response. + */ + + public static List + extractItemsFromResponse (List response) + { + List result = new ArrayList (); + + boolean inItem = false; + List itemBuffer = new ArrayList (); + + for (String line : response) + { + if (inItem == false) + { + if (line.startsWith (Directive.ITEM_START.toString ())) + { + inItem = true; + itemBuffer.clear (); + } + } + + if (inItem == true) + { + itemBuffer.add (line); + + if (line.startsWith (Directive.ITEM_END.toString ())) + { + inItem = false; + result.add (createItemFromResponse (itemBuffer)); + } + } + } + + return result; + } + + + /** + * Construct a new item from a server response fragment. + * + * @param response The list of strings that constitutes the response. + * The list must begin with Directive.ITEM_START and + * end with Directive.ITEM_END's string + * representations and otherwise contain solely + * Directive.ITEM_PROPERTY lines. + * + * @return a LibraryItem embodying the properties described + * in the response fragment. + * + * @throws IllegalArgumentException if the response is + * malformed or null, or if the instantiation of + * DatabaseItem does not use String as its data type. + */ + + public static LibraryItem + createItemFromResponse (List response) + { + // TODO: More appropriate exceptions. + + if (response == null) + throw new IllegalArgumentException ("Response is null."); + else if (response.get (0).equals (Directive.ITEM_START.toString ()) + && response.get (response.size () - 1) + .equals (Directive.ITEM_END.toString ())) + { + // Response of size 2 must be blank. + if (response.size () <= 2) + throw new IllegalArgumentException ("Blank response."); + + Map properties = new HashMap (); + + for (int i = 0; i < response.size () - 1; i++) + { + // TODO: fan out impl. details to separate class + if (response.get (i) + .startsWith (Directive.ITEM_PROPERTY.toString ())) + { + String[] responseTuple = response.get (i).split (":="); + + properties.put (LibraryItemProperty.getFromSQL (responseTuple[1]), + responseTuple[2]); + } + } + + return new LibraryItem (properties); + } + else + throw new IllegalArgumentException ("Malformed response."); + } } diff --git a/src/uk/org/ury/library/item/LibraryItem.java b/src/uk/org/ury/library/item/LibraryItem.java new file mode 100644 index 0000000..d2a790b --- /dev/null +++ b/src/uk/org/ury/library/item/LibraryItem.java @@ -0,0 +1,26 @@ +/** + * + */ +package uk.org.ury.library.item; + + +import java.util.Map; + +import uk.org.ury.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/library/item/LibraryItemProperty.java b/src/uk/org/ury/library/item/LibraryItemProperty.java new file mode 100644 index 0000000..44f5f22 --- /dev/null +++ b/src/uk/org/ury/library/item/LibraryItemProperty.java @@ -0,0 +1,62 @@ +package uk.org.ury.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/library/viewer/LibraryTableModel.java b/src/uk/org/ury/library/viewer/LibraryTableModel.java new file mode 100644 index 0000000..1ce5709 --- /dev/null +++ b/src/uk/org/ury/library/viewer/LibraryTableModel.java @@ -0,0 +1,184 @@ +/** + * + */ +package uk.org.ury.library.viewer; + +import java.util.List; + +import javax.swing.table.AbstractTableModel; + +import uk.org.ury.database.exceptions.MissingPropertyException; +import uk.org.ury.library.item.LibraryItem; +import uk.org.ury.library.item.LibraryItemProperty; + + +/** + * A table model for the library viewer. + * + * @author Matt Windsor + */ + +public class LibraryTableModel extends AbstractTableModel +{ + + /** + * + */ + + private static final long serialVersionUID = -1744980619128903509L; + + private List data; + + + /** + * Construct a new table model. + * + * @param data The list of data on which the model will be based. + */ + + public + LibraryTableModel (List data) + { + this.data = data; + } + + + /* (non-Javadoc) + * @see javax.swing.table.TableModel#getColumnCount() + */ + + @Override + public int + getColumnCount () + { + return 6; + } + + + /* (non-Javadoc) + * @see javax.swing.table.TableModel#getRowCount() + */ + + @Override + public int + getRowCount () + { + return data.size (); + } + + + /** + * @param c The column whose class should be investigated. + * + * @return the column class of column c. + */ + + @Override + public Class + getColumnClass (int c) + { + return getValueAt (0, c).getClass (); + } + + + /* (non-Javadoc) + * @see javax.swing.table.TableModel#getValueAt(int, int) + */ + + @Override + public Object + getValueAt (int rowIndex, int columnIndex) + { + LibraryItem li = data.get (rowIndex); + + try + { + String[] columnData = {li.get (LibraryItemProperty.TITLE), + li.get (LibraryItemProperty.ARTIST), + li.get (LibraryItemProperty.ALBUM)}; + + switch (columnIndex) + { + default: // Title, artist, album, unknown + + if (columnIndex >= columnData.length) + return "Unknown"; + else + return columnData[columnIndex]; + + case 3: // Medium + + // TODO: Make this less kludge-y + + String mediumString = li.get (LibraryItemProperty.MEDIUM); + + if (mediumString.equals ("c")) + return "Compact Disc"; + else if (mediumString.equals ("7")) + return "7\" Vinyl"; + else if (mediumString.equals ("2")) + return "12\" Vinyl"; + else + return "Unrecognised"; + + case 4: // Clean? + + // Return true if marked true, false if marked false or unknown etc. + + String cleanString = li.get (LibraryItemProperty.IS_CLEAN); + + // TODO: Nicer way of showing this + + if (cleanString.equals ("y")) + return "Yes"; + else if (cleanString.equals ("n")) + return "No"; + else + return "???"; + + case 5: // isDigitised + + // Return true if marked true, false if marked false or unknown etc. + + String digitisedString = li.get (LibraryItemProperty.IS_DIGITISED); + + if (digitisedString.equals ("t")) + return true; + else + return false; + } + } + catch (MissingPropertyException e) + { + return "Unknown"; + } + } + + + /* (non-Javadoc) + * @see javax.swing.table.TableModel#getColumnName(int, int) + */ + + @Override + public String + getColumnName (int index) + { + switch (index) + { + case 0: + return "Title"; + case 1: + return "Artist"; + case 2: + return "Album"; + case 3: + return "Medium"; + case 4: + return "Clean?"; + case 5: + return "On system?"; + default: + return "ERROR"; + } + } +} diff --git a/src/uk/org/ury/library/viewer/LibraryViewer.java b/src/uk/org/ury/library/viewer/LibraryViewer.java index a98fa54..9587d5e 100644 --- a/src/uk/org/ury/library/viewer/LibraryViewer.java +++ b/src/uk/org/ury/library/viewer/LibraryViewer.java @@ -1,27 +1,21 @@ package uk.org.ury.library.viewer; -import java.lang.reflect.InvocationTargetException; - import java.util.ArrayList; import java.util.List; -import javax.swing.SwingUtilities; - import uk.org.ury.config.ConfigReader; import uk.org.ury.database.DatabaseDriver; import uk.org.ury.database.UserClass; import uk.org.ury.database.exceptions.MissingCredentialsException; import uk.org.ury.database.exceptions.QueryFailureException; import uk.org.ury.frontend.AbstractFrontendModule; -import uk.org.ury.frontend.FrontendError; -import uk.org.ury.frontend.FrontendFrame; import uk.org.ury.frontend.FrontendMaster; import uk.org.ury.frontend.FrontendModulePanel; - -import uk.org.ury.library.LibraryItem; +import uk.org.ury.frontend.exceptions.UICreationFailureException; import uk.org.ury.library.LibraryUtils; import uk.org.ury.library.exceptions.EmptySearchException; +import uk.org.ury.library.item.LibraryItem; public class LibraryViewer extends AbstractFrontendModule { @@ -33,7 +27,6 @@ public class LibraryViewer extends AbstractFrontendModule private DatabaseDriver dd; private List libraryList; private LibraryViewerPanel panel; - private FrontendFrame frame; private ConfigReader config; @@ -53,64 +46,9 @@ public class LibraryViewer extends AbstractFrontendModule System.out.println(e); } - frame = null; libraryList = new ArrayList (); panel = null; } - - - /** - * Initialise the library viewer frontend as an applet. - */ - - public void - init () - { - frame = null; - libraryList = new ArrayList (); - panel = null; - - - try - { - SwingUtilities.invokeAndWait (new Runnable () - { - public void - run () - { - panel.setOpaque (true); - setContentPane (panel); - - runFrontend (null); - } - - }); - } - catch (InterruptedException e) - { - // TODO Auto-generated catch block - e.printStackTrace (); - } - catch (InvocationTargetException e) - { - // TODO Auto-generated catch block - e.printStackTrace (); - } - } - - - /** - * Run the library viewer frontend as an applet. - */ - - public void - start () - { - frame = null; - panel = new LibraryViewerPanel (this, null); - - add (panel); - } /** @@ -129,14 +67,22 @@ public class LibraryViewer extends AbstractFrontendModule catch (MissingCredentialsException e) { // TODO: Privilege de-escalation - FrontendError.reportFatal (e.getMessage (), frame); + master.fatalError (e.getMessage ()); } catch (Exception f) { - FrontendError.reportFatal (f.getMessage (), frame); + master.fatalError (f.getMessage ()); } - panel = new LibraryViewerPanel (this, master); + try + { + panel = new LibraryViewerPanel (this, master); + } + catch (UICreationFailureException e) + { + master.fatalError (e.getMessage ()); + } + return panel; } @@ -152,19 +98,16 @@ public class LibraryViewer extends AbstractFrontendModule * * @throws EmptySearchException if the search string is * empty or null (from LibraryUtils.search). + * + * @throws QueryFailureException if the search query + * fails (from LibraryUtils.search). */ public void - doSearch (String search) throws EmptySearchException + doSearch (String search) + throws EmptySearchException, QueryFailureException { - try - { - libraryList = LibraryUtils.search (dd, search); - } - catch (QueryFailureException e) - { - FrontendError.reportFatal (e.getMessage (), frame); - } + libraryList = LibraryUtils.search (dd, search); } diff --git a/src/uk/org/ury/library/viewer/LibraryViewerPanel.java b/src/uk/org/ury/library/viewer/LibraryViewerPanel.java index 7638822..e453095 100644 --- a/src/uk/org/ury/library/viewer/LibraryViewerPanel.java +++ b/src/uk/org/ury/library/viewer/LibraryViewerPanel.java @@ -14,9 +14,10 @@ import javax.swing.JTable; import javax.swing.JTextField; import javax.swing.SwingWorker; +import uk.org.ury.database.exceptions.QueryFailureException; import uk.org.ury.frontend.FrontendMaster; import uk.org.ury.frontend.FrontendModulePanel; -import uk.org.ury.library.LibraryTableModel; +import uk.org.ury.frontend.exceptions.UICreationFailureException; import uk.org.ury.library.exceptions.EmptySearchException; @@ -59,10 +60,13 @@ public class LibraryViewerPanel extends FrontendModulePanel * @param viewer The LibraryViewer controlling this LibraryViewerPanel. * * @param master The FrontendMaster driving the frontend. + * + * @throws UICreationFailureException if the UI creation fails. */ public LibraryViewerPanel (LibraryViewer viewer, FrontendMaster master) + throws UICreationFailureException { super (viewer, "library_viewer_gui.xml", master); @@ -138,6 +142,10 @@ public class LibraryViewerPanel extends FrontendModulePanel { master.doSearch (searchField.getText ()); } + catch (QueryFailureException e) + { + searchFailureMessage = "Search failed: " + e.getMessage (); + } catch (EmptySearchException e) { searchFailureMessage = "Please type in a search term."; diff --git a/src/uk/org/ury/library/viewer/library_viewer_gui.xml b/src/uk/org/ury/library/viewer/library_viewer_gui.xml index 6b7e745..5177e3f 100644 --- a/src/uk/org/ury/library/viewer/library_viewer_gui.xml +++ b/src/uk/org/ury/library/viewer/library_viewer_gui.xml @@ -1,13 +1,11 @@ - -