From df7d7981b56a4560c95ea7e9b194080e93398ecf Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 21:54:31 +0000 Subject: GREAT PACKAGE RESHUFFLE: Everything is now organised into frontend, backend and common (to frontend and backend) packages. Things may have been broken. Doc refresh. --- doc/uk/org/ury/backend/config/Auth.html | 291 ++++++++++ doc/uk/org/ury/backend/config/ConfigReader.html | 315 +++++++++++ doc/uk/org/ury/backend/config/Database.html | 315 +++++++++++ doc/uk/org/ury/backend/config/class-use/Auth.html | 188 +++++++ .../ury/backend/config/class-use/ConfigReader.html | 179 ++++++ .../org/ury/backend/config/class-use/Database.html | 180 +++++++ doc/uk/org/ury/backend/config/package-frame.html | 36 ++ doc/uk/org/ury/backend/config/package-summary.html | 165 ++++++ doc/uk/org/ury/backend/config/package-tree.html | 153 ++++++ doc/uk/org/ury/backend/config/package-use.html | 195 +++++++ .../org/ury/backend/database/DatabaseDriver.html | 317 +++++++++++ doc/uk/org/ury/backend/database/DatabaseItem.html | 320 +++++++++++ doc/uk/org/ury/backend/database/UserClass.html | 376 +++++++++++++ .../backend/database/class-use/DatabaseDriver.html | 250 +++++++++ .../backend/database/class-use/DatabaseItem.html | 209 +++++++ .../ury/backend/database/class-use/UserClass.html | 233 ++++++++ .../exceptions/ConnectionFailureException.html | 269 +++++++++ .../exceptions/MissingCredentialsException.html | 275 ++++++++++ .../exceptions/MissingPropertyException.html | 271 ++++++++++ .../database/exceptions/QueryFailureException.html | 269 +++++++++ .../class-use/ConnectionFailureException.html | 208 +++++++ .../class-use/MissingCredentialsException.html | 235 ++++++++ .../class-use/MissingPropertyException.html | 180 +++++++ .../class-use/QueryFailureException.html | 250 +++++++++ .../backend/database/exceptions/package-frame.html | 38 ++ .../database/exceptions/package-summary.html | 189 +++++++ .../backend/database/exceptions/package-tree.html | 158 ++++++ .../backend/database/exceptions/package-use.html | 295 ++++++++++ doc/uk/org/ury/backend/database/package-frame.html | 45 ++ .../org/ury/backend/database/package-summary.html | 196 +++++++ doc/uk/org/ury/backend/database/package-tree.html | 163 ++++++ doc/uk/org/ury/backend/database/package-use.html | 276 ++++++++++ .../backend/handlers/LibraryRequestHandler.html | 307 +++++++++++ .../handlers/class-use/LibraryRequestHandler.html | 144 +++++ doc/uk/org/ury/backend/handlers/package-frame.html | 32 ++ .../org/ury/backend/handlers/package-summary.html | 157 ++++++ doc/uk/org/ury/backend/handlers/package-tree.html | 156 ++++++ doc/uk/org/ury/backend/handlers/package-use.html | 144 +++++ .../ury/backend/server/AbstractRequestHandler.html | 290 ++++++++++ .../org/ury/backend/server/ApiRequestHandler.html | 238 ++++++++ doc/uk/org/ury/backend/server/HttpHandler.html | 309 +++++++++++ .../org/ury/backend/server/HttpListenerThread.html | 322 +++++++++++ .../org/ury/backend/server/HttpWorkerThread.html | 324 +++++++++++ doc/uk/org/ury/backend/server/Server.html | 384 +++++++++++++ .../ury/backend/server/ServerRequestHandler.html | 283 ++++++++++ .../server/class-use/AbstractRequestHandler.html | 209 +++++++ .../server/class-use/ApiRequestHandler.html | 180 +++++++ .../ury/backend/server/class-use/HttpHandler.html | 144 +++++ .../server/class-use/HttpListenerThread.html | 144 +++++ .../backend/server/class-use/HttpWorkerThread.html | 144 +++++ .../org/ury/backend/server/class-use/Server.html | 249 +++++++++ .../server/class-use/ServerRequestHandler.html | 144 +++++ .../server/exceptions/BadRequestException.html | 271 ++++++++++ .../server/exceptions/HandleFailureException.html | 270 ++++++++++ .../exceptions/HandlerNotFoundException.html | 275 ++++++++++ .../exceptions/HandlerSetupFailureException.html | 278 ++++++++++ .../server/exceptions/HandlingException.html | 275 ++++++++++ .../server/exceptions/NotAHandlerException.html | 254 +++++++++ .../exceptions/UnknownFunctionException.html | 252 +++++++++ .../exceptions/class-use/BadRequestException.html | 213 ++++++++ .../class-use/HandleFailureException.html | 233 ++++++++ .../class-use/HandlerNotFoundException.html | 213 ++++++++ .../class-use/HandlerSetupFailureException.html | 213 ++++++++ .../exceptions/class-use/HandlingException.html | 226 ++++++++ .../exceptions/class-use/NotAHandlerException.html | 213 ++++++++ .../class-use/UnknownFunctionException.html | 182 +++++++ .../backend/server/exceptions/package-frame.html | 44 ++ .../backend/server/exceptions/package-summary.html | 187 +++++++ .../backend/server/exceptions/package-tree.html | 160 ++++++ .../ury/backend/server/exceptions/package-use.html | 273 ++++++++++ doc/uk/org/ury/backend/server/package-frame.html | 53 ++ doc/uk/org/ury/backend/server/package-summary.html | 220 ++++++++ doc/uk/org/ury/backend/server/package-tree.html | 166 ++++++ doc/uk/org/ury/backend/server/package-use.html | 210 ++++++++ doc/uk/org/ury/common/library/LibraryUtils.html | 277 ++++++++++ .../ury/common/library/class-use/LibraryUtils.html | 144 +++++ .../library/exceptions/EmptySearchException.html | 272 ++++++++++ .../exceptions/class-use/EmptySearchException.html | 210 ++++++++ .../common/library/exceptions/package-frame.html | 32 ++ .../common/library/exceptions/package-summary.html | 158 ++++++ .../common/library/exceptions/package-tree.html | 158 ++++++ .../ury/common/library/exceptions/package-use.html | 191 +++++++ .../org/ury/common/library/item/LibraryItem.html | 242 +++++++++ .../common/library/item/LibraryItemProperty.html | 599 +++++++++++++++++++++ .../common/library/item/class-use/LibraryItem.html | 224 ++++++++ .../item/class-use/LibraryItemProperty.html | 211 ++++++++ .../org/ury/common/library/item/package-frame.html | 43 ++ .../ury/common/library/item/package-summary.html | 171 ++++++ .../org/ury/common/library/item/package-tree.html | 165 ++++++ .../org/ury/common/library/item/package-use.html | 208 +++++++ doc/uk/org/ury/common/library/package-frame.html | 32 ++ doc/uk/org/ury/common/library/package-summary.html | 158 ++++++ doc/uk/org/ury/common/library/package-tree.html | 153 ++++++ doc/uk/org/ury/common/library/package-use.html | 144 +++++ doc/uk/org/ury/common/protocol/Directive.html | 362 +++++++++++++ doc/uk/org/ury/common/protocol/ProtocolUtils.html | 322 +++++++++++ doc/uk/org/ury/common/protocol/Status.html | 330 ++++++++++++ .../ury/common/protocol/class-use/Directive.html | 189 +++++++ .../common/protocol/class-use/ProtocolUtils.html | 144 +++++ .../org/ury/common/protocol/class-use/Status.html | 189 +++++++ .../exceptions/DecodeFailureException.html | 250 +++++++++ .../exceptions/InvalidMessageException.html | 251 +++++++++ .../class-use/DecodeFailureException.html | 209 +++++++ .../class-use/InvalidMessageException.html | 209 +++++++ .../common/protocol/exceptions/package-frame.html | 34 ++ .../protocol/exceptions/package-summary.html | 162 ++++++ .../common/protocol/exceptions/package-tree.html | 158 ++++++ .../common/protocol/exceptions/package-use.html | 216 ++++++++ doc/uk/org/ury/common/protocol/package-frame.html | 45 ++ .../org/ury/common/protocol/package-summary.html | 176 ++++++ doc/uk/org/ury/common/protocol/package-tree.html | 163 ++++++ doc/uk/org/ury/common/protocol/package-use.html | 176 ++++++ doc/uk/org/ury/common/show/ShowChannel.html | 369 +++++++++++++ doc/uk/org/ury/common/show/ShowUtils.html | 345 ++++++++++++ .../org/ury/common/show/class-use/ShowChannel.html | 195 +++++++ .../org/ury/common/show/class-use/ShowUtils.html | 144 +++++ doc/uk/org/ury/common/show/item/ShowItem.html | 278 ++++++++++ .../org/ury/common/show/item/ShowItemProperty.html | 382 +++++++++++++ .../ury/common/show/item/class-use/ShowItem.html | 224 ++++++++ .../show/item/class-use/ShowItemProperty.html | 203 +++++++ doc/uk/org/ury/common/show/item/package-frame.html | 43 ++ .../org/ury/common/show/item/package-summary.html | 189 +++++++ doc/uk/org/ury/common/show/item/package-tree.html | 165 ++++++ doc/uk/org/ury/common/show/item/package-use.html | 189 +++++++ doc/uk/org/ury/common/show/package-frame.html | 34 ++ doc/uk/org/ury/common/show/package-summary.html | 162 ++++++ doc/uk/org/ury/common/show/package-tree.html | 156 ++++++ doc/uk/org/ury/common/show/package-use.html | 170 ++++++ .../org/ury/frontend/AbstractFrontendModule.html | 4 +- doc/uk/org/ury/frontend/FrontendApplet.html | 12 +- doc/uk/org/ury/frontend/FrontendBanner.html | 2 +- doc/uk/org/ury/frontend/FrontendControlPanel.html | 4 +- doc/uk/org/ury/frontend/FrontendError.html | 2 +- doc/uk/org/ury/frontend/FrontendFrame.html | 64 +-- doc/uk/org/ury/frontend/FrontendMaster.html | 2 +- doc/uk/org/ury/frontend/FrontendModule.html | 23 +- doc/uk/org/ury/frontend/FrontendModulePanel.html | 4 +- doc/uk/org/ury/frontend/FrontendPanel.html | 4 +- doc/uk/org/ury/frontend/FrontendSubBanner.html | 2 +- doc/uk/org/ury/frontend/HintField.html | 2 +- .../frontend/class-use/AbstractFrontendModule.html | 36 +- .../org/ury/frontend/class-use/FrontendApplet.html | 2 +- .../org/ury/frontend/class-use/FrontendBanner.html | 2 +- .../frontend/class-use/FrontendControlPanel.html | 25 +- .../org/ury/frontend/class-use/FrontendError.html | 2 +- .../org/ury/frontend/class-use/FrontendFrame.html | 2 +- .../org/ury/frontend/class-use/FrontendMaster.html | 58 +- .../org/ury/frontend/class-use/FrontendModule.html | 36 +- .../frontend/class-use/FrontendModulePanel.html | 55 +- .../org/ury/frontend/class-use/FrontendPanel.html | 104 ++-- .../ury/frontend/class-use/FrontendSubBanner.html | 2 +- doc/uk/org/ury/frontend/class-use/HintField.html | 2 +- doc/uk/org/ury/frontend/client/Client.html | 259 +++++++++ .../org/ury/frontend/client/class-use/Client.html | 144 +++++ doc/uk/org/ury/frontend/client/package-frame.html | 32 ++ .../org/ury/frontend/client/package-summary.html | 157 ++++++ doc/uk/org/ury/frontend/client/package-tree.html | 153 ++++++ doc/uk/org/ury/frontend/client/package-use.html | 144 +++++ .../org/ury/frontend/client/test/ClientTest.html | 306 +++++++++++ .../frontend/client/test/class-use/ClientTest.html | 144 +++++ .../ury/frontend/client/test/package-frame.html | 32 ++ .../ury/frontend/client/test/package-summary.html | 157 ++++++ .../org/ury/frontend/client/test/package-tree.html | 153 ++++++ .../org/ury/frontend/client/test/package-use.html | 144 +++++ .../frontend/cpanels/menu/DemoControlPanel.html | 397 ++++++++++++++ .../cpanels/menu/class-use/DemoControlPanel.html | 144 +++++ .../ury/frontend/cpanels/menu/package-frame.html | 32 ++ .../ury/frontend/cpanels/menu/package-summary.html | 157 ++++++ .../ury/frontend/cpanels/menu/package-tree.html | 168 ++++++ .../org/ury/frontend/cpanels/menu/package-use.html | 144 +++++ .../frontend/cpanels/show/LibraryControlPanel.html | 397 ++++++++++++++ .../show/class-use/LibraryControlPanel.html | 144 +++++ .../ury/frontend/cpanels/show/package-frame.html | 32 ++ .../ury/frontend/cpanels/show/package-summary.html | 157 ++++++ .../ury/frontend/cpanels/show/package-tree.html | 168 ++++++ .../org/ury/frontend/cpanels/show/package-use.html | 144 +++++ .../frontend/exceptions/LoadFailureException.html | 2 +- .../exceptions/UICreationFailureException.html | 2 +- .../exceptions/class-use/LoadFailureException.html | 6 +- .../class-use/UICreationFailureException.html | 87 +-- .../org/ury/frontend/exceptions/package-frame.html | 2 +- .../ury/frontend/exceptions/package-summary.html | 10 +- .../org/ury/frontend/exceptions/package-tree.html | 10 +- .../org/ury/frontend/exceptions/package-use.html | 45 +- .../modules/library/LibraryTableModel.html | 362 +++++++++++++ .../frontend/modules/library/LibraryViewer.html | 327 +++++++++++ .../modules/library/LibraryViewerPanel.html | 424 +++++++++++++++ .../library/class-use/LibraryTableModel.html | 144 +++++ .../modules/library/class-use/LibraryViewer.html | 179 ++++++ .../library/class-use/LibraryViewerPanel.html | 144 +++++ .../frontend/modules/library/package-frame.html | 36 ++ .../frontend/modules/library/package-summary.html | 165 ++++++ .../ury/frontend/modules/library/package-tree.html | 174 ++++++ .../ury/frontend/modules/library/package-use.html | 170 ++++++ doc/uk/org/ury/frontend/modules/menu/DemoMenu.html | 307 +++++++++++ .../ury/frontend/modules/menu/DemoMenuPanel.html | 390 ++++++++++++++ .../frontend/modules/menu/class-use/DemoMenu.html | 144 +++++ .../modules/menu/class-use/DemoMenuPanel.html | 144 +++++ .../ury/frontend/modules/menu/package-frame.html | 34 ++ .../ury/frontend/modules/menu/package-summary.html | 161 ++++++ .../ury/frontend/modules/menu/package-tree.html | 171 ++++++ .../org/ury/frontend/modules/menu/package-use.html | 144 +++++ .../ury/frontend/modules/show/ChannelPanel.html | 363 +++++++++++++ .../org/ury/frontend/modules/show/ShowViewer.html | 315 +++++++++++ .../ury/frontend/modules/show/ShowViewerPanel.html | 431 +++++++++++++++ doc/uk/org/ury/frontend/modules/show/TrackBin.html | 363 +++++++++++++ .../modules/show/class-use/ChannelPanel.html | 144 +++++ .../modules/show/class-use/ShowViewer.html | 179 ++++++ .../modules/show/class-use/ShowViewerPanel.html | 144 +++++ .../frontend/modules/show/class-use/TrackBin.html | 144 +++++ .../ury/frontend/modules/show/package-frame.html | 38 ++ .../ury/frontend/modules/show/package-summary.html | 169 ++++++ .../ury/frontend/modules/show/package-tree.html | 171 ++++++ .../org/ury/frontend/modules/show/package-use.html | 170 ++++++ doc/uk/org/ury/frontend/package-frame.html | 2 +- doc/uk/org/ury/frontend/package-summary.html | 18 +- doc/uk/org/ury/frontend/package-tree.html | 12 +- doc/uk/org/ury/frontend/package-use.html | 134 +++-- .../ury/frontend/testrig/ApplicationLauncher.html | 289 ++++++++++ doc/uk/org/ury/frontend/testrig/Launcher.html | 215 ++++++++ .../testrig/class-use/ApplicationLauncher.html | 144 +++++ .../ury/frontend/testrig/class-use/Launcher.html | 210 ++++++++ doc/uk/org/ury/frontend/testrig/package-frame.html | 43 ++ .../org/ury/frontend/testrig/package-summary.html | 171 ++++++ doc/uk/org/ury/frontend/testrig/package-tree.html | 159 ++++++ doc/uk/org/ury/frontend/testrig/package-use.html | 189 +++++++ 226 files changed, 38675 insertions(+), 335 deletions(-) create mode 100644 doc/uk/org/ury/backend/config/Auth.html create mode 100644 doc/uk/org/ury/backend/config/ConfigReader.html create mode 100644 doc/uk/org/ury/backend/config/Database.html create mode 100644 doc/uk/org/ury/backend/config/class-use/Auth.html create mode 100644 doc/uk/org/ury/backend/config/class-use/ConfigReader.html create mode 100644 doc/uk/org/ury/backend/config/class-use/Database.html create mode 100644 doc/uk/org/ury/backend/config/package-frame.html create mode 100644 doc/uk/org/ury/backend/config/package-summary.html create mode 100644 doc/uk/org/ury/backend/config/package-tree.html create mode 100644 doc/uk/org/ury/backend/config/package-use.html create mode 100644 doc/uk/org/ury/backend/database/DatabaseDriver.html create mode 100644 doc/uk/org/ury/backend/database/DatabaseItem.html create mode 100644 doc/uk/org/ury/backend/database/UserClass.html create mode 100644 doc/uk/org/ury/backend/database/class-use/DatabaseDriver.html create mode 100644 doc/uk/org/ury/backend/database/class-use/DatabaseItem.html create mode 100644 doc/uk/org/ury/backend/database/class-use/UserClass.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/ConnectionFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/MissingCredentialsException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/MissingPropertyException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/QueryFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/ConnectionFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/MissingCredentialsException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/MissingPropertyException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/QueryFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-use.html create mode 100644 doc/uk/org/ury/backend/database/package-frame.html create mode 100644 doc/uk/org/ury/backend/database/package-summary.html create mode 100644 doc/uk/org/ury/backend/database/package-tree.html create mode 100644 doc/uk/org/ury/backend/database/package-use.html create mode 100644 doc/uk/org/ury/backend/handlers/LibraryRequestHandler.html create mode 100644 doc/uk/org/ury/backend/handlers/class-use/LibraryRequestHandler.html create mode 100644 doc/uk/org/ury/backend/handlers/package-frame.html create mode 100644 doc/uk/org/ury/backend/handlers/package-summary.html create mode 100644 doc/uk/org/ury/backend/handlers/package-tree.html create mode 100644 doc/uk/org/ury/backend/handlers/package-use.html create mode 100644 doc/uk/org/ury/backend/server/AbstractRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/ApiRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/HttpHandler.html create mode 100644 doc/uk/org/ury/backend/server/HttpListenerThread.html create mode 100644 doc/uk/org/ury/backend/server/HttpWorkerThread.html create mode 100644 doc/uk/org/ury/backend/server/Server.html create mode 100644 doc/uk/org/ury/backend/server/ServerRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/class-use/AbstractRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/class-use/ApiRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/class-use/HttpHandler.html create mode 100644 doc/uk/org/ury/backend/server/class-use/HttpListenerThread.html create mode 100644 doc/uk/org/ury/backend/server/class-use/HttpWorkerThread.html create mode 100644 doc/uk/org/ury/backend/server/class-use/Server.html create mode 100644 doc/uk/org/ury/backend/server/class-use/ServerRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/BadRequestException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/HandleFailureException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/HandlerNotFoundException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/HandlingException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/NotAHandlerException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/UnknownFunctionException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/BadRequestException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/HandleFailureException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/HandlerNotFoundException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/HandlerSetupFailureException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/HandlingException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/NotAHandlerException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/UnknownFunctionException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/package-use.html create mode 100644 doc/uk/org/ury/backend/server/package-frame.html create mode 100644 doc/uk/org/ury/backend/server/package-summary.html create mode 100644 doc/uk/org/ury/backend/server/package-tree.html create mode 100644 doc/uk/org/ury/backend/server/package-use.html create mode 100644 doc/uk/org/ury/common/library/LibraryUtils.html create mode 100644 doc/uk/org/ury/common/library/class-use/LibraryUtils.html create mode 100644 doc/uk/org/ury/common/library/exceptions/EmptySearchException.html create mode 100644 doc/uk/org/ury/common/library/exceptions/class-use/EmptySearchException.html create mode 100644 doc/uk/org/ury/common/library/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/common/library/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/common/library/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/common/library/exceptions/package-use.html create mode 100644 doc/uk/org/ury/common/library/item/LibraryItem.html create mode 100644 doc/uk/org/ury/common/library/item/LibraryItemProperty.html create mode 100644 doc/uk/org/ury/common/library/item/class-use/LibraryItem.html create mode 100644 doc/uk/org/ury/common/library/item/class-use/LibraryItemProperty.html create mode 100644 doc/uk/org/ury/common/library/item/package-frame.html create mode 100644 doc/uk/org/ury/common/library/item/package-summary.html create mode 100644 doc/uk/org/ury/common/library/item/package-tree.html create mode 100644 doc/uk/org/ury/common/library/item/package-use.html create mode 100644 doc/uk/org/ury/common/library/package-frame.html create mode 100644 doc/uk/org/ury/common/library/package-summary.html create mode 100644 doc/uk/org/ury/common/library/package-tree.html create mode 100644 doc/uk/org/ury/common/library/package-use.html create mode 100644 doc/uk/org/ury/common/protocol/Directive.html create mode 100644 doc/uk/org/ury/common/protocol/ProtocolUtils.html create mode 100644 doc/uk/org/ury/common/protocol/Status.html create mode 100644 doc/uk/org/ury/common/protocol/class-use/Directive.html create mode 100644 doc/uk/org/ury/common/protocol/class-use/ProtocolUtils.html create mode 100644 doc/uk/org/ury/common/protocol/class-use/Status.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/DecodeFailureException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/InvalidMessageException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/class-use/DecodeFailureException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/class-use/InvalidMessageException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/package-use.html create mode 100644 doc/uk/org/ury/common/protocol/package-frame.html create mode 100644 doc/uk/org/ury/common/protocol/package-summary.html create mode 100644 doc/uk/org/ury/common/protocol/package-tree.html create mode 100644 doc/uk/org/ury/common/protocol/package-use.html create mode 100644 doc/uk/org/ury/common/show/ShowChannel.html create mode 100644 doc/uk/org/ury/common/show/ShowUtils.html create mode 100644 doc/uk/org/ury/common/show/class-use/ShowChannel.html create mode 100644 doc/uk/org/ury/common/show/class-use/ShowUtils.html create mode 100644 doc/uk/org/ury/common/show/item/ShowItem.html create mode 100644 doc/uk/org/ury/common/show/item/ShowItemProperty.html create mode 100644 doc/uk/org/ury/common/show/item/class-use/ShowItem.html create mode 100644 doc/uk/org/ury/common/show/item/class-use/ShowItemProperty.html create mode 100644 doc/uk/org/ury/common/show/item/package-frame.html create mode 100644 doc/uk/org/ury/common/show/item/package-summary.html create mode 100644 doc/uk/org/ury/common/show/item/package-tree.html create mode 100644 doc/uk/org/ury/common/show/item/package-use.html create mode 100644 doc/uk/org/ury/common/show/package-frame.html create mode 100644 doc/uk/org/ury/common/show/package-summary.html create mode 100644 doc/uk/org/ury/common/show/package-tree.html create mode 100644 doc/uk/org/ury/common/show/package-use.html create mode 100644 doc/uk/org/ury/frontend/client/Client.html create mode 100644 doc/uk/org/ury/frontend/client/class-use/Client.html create mode 100644 doc/uk/org/ury/frontend/client/package-frame.html create mode 100644 doc/uk/org/ury/frontend/client/package-summary.html create mode 100644 doc/uk/org/ury/frontend/client/package-tree.html create mode 100644 doc/uk/org/ury/frontend/client/package-use.html create mode 100644 doc/uk/org/ury/frontend/client/test/ClientTest.html create mode 100644 doc/uk/org/ury/frontend/client/test/class-use/ClientTest.html create mode 100644 doc/uk/org/ury/frontend/client/test/package-frame.html create mode 100644 doc/uk/org/ury/frontend/client/test/package-summary.html create mode 100644 doc/uk/org/ury/frontend/client/test/package-tree.html create mode 100644 doc/uk/org/ury/frontend/client/test/package-use.html create mode 100644 doc/uk/org/ury/frontend/cpanels/menu/DemoControlPanel.html create mode 100644 doc/uk/org/ury/frontend/cpanels/menu/class-use/DemoControlPanel.html create mode 100644 doc/uk/org/ury/frontend/cpanels/menu/package-frame.html create mode 100644 doc/uk/org/ury/frontend/cpanels/menu/package-summary.html create mode 100644 doc/uk/org/ury/frontend/cpanels/menu/package-tree.html create mode 100644 doc/uk/org/ury/frontend/cpanels/menu/package-use.html create mode 100644 doc/uk/org/ury/frontend/cpanels/show/LibraryControlPanel.html create mode 100644 doc/uk/org/ury/frontend/cpanels/show/class-use/LibraryControlPanel.html create mode 100644 doc/uk/org/ury/frontend/cpanels/show/package-frame.html create mode 100644 doc/uk/org/ury/frontend/cpanels/show/package-summary.html create mode 100644 doc/uk/org/ury/frontend/cpanels/show/package-tree.html create mode 100644 doc/uk/org/ury/frontend/cpanels/show/package-use.html create mode 100644 doc/uk/org/ury/frontend/modules/library/LibraryTableModel.html create mode 100644 doc/uk/org/ury/frontend/modules/library/LibraryViewer.html create mode 100644 doc/uk/org/ury/frontend/modules/library/LibraryViewerPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/library/class-use/LibraryTableModel.html create mode 100644 doc/uk/org/ury/frontend/modules/library/class-use/LibraryViewer.html create mode 100644 doc/uk/org/ury/frontend/modules/library/class-use/LibraryViewerPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/library/package-frame.html create mode 100644 doc/uk/org/ury/frontend/modules/library/package-summary.html create mode 100644 doc/uk/org/ury/frontend/modules/library/package-tree.html create mode 100644 doc/uk/org/ury/frontend/modules/library/package-use.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/DemoMenu.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/DemoMenuPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/class-use/DemoMenu.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/class-use/DemoMenuPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/package-frame.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/package-summary.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/package-tree.html create mode 100644 doc/uk/org/ury/frontend/modules/menu/package-use.html create mode 100644 doc/uk/org/ury/frontend/modules/show/ChannelPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/show/ShowViewer.html create mode 100644 doc/uk/org/ury/frontend/modules/show/ShowViewerPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/show/TrackBin.html create mode 100644 doc/uk/org/ury/frontend/modules/show/class-use/ChannelPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/show/class-use/ShowViewer.html create mode 100644 doc/uk/org/ury/frontend/modules/show/class-use/ShowViewerPanel.html create mode 100644 doc/uk/org/ury/frontend/modules/show/class-use/TrackBin.html create mode 100644 doc/uk/org/ury/frontend/modules/show/package-frame.html create mode 100644 doc/uk/org/ury/frontend/modules/show/package-summary.html create mode 100644 doc/uk/org/ury/frontend/modules/show/package-tree.html create mode 100644 doc/uk/org/ury/frontend/modules/show/package-use.html create mode 100644 doc/uk/org/ury/frontend/testrig/ApplicationLauncher.html create mode 100644 doc/uk/org/ury/frontend/testrig/Launcher.html create mode 100644 doc/uk/org/ury/frontend/testrig/class-use/ApplicationLauncher.html create mode 100644 doc/uk/org/ury/frontend/testrig/class-use/Launcher.html create mode 100644 doc/uk/org/ury/frontend/testrig/package-frame.html create mode 100644 doc/uk/org/ury/frontend/testrig/package-summary.html create mode 100644 doc/uk/org/ury/frontend/testrig/package-tree.html create mode 100644 doc/uk/org/ury/frontend/testrig/package-use.html (limited to 'doc/uk/org') diff --git a/doc/uk/org/ury/backend/config/Auth.html b/doc/uk/org/ury/backend/config/Auth.html new file mode 100644 index 0000000..4393cbc --- /dev/null +++ b/doc/uk/org/ury/backend/config/Auth.html @@ -0,0 +1,291 @@ + + + + + + +Auth + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

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

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

+A login authorisation configuration +

+ +

+

+
Author:
+
Nathan Lasseter
+
+
+ +

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

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

+Auth

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

+

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

+getUser

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

+

+ +
Returns:
String username
+
+
+
+ +

+getPass

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

+

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

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

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

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

+ +

+

+
Author:
+
Nathan Lasseter
+
+
+ +

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

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

+ConfigReader

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

+

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

+getDatabase

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

+

+ +
Returns:
Database database
+
+
+
+ +

+getRoAuth

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

+

+ +
Returns:
Auth roAauth
+
+
+
+ +

+getRwAuth

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

+

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

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

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

+A Database Server configuration +

+ +

+

+
Author:
+
Nathan Lasseter
+
+
+ +

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

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

+Database

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

+

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

+getHost

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

+

+ +
Returns:
String hostname
+
+
+
+ +

+getPort

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

+

+ +
Returns:
int port
+
+
+
+ +

+getDb

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

+

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

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

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

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

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

+

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

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

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

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

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

+

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

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

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

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

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

+

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

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

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

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

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

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

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

+

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

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

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

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

+ +

+

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

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

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

+DatabaseDriver

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

+

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

+executeQuery

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

+

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

+executeQuery

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

+

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

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

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

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

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+DatabaseItem

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

+

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

+has

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

+

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

+get

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

+

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

+asResponse

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

+

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

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

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

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

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+READ_ONLY

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

+READ_WRITE

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

+configName

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

+

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

+values

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

+

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

+valueOf

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

+

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

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

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

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

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

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

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

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

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

+

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

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

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

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

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

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

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

+

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

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

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

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

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

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

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

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

+

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

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

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

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

+ +

+

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

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

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

+ConnectionFailureException

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

+

+
+ +

+ConnectionFailureException

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

+

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

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

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

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

+ +

+

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

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

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

+MissingCredentialsException

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

+

+
+ +

+MissingCredentialsException

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

+

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

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

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

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

+ +

+

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

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

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

+MissingPropertyException

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

+

+
+ +

+MissingPropertyException

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

+

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

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

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

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

+ +

+

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

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

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

+QueryFailureException

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

+

+
+ +

+QueryFailureException

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

+

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

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

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

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

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

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

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

+

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

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

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

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

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

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

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

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

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

+

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

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

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

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

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

+

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

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

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

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

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

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

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

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

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

+

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

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

+Exceptions thrown by the database services classes. +

+See: +
+          Description +

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

+

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

+ +

+

Exceptions thrown by the database services classes.

+

+ +

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

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

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

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

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

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

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

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

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

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

+

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

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

+Database services for the URY Presenter Suite. +

+See: +
+          Description +

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

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

+

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

+ +

+

Database services for the URY Presenter Suite.

+

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

+

+ +

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

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

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

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

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

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

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

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

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

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

+

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

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

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

+A request handler for library queries. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+LibraryRequestHandler

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

+

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

+handleGet

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

+

+
+
+
+
Parameters:
request - The HTTP request.
response - The response that the handler will populate during the + handling of the request.
context - The HTTP context. +
Throws: +
HandlerNotFoundException - if the client requested a request handler that could not be + found on the class path. +
HandlerSetupFailureException - if the handler was found but could not be set up (eg does not + implement appropriate interface or cannot be instantiated). +
HandleFailureException - if an appropriate handler was contacted, but it failed to + process the request. +
BadRequestException - if the request was malformed or invalid. +
NotAHandlerException - if the class requested to handle the request is not a + handler. +
UnknownFunctionException - if the request is for a path that does not correspond to one + of this handler's functions.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/handlers/class-use/LibraryRequestHandler.html b/doc/uk/org/ury/backend/handlers/class-use/LibraryRequestHandler.html new file mode 100644 index 0000000..7b0212b --- /dev/null +++ b/doc/uk/org/ury/backend/handlers/class-use/LibraryRequestHandler.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.backend.handlers.LibraryRequestHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

+

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

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

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

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

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

+

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

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

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

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

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+AbstractRequestHandler

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

+

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

+handle

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

+

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

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

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

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

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+handleGetRequest

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

+

+
Parameters:
parameters - A key-value map of parameters supplied with the + server request. Typically, the "function" + parameter will detail the function that the + request handler is expected to perform.
server - The server from which the request originated. + This will be able to provide the handler with + pooled resources, for example the database. +
Returns:
A series of key-value pairs to pass back to + the client. +
Throws: +
HandleFailureException - if the handler cannot + handle the request.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/HttpHandler.html b/doc/uk/org/ury/backend/server/HttpHandler.html new file mode 100644 index 0000000..3417051 --- /dev/null +++ b/doc/uk/org/ury/backend/server/HttpHandler.html @@ -0,0 +1,309 @@ + + + + + + +HttpHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

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

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

+

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

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

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

+HttpHandler

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

+

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

+handleGet

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

+

+
+
+
+
Parameters:
request - The HTTP request.
response - The response that the handler will populate during the + handling of the request.
context - The HTTP context. +
Throws: +
HandlerNotFoundException - if the client requested a request handler that could not be + found on the class path. +
HandlerSetupFailureException - if the handler was found but could not be set up (eg does not + implement appropriate interface or cannot be instantiated). +
HandleFailureException - if an appropriate handler was contacted, but it failed to + process the request. +
BadRequestException - if the request was malformed or invalid. +
NotAHandlerException - if the class requested to handle the request is not a + handler.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/HttpListenerThread.html b/doc/uk/org/ury/backend/server/HttpListenerThread.html new file mode 100644 index 0000000..18c5b3f --- /dev/null +++ b/doc/uk/org/ury/backend/server/HttpListenerThread.html @@ -0,0 +1,322 @@ + + + + + + +HttpListenerThread + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

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

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

+Listener thread for the URY server HTTP interface. +

+ +

+

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

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

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

+HttpListenerThread

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

+run

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

+

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

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

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

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

+ +

+

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

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

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

+HttpWorkerThread

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

+

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

+run

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

+

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

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

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

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

+ +

+

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

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

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

+SERVER_VERSION

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

+DOCTYPE

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

+INDEX_HTML

+
+public static final java.lang.String INDEX_HTML
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+Server

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

+main

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

+

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

+getDatabaseConnection

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

+

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

+getVersion

+
+public java.lang.String getVersion()
+
+
+ +
Returns:
the version string of the server.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/ServerRequestHandler.html b/doc/uk/org/ury/backend/server/ServerRequestHandler.html new file mode 100644 index 0000000..217821e --- /dev/null +++ b/doc/uk/org/ury/backend/server/ServerRequestHandler.html @@ -0,0 +1,283 @@ + + + + + + +ServerRequestHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

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

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

+A request handler for server queries. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+ServerRequestHandler

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

+handleGetRequest

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

+

+
Specified by:
handleGetRequest in interface ApiRequestHandler
+
+
+
Parameters:
parameters - A key-value map of parameters supplied with + the server request. Typically, the function + parameter will detail the function that the + request handler is expected to perform.
server - The server from which the request originated. + This will be able to provide the handler with + pooled resources, for example the database. +
Returns:
A list of lines to return in the body of the + server's response to the client. +
Throws: +
HandleFailureException - if the handler cannot + handle the request.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/class-use/AbstractRequestHandler.html b/doc/uk/org/ury/backend/server/class-use/AbstractRequestHandler.html new file mode 100644 index 0000000..bcd6183 --- /dev/null +++ b/doc/uk/org/ury/backend/server/class-use/AbstractRequestHandler.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.AbstractRequestHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

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

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

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

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

+

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

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

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

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

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

+

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

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

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

+

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

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

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

+

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

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

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

+

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

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

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

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

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

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

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

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

+

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

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

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

+

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

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

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

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

+ +

+

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

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

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

+BadRequestException

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

+

+
+ +

+BadRequestException

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

+

+
Parameters:
cause - The exception that this new exception is to + wrap.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/exceptions/HandleFailureException.html b/doc/uk/org/ury/backend/server/exceptions/HandleFailureException.html new file mode 100644 index 0000000..1c5629f --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/HandleFailureException.html @@ -0,0 +1,270 @@ + + + + + + +HandleFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

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

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

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

+ +

+

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

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

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

+HandleFailureException

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

+

+
+ +

+HandleFailureException

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

+

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

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

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

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

+ +

+

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

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

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

+HandlerNotFoundException

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

+

+
+ +

+HandlerNotFoundException

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

+

+
Parameters:
className - The name of the missing handler class.
cause - The exception that this new exception is to + wrap.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.html b/doc/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.html new file mode 100644 index 0000000..6820215 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.html @@ -0,0 +1,278 @@ + + + + + + +HandlerSetupFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

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

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

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

+ +

+

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

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

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

+HandlerSetupFailureException

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

+

+
+ +

+HandlerSetupFailureException

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

+

+
Parameters:
className - The name of the failed handler class.
cause - The exception that this new exception is to + wrap.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/exceptions/HandlingException.html b/doc/uk/org/ury/backend/server/exceptions/HandlingException.html new file mode 100644 index 0000000..04ea1db --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/HandlingException.html @@ -0,0 +1,275 @@ + + + + + + +HandlingException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

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

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

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

+ +

+

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

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

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

+HandlingException

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

+

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

+HandlingException

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

+

+
Parameters:
string - The reason to present.
cause - The thrown cause that this exception should wrap.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/exceptions/NotAHandlerException.html b/doc/uk/org/ury/backend/server/exceptions/NotAHandlerException.html new file mode 100644 index 0000000..bec4181 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/NotAHandlerException.html @@ -0,0 +1,254 @@ + + + + + + +NotAHandlerException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

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

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

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

+ +

+

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

+ + + + + + + + + + + +
+Constructor Summary
NotAHandlerException(java.lang.String className) + +
+          Construct a NotAHandlerException with the name of the class that + is not a handler.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

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

+NotAHandlerException

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

+

+
Parameters:
className - The name of the offending class.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/exceptions/UnknownFunctionException.html b/doc/uk/org/ury/backend/server/exceptions/UnknownFunctionException.html new file mode 100644 index 0000000..29c6529 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/UnknownFunctionException.html @@ -0,0 +1,252 @@ + + + + + + +UnknownFunctionException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

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

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

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

+ +

+

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

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

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

+UnknownFunctionException

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

+

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

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

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

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

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

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

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

+

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

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

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

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

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

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

+ + + + + + + + + + + + + + + + + +
Methods in uk.org.ury.backend.server that throw HandleFailureException
+ voidHttpHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
+          Handle a HTTP GET request.
+ java.util.Map<java.lang.String,java.lang.Object>ApiRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, + Server server) + +
+          Handle a server GET request (that is, a request for data + output).
+ java.util.Map<java.lang.String,java.lang.Object>ServerRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, + Server server) + +
+          Handle a server GET request (that is, a request for data + output).
+  +

+

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

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

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

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

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

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

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

+

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

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

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

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

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

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

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

+

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

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

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

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

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

+

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

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

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

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

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

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

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

+

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

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

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

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

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

+

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

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

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

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

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

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

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

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

+

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

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

+The URY Server kernel. +

+See: +
+          Description +

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

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

+

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

+ +

+

The URY Server kernel.

+

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

+

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

+

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

+ +

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

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

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

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

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

+ + + + + + + + + + + + + + +
+Classes in uk.org.ury.backend.server used by uk.org.ury.backend.server
AbstractRequestHandler + +
+          An abstract request handler for HttpCore, providing basic functionality such + as uniform error response.
ApiRequestHandler + +
+          Interface for classes that can handle requests addressed to their + class name from the main server.
Server + +
+          The unified URY server, accepting requests over HTTP.
+  +

+

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

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

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

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

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+LibraryUtils

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

+search

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

+

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

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

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

+

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

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

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

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

+ +

+

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

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

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

+EmptySearchException

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

+

+
+ +

+EmptySearchException

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

+

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

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

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

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

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

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

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

+

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

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

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

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

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

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

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

+

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

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

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

+An item in the URY library. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+LibraryItem

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

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

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

+The parameters that are stored in the LibraryItem. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
ALBUM + +
+           
ARTIST + +
+           
CD_ID + +
+           
DATE_ADDED + +
+           
DATE_EDITED + +
+           
DATE_RELEASED + +
+           
FORMAT + +
+           
IS_CLEAN + +
+           
IS_DIGITISED + +
+           
LABEL + +
+           
MEDIUM + +
+           
SHELF_LETTER + +
+           
SHELF_NUMBER + +
+           
STATUS + +
+           
TITLE + +
+           
+  + + + + + + + + + + +
+Field Summary
+ java.lang.Stringsql + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static LibraryItemPropertygetFromSQL(java.lang.String string) + +
+          Retrieve a LibraryItemProperty given its SQL identifier.
+static LibraryItemPropertyvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static LibraryItemProperty[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

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

+TITLE

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

+ALBUM

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

+ARTIST

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

+LABEL

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

+STATUS

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

+MEDIUM

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

+FORMAT

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

+DATE_RELEASED

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

+DATE_ADDED

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

+DATE_EDITED

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

+SHELF_LETTER

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

+SHELF_NUMBER

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

+CD_ID

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

+IS_DIGITISED

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

+IS_CLEAN

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

+sql

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

+values

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

+

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

+valueOf

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

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+
+ +

+getFromSQL

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

+

+
Parameters:
string - The SQL identifier. +
Returns:
The first property to match. +
Throws: +
java.lang.IllegalArgumentException - if no matches were + found.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/library/item/class-use/LibraryItem.html b/doc/uk/org/ury/common/library/item/class-use/LibraryItem.html new file mode 100644 index 0000000..cb099ec --- /dev/null +++ b/doc/uk/org/ury/common/library/item/class-use/LibraryItem.html @@ -0,0 +1,224 @@ + + + + + + +Uses of Class uk.org.ury.common.library.item.LibraryItem + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

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

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

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

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

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

+

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

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

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

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

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

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

+

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

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

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

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

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

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

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

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

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

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/library/package-frame.html b/doc/uk/org/ury/common/library/package-frame.html new file mode 100644 index 0000000..dab4935 --- /dev/null +++ b/doc/uk/org/ury/common/library/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +uk.org.ury.common.library + + + + + + + + + + + +uk.org.ury.common.library + + + + +
+Classes  + +
+LibraryUtils
+ + + + diff --git a/doc/uk/org/ury/common/library/package-summary.html b/doc/uk/org/ury/common/library/package-summary.html new file mode 100644 index 0000000..4df5c5b --- /dev/null +++ b/doc/uk/org/ury/common/library/package-summary.html @@ -0,0 +1,158 @@ + + + + + + +uk.org.ury.common.library + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

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

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

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

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/Directive.html b/doc/uk/org/ury/common/protocol/Directive.html new file mode 100644 index 0000000..7ec7a46 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/Directive.html @@ -0,0 +1,362 @@ + + + + + + +Directive + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +uk.org.ury.common.protocol +
+Enum Directive

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

+Directives supported by the protocol. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
INFO + +
+           
ITEMS + +
+           
REASON + +
+           
STATUS + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static DirectivevalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static Directive[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

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

+INFO

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

+ITEMS

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

+STATUS

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

+REASON

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

+values

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

+

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

+valueOf

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

+

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

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

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

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

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+ProtocolUtils

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

+encode

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

+

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

+decode

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

+

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

+responseIsOK

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

+

+
Parameters:
response - The response message, as a key-value map (eg in decoded + format). +
Returns:
true if the response is flagged with OK status, false if not (eg + ERROR status). +
Throws: +
InvalidMessageException - if the response is invalid (eg the status is missing).
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/Status.html b/doc/uk/org/ury/common/protocol/Status.html new file mode 100644 index 0000000..8ec2dc4 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/Status.html @@ -0,0 +1,330 @@ + + + + + + +Status + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +uk.org.ury.common.protocol +
+Enum Status

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

+Statuses that can follow the STATUS directory. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+OK

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

+ERROR

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

+values

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

+

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

+valueOf

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

+

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

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

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

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

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

+

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

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

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

+

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

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

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

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

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

+

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

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

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

+Exception thrown when the protocol decoder fails. +

+ +

+

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

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

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

+DecodeFailureException

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

+

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

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

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

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

+ +

+

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

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

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

+InvalidMessageException

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

+

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

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

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

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

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

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

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

+

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

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

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

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

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

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

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

+

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

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

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

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

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

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

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

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

+

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

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

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

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

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

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

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

+

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

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

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

+A channel of ShowItems in a show. +

+ +

+

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

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

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

+ShowChannel

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

+

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

+add

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

+

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

+add

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

+

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

+get

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

+

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

+getElementAt

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

+

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

+getSize

+
+public int getSize()
+
+
+ +
Returns:
the size of the list.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/show/ShowUtils.html b/doc/uk/org/ury/common/show/ShowUtils.html new file mode 100644 index 0000000..71d01a6 --- /dev/null +++ b/doc/uk/org/ury/common/show/ShowUtils.html @@ -0,0 +1,345 @@ + + + + + + +ShowUtils + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

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

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

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

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+NUM_CHANNELS

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

+

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

+ShowUtils

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

+getPublicFolders

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

+

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

+getChannelList

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

+

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

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

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

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

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

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

+

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

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

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

+

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

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

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

+An item in the show database. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+ShowItem

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

+

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

+toString

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

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

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

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

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+NAME1

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

+NAME2

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

+POSITION

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

+sql

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

+values

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

+

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

+valueOf

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

+

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

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

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

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

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

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

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

+

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

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

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

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

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

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

+

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

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

+The show item class and related properties. +

+See: +
+          Description +

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

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

+

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

+ +

+

The show item class and related properties.

+

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

+

+ +

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

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

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

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

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

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

+

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

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

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

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

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

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

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/AbstractFrontendModule.html b/doc/uk/org/ury/frontend/AbstractFrontendModule.html index 0eea2a6..a639028 100644 --- a/doc/uk/org/ury/frontend/AbstractFrontendModule.html +++ b/doc/uk/org/ury/frontend/AbstractFrontendModule.html @@ -2,7 +2,7 @@ - + AbstractFrontendModule @@ -99,7 +99,7 @@ java.lang.Object
All Implemented Interfaces:
FrontendModule
-
Direct Known Subclasses:
DemoMenu, LibraryViewer, ShowViewer
+
Direct Known Subclasses:
DemoMenu, LibraryViewer, ShowViewer
diff --git a/doc/uk/org/ury/frontend/FrontendApplet.html b/doc/uk/org/ury/frontend/FrontendApplet.html index 757e506..1a131b0 100644 --- a/doc/uk/org/ury/frontend/FrontendApplet.html +++ b/doc/uk/org/ury/frontend/FrontendApplet.html @@ -2,7 +2,7 @@ - + FrontendApplet @@ -101,11 +101,11 @@ java.lang.Object extended by uk.org.ury.frontend.FrontendApplet
-
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, FrontendMaster, Launcher
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, FrontendMaster, Launcher
-
public class FrontendApplet
extends javax.swing.JApplet
implements FrontendMaster, Launcher
+
public class FrontendApplet
extends javax.swing.JApplet
implements FrontendMaster, Launcher

@@ -158,13 +158,13 @@ A frame that hosts a FrontendModulePanel, used for serving frontend panels in BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT -  +  - + - +
Fields inherited from interface uk.org.ury.testrig.LauncherFields inherited from interface uk.org.ury.frontend.testrig.Launcher
DEFAULT_MODULE_NAMEDEFAULT_MODULE_NAME
  diff --git a/doc/uk/org/ury/frontend/FrontendBanner.html b/doc/uk/org/ury/frontend/FrontendBanner.html index 4d015e1..9d129db 100644 --- a/doc/uk/org/ury/frontend/FrontendBanner.html +++ b/doc/uk/org/ury/frontend/FrontendBanner.html @@ -2,7 +2,7 @@ - + FrontendBanner diff --git a/doc/uk/org/ury/frontend/FrontendControlPanel.html b/doc/uk/org/ury/frontend/FrontendControlPanel.html index fd5d1c3..357b4a7 100644 --- a/doc/uk/org/ury/frontend/FrontendControlPanel.html +++ b/doc/uk/org/ury/frontend/FrontendControlPanel.html @@ -2,7 +2,7 @@ - + FrontendControlPanel @@ -104,7 +104,7 @@ java.lang.Object

All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
-
Direct Known Subclasses:
DemoControlPanel, LibraryControlPanel
+
Direct Known Subclasses:
DemoControlPanel, LibraryControlPanel
diff --git a/doc/uk/org/ury/frontend/FrontendError.html b/doc/uk/org/ury/frontend/FrontendError.html index 741ddab..7948526 100644 --- a/doc/uk/org/ury/frontend/FrontendError.html +++ b/doc/uk/org/ury/frontend/FrontendError.html @@ -2,7 +2,7 @@ - + FrontendError diff --git a/doc/uk/org/ury/frontend/FrontendFrame.html b/doc/uk/org/ury/frontend/FrontendFrame.html index 8f2f727..7b45c1a 100644 --- a/doc/uk/org/ury/frontend/FrontendFrame.html +++ b/doc/uk/org/ury/frontend/FrontendFrame.html @@ -2,7 +2,7 @@ - + FrontendFrame @@ -109,8 +109,8 @@ java.lang.Object

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

@@ -250,8 +250,8 @@ A frame that hosts a FrontendModulePanel, used for serving frontend java.lang.String cPanelName)
-          Load a module into the frontend frame, additionally installing - a control panel to communicate with the previous module. +          Load a module into the frontend frame, additionally installing a control + panel to communicate with the previous module. @@ -260,8 +260,7 @@ A frame that hosts a FrontendModulePanel, used for serving frontend FrontendControlPanel cpanel)
-          Restore an existing module and control panel into the frontend - frame. +          Restore an existing module and control panel into the frontend frame. @@ -355,12 +354,12 @@ public FrontendFrame(java.lang.String moduleName)

Construct a new FrontendFrame given an initial frontend module. - Loading will fail with a fatal error if the class is not found, - or is not an implementor of FrontendModule. + Loading will fail with a fatal error if the class is not found, or is not + an implementor of FrontendModule.

-
Parameters:
moduleName - The fully qualified class-name of the module, - minus the leading "uk.org.ury." domain.
+
Parameters:
moduleName - The fully qualified class-name of the module, minus the + leading "uk.org.ury." domain.
@@ -397,19 +396,18 @@ public void loadModule(java.lang.String moduleName)
Load a module into the frontend frame. - Loading will fail with a fatal error if the class is not found, - or is not an implementor of FrontendModule. + Loading will fail with a fatal error if the class is not found, or is not + an implementor of FrontendModule.

Specified by:
loadModule in interface FrontendMaster
-
Parameters:
moduleName - The fully qualified class-name of the module, - minus the leading "uk.org.ury." domain. +
Parameters:
moduleName - The fully qualified class-name of the module, minus the + leading "uk.org.ury." domain.
Throws: -
LoadFailureException - if the class is - not found, or is not an implementor of - FrontendModule.
+
LoadFailureException - if the class is not found, or is not an implementor of + FrontendModule.
@@ -421,24 +419,22 @@ public void loadModule(java.lang.String moduleName, java.lang.String cPanelName) throws LoadFailureException
-
Load a module into the frontend frame, additionally installing - a control panel to communicate with the previous module. +
Load a module into the frontend frame, additionally installing a control + panel to communicate with the previous module. - Loading will fail with a fatal error if the class is not found, - or is not an implementor of FrontendModule. + Loading will fail with a fatal error if the class is not found, or is not + an implementor of FrontendModule.

Specified by:
loadModule in interface FrontendMaster
-
Parameters:
moduleName - The fully qualified class-name of the module, - minus the leading "uk.org.ury." domain.
cPanelName - The fully qualified class-name of the control - panel to install, minus the leading - "uk.org.ury." domain. +
Parameters:
moduleName - The fully qualified class-name of the module, minus the + leading "uk.org.ury." domain.
cPanelName - The fully qualified class-name of the control panel to + install, minus the leading "uk.org.ury." domain.
Throws: -
LoadFailureException - if the class is - not found, or is not an implementor of - FrontendModule.
+
LoadFailureException - if the class is not found, or is not an implementor of + FrontendModule.
@@ -449,15 +445,14 @@ restoreModule public void restoreModule(FrontendModulePanel mpanel, FrontendControlPanel cpanel)
-
Restore an existing module and control panel into the frontend - frame. +
Restore an existing module and control panel into the frontend frame.

Specified by:
restoreModule in interface FrontendMaster
-
Parameters:
mpanel - The module panel to restore.
cpanel - The control panel to restore, if any. A null - value signifies a lack of control panel. +
Parameters:
mpanel - The module panel to restore.
cpanel - The control panel to restore, if any. A null value signifies a + lack of control panel.
Throws:
java.lang.IllegalArgumentException - if the mpanel is null.
@@ -475,8 +470,7 @@ public void fatalError(java.lang.String message)
Specified by:
fatalError in interface FrontendMaster
-
Parameters:
message - The message, eg the exception message, to report - to the user.
+
Parameters:
message - The message, eg the exception message, to report to the user.
diff --git a/doc/uk/org/ury/frontend/FrontendMaster.html b/doc/uk/org/ury/frontend/FrontendMaster.html index 4045ace..5660bca 100644 --- a/doc/uk/org/ury/frontend/FrontendMaster.html +++ b/doc/uk/org/ury/frontend/FrontendMaster.html @@ -2,7 +2,7 @@ - + FrontendMaster diff --git a/doc/uk/org/ury/frontend/FrontendModule.html b/doc/uk/org/ury/frontend/FrontendModule.html index f5acde2..761de60 100644 --- a/doc/uk/org/ury/frontend/FrontendModule.html +++ b/doc/uk/org/ury/frontend/FrontendModule.html @@ -2,7 +2,7 @@ - + FrontendModule @@ -92,7 +92,7 @@ uk.org.ury.frontend
Interface FrontendModule
-
All Known Implementing Classes:
AbstractFrontendModule, DemoMenu, LibraryViewer, ShowViewer
+
All Known Implementing Classes:
AbstractFrontendModule, DemoMenu, LibraryViewer, ShowViewer
@@ -100,22 +100,20 @@ Interface FrontendModule

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

- + +Uses of FrontendPanel in uk.org.ury.frontend.modules.show
-Uses of FrontendPanel in uk.org.ury.testrig
  @@ -227,23 +261,31 @@ Uses of -Subclasses of FrontendPanel in uk.org.ury.testrig +Subclasses of FrontendPanel in uk.org.ury.frontend.modules.show  class -DemoControlPanel +ChannelPanel
-          Control panel for the demo system. +          A panel displaying channel information.  class -DemoMenuPanel +ShowViewerPanel
-            +          Frontend panel providing access to an underlying show viewer. + + + + class +TrackBin + +
+          A panel displaying track bin contents.   diff --git a/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html b/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html index 8bcae14..8fb5bdc 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html @@ -2,7 +2,7 @@ - + Uses of Class uk.org.ury.frontend.FrontendSubBanner diff --git a/doc/uk/org/ury/frontend/class-use/HintField.html b/doc/uk/org/ury/frontend/class-use/HintField.html index e830fd0..5225f05 100644 --- a/doc/uk/org/ury/frontend/class-use/HintField.html +++ b/doc/uk/org/ury/frontend/class-use/HintField.html @@ -2,7 +2,7 @@ - + Uses of Class uk.org.ury.frontend.HintField diff --git a/doc/uk/org/ury/frontend/client/Client.html b/doc/uk/org/ury/frontend/client/Client.html new file mode 100644 index 0000000..870ab92 --- /dev/null +++ b/doc/uk/org/ury/frontend/client/Client.html @@ -0,0 +1,259 @@ + + + + + + +Client + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

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

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

+

+ +

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

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

+Client

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

+get

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

+

+
Parameters:
file - The "file", including path and query string, to fetch from the + server. +
Returns:
The response from the server, as a key-value map. +
Throws: +
DecodeFailureException - if the decode failed.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/client/class-use/Client.html b/doc/uk/org/ury/frontend/client/class-use/Client.html new file mode 100644 index 0000000..ab39a6e --- /dev/null +++ b/doc/uk/org/ury/frontend/client/class-use/Client.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.client.Client + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

+

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

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

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

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

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

+

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

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

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

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

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

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

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

+ClientTest

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

+setUp

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

+tearDown

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

+testGet

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

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/client/test/class-use/ClientTest.html b/doc/uk/org/ury/frontend/client/test/class-use/ClientTest.html new file mode 100644 index 0000000..d87bdfa --- /dev/null +++ b/doc/uk/org/ury/frontend/client/test/class-use/ClientTest.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.client.test.ClientTest + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

+

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

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

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

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

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

+

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

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

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

+Control panel for the demo system. +

+ +

+

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

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
DemoControlPanel() + +
+          Constructs a new DemoControlPanel.
+  + + + + + + + + + + + +
+Method Summary
+ voidback() + +
+          Go back to the previous module.
+  + + + + + + + +
Methods inherited from class uk.org.ury.frontend.FrontendControlPanel
setPanels, setPreviousCPanel
+  + + + + + + + +
Methods inherited from class uk.org.ury.frontend.FrontendPanel
setMaster
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

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

+DemoControlPanel

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

+

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

+back

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

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/cpanels/menu/class-use/DemoControlPanel.html b/doc/uk/org/ury/frontend/cpanels/menu/class-use/DemoControlPanel.html new file mode 100644 index 0000000..6c3a708 --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/menu/class-use/DemoControlPanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.cpanels.menu.DemoControlPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

+

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

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

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

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/cpanels/menu/package-use.html b/doc/uk/org/ury/frontend/cpanels/menu/package-use.html new file mode 100644 index 0000000..ed8eb7a --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/menu/package-use.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Package uk.org.ury.frontend.cpanels.menu + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
uk.org.ury.frontend.cpanels.menu

+
+No usage of uk.org.ury.frontend.cpanels.menu +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/cpanels/show/LibraryControlPanel.html b/doc/uk/org/ury/frontend/cpanels/show/LibraryControlPanel.html new file mode 100644 index 0000000..6cf1c8c --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/show/LibraryControlPanel.html @@ -0,0 +1,397 @@ + + + + + + +LibraryControlPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend.cpanels.show +
+Class LibraryControlPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.FrontendControlPanel
+                          extended by uk.org.ury.frontend.cpanels.show.LibraryControlPanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
+
public class LibraryControlPanel
extends FrontendControlPanel
+ + +

+Control panel for the demo system. +

+ +

+

+
Author:
+
Matt Windsor
+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
LibraryControlPanel() + +
+          Construct a new LibraryControlPanel.
+  + + + + + + + + + + + +
+Method Summary
+ voidback() + +
+          Go back to the previous module.
+  + + + + + + + +
Methods inherited from class uk.org.ury.frontend.FrontendControlPanel
setPanels, setPreviousCPanel
+  + + + + + + + +
Methods inherited from class uk.org.ury.frontend.FrontendPanel
setMaster
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LibraryControlPanel

+
+public LibraryControlPanel()
+                    throws UICreationFailureException
+
+
Construct a new LibraryControlPanel. +

+

+ +
Throws: +
UICreationFailureException - if the UI creation fails.
+
+ + + + + + + + +
+Method Detail
+ +

+back

+
+public void back()
+
+
Go back to the previous module. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/cpanels/show/class-use/LibraryControlPanel.html b/doc/uk/org/ury/frontend/cpanels/show/class-use/LibraryControlPanel.html new file mode 100644 index 0000000..bb6ec65 --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/show/class-use/LibraryControlPanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.cpanels.show.LibraryControlPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.frontend.cpanels.show.LibraryControlPanel

+
+No usage of uk.org.ury.frontend.cpanels.show.LibraryControlPanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/cpanels/show/package-frame.html b/doc/uk/org/ury/frontend/cpanels/show/package-frame.html new file mode 100644 index 0000000..fbec8e6 --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/show/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +uk.org.ury.frontend.cpanels.show + + + + + + + + + + + +uk.org.ury.frontend.cpanels.show + + + + +
+Classes  + +
+LibraryControlPanel
+ + + + diff --git a/doc/uk/org/ury/frontend/cpanels/show/package-summary.html b/doc/uk/org/ury/frontend/cpanels/show/package-summary.html new file mode 100644 index 0000000..13adf2c --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/show/package-summary.html @@ -0,0 +1,157 @@ + + + + + + +uk.org.ury.frontend.cpanels.show + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.frontend.cpanels.show +

+ + + + + + + + + +
+Class Summary
LibraryControlPanelControl panel for the demo system.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/cpanels/show/package-tree.html b/doc/uk/org/ury/frontend/cpanels/show/package-tree.html new file mode 100644 index 0000000..9711ad6 --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/show/package-tree.html @@ -0,0 +1,168 @@ + + + + + + +uk.org.ury.frontend.cpanels.show Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package uk.org.ury.frontend.cpanels.show +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/cpanels/show/package-use.html b/doc/uk/org/ury/frontend/cpanels/show/package-use.html new file mode 100644 index 0000000..0f6e323 --- /dev/null +++ b/doc/uk/org/ury/frontend/cpanels/show/package-use.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Package uk.org.ury.frontend.cpanels.show + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
uk.org.ury.frontend.cpanels.show

+
+No usage of uk.org.ury.frontend.cpanels.show +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html b/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html index c3cc03c..ccd35ce 100644 --- a/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html @@ -2,7 +2,7 @@ - + LoadFailureException diff --git a/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html b/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html index b01b412..568928a 100644 --- a/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html @@ -2,7 +2,7 @@ - + UICreationFailureException diff --git a/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html b/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html index c80e812..90bbddb 100644 --- a/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html @@ -2,7 +2,7 @@ - + Uses of Class uk.org.ury.frontend.exceptions.LoadFailureException @@ -151,8 +151,8 @@ Uses of diff --git a/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html b/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html index ad9a179..a2efd61 100644 --- a/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html @@ -2,7 +2,7 @@ - + Uses of Class uk.org.ury.frontend.exceptions.UICreationFailureException @@ -94,15 +94,19 @@ Packages that use -uk.org.ury.library.viewer +uk.org.ury.frontend.cpanels.menu    -uk.org.ury.show.viewer +uk.org.ury.frontend.cpanels.show    -uk.org.ury.testrig +uk.org.ury.frontend.modules.library +   + + +uk.org.ury.frontend.modules.show    @@ -147,11 +151,11 @@ Uses of + +Uses of UICreationFailureException in uk.org.ury.frontend.cpanels.menu
-Uses of UICreationFailureException in uk.org.ury.library.viewer
  @@ -159,23 +163,22 @@ Uses of -Constructors in uk.org.ury.library.viewer that throw UICreationFailureException +Constructors in uk.org.ury.frontend.cpanels.menu that throw UICreationFailureException -LibraryViewerPanel(LibraryViewer viewer, - FrontendMaster master) +DemoControlPanel()
-          Construct a new LibraryViewerPanel. +          Constructs a new DemoControlPanel.  

- + +Uses of UICreationFailureException in uk.org.ury.frontend.cpanels.show
-Uses of UICreationFailureException in uk.org.ury.show.viewer
  @@ -183,42 +186,46 @@ Uses of -Constructors in uk.org.ury.show.viewer that throw UICreationFailureException - - -ChannelPanel(int number, - ShowChannel channel) - -
-          Construct a new ChannelPanel. +Constructors in uk.org.ury.frontend.cpanels.show that throw UICreationFailureException -LibraryControlPanel() +LibraryControlPanel()
          Construct a new LibraryControlPanel. - -ShowViewerPanel(ShowViewer viewer, - FrontendMaster master) + +  +

+ + + + + +
+Uses of UICreationFailureException in uk.org.ury.frontend.modules.library
+  +

-
-          Construct a new ShowViewerPanel. + + + - +          Construct a new LibraryViewerPanel.
Constructors in uk.org.ury.frontend.modules.library that throw UICreationFailureException
TrackBin(java.lang.String name) +LibraryViewerPanel(LibraryViewer viewer, + FrontendMaster master)
-          Construct a new TrackBin.
 

- + +Uses of UICreationFailureException in uk.org.ury.frontend.modules.show
-Uses of UICreationFailureException in uk.org.ury.testrig
  @@ -226,13 +233,27 @@ Uses of -Constructors in uk.org.ury.testrig that throw UICreationFailureException +Constructors in uk.org.ury.frontend.modules.show that throw UICreationFailureException -DemoControlPanel() +ChannelPanel(int number, + ShowChannel channel)
-          Constructs a new DemoControlPanel. +          Construct a new ChannelPanel. + + +ShowViewerPanel(ShowViewer viewer, + FrontendMaster master) + +
+          Construct a new ShowViewerPanel. + + +TrackBin(java.lang.String name) + +
+          Construct a new TrackBin.   diff --git a/doc/uk/org/ury/frontend/exceptions/package-frame.html b/doc/uk/org/ury/frontend/exceptions/package-frame.html index 36fa46e..5477eac 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-frame.html +++ b/doc/uk/org/ury/frontend/exceptions/package-frame.html @@ -2,7 +2,7 @@ - + uk.org.ury.frontend.exceptions diff --git a/doc/uk/org/ury/frontend/exceptions/package-summary.html b/doc/uk/org/ury/frontend/exceptions/package-summary.html index 55af0ac..00c4161 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-summary.html +++ b/doc/uk/org/ury/frontend/exceptions/package-summary.html @@ -2,7 +2,7 @@ - + uk.org.ury.frontend.exceptions @@ -55,8 +55,8 @@ function windowTitle() - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE FRAMES    NO FRAMES   @@ -132,8 +132,8 @@ Package uk.org.ury.frontend.exceptions - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/frontend/exceptions/package-tree.html b/doc/uk/org/ury/frontend/exceptions/package-tree.html index 7018784..4500af3 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-tree.html +++ b/doc/uk/org/ury/frontend/exceptions/package-tree.html @@ -2,7 +2,7 @@ - + uk.org.ury.frontend.exceptions Class Hierarchy @@ -55,8 +55,8 @@ function windowTitle() - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   @@ -129,8 +129,8 @@ Class Hierarchy - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/frontend/exceptions/package-use.html b/doc/uk/org/ury/frontend/exceptions/package-use.html index 9680c18..0c68c34 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-use.html +++ b/doc/uk/org/ury/frontend/exceptions/package-use.html @@ -2,7 +2,7 @@ - + Uses of Package uk.org.ury.frontend.exceptions @@ -94,15 +94,19 @@ Packages that use -uk.org.ury.library.viewer +uk.org.ury.frontend.cpanels.menu    -uk.org.ury.show.viewer +uk.org.ury.frontend.cpanels.show    -uk.org.ury.testrig +uk.org.ury.frontend.modules.library +   + + +uk.org.ury.frontend.modules.show    @@ -129,14 +133,29 @@ Classes in + + + + + + + + +
+Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.frontend.cpanels.menu
UICreationFailureException + +
+          Exception thrown when the creation of a UI element fails.
+  +

+ +Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.frontend.cpanels.show - @@ -144,14 +163,14 @@ Classes in +
-Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.library.viewer
UICreationFailureException +UICreationFailureException
          Exception thrown when the creation of a UI element fails.
+Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.frontend.modules.library - @@ -159,14 +178,14 @@ Classes in +
-Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.show.viewer
UICreationFailureException +UICreationFailureException
          Exception thrown when the creation of a UI element fails.
+Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.frontend.modules.show - diff --git a/doc/uk/org/ury/frontend/modules/library/LibraryTableModel.html b/doc/uk/org/ury/frontend/modules/library/LibraryTableModel.html new file mode 100644 index 0000000..3fd28a7 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/LibraryTableModel.html @@ -0,0 +1,362 @@ + + + + + + +LibraryTableModel + + + + + + + + + + + + +
+ + + + + +
-Classes in uk.org.ury.frontend.exceptions used by uk.org.ury.testrig
UICreationFailureException +UICreationFailureException
          Exception thrown when the creation of a UI element fails.
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +

+ +

+ +uk.org.ury.frontend.modules.library +
+Class LibraryTableModel

+
+java.lang.Object
+  extended by javax.swing.table.AbstractTableModel
+      extended by uk.org.ury.frontend.modules.library.LibraryTableModel
+
+
+
All Implemented Interfaces:
java.io.Serializable, javax.swing.table.TableModel
+
+
+
+
public class LibraryTableModel
extends javax.swing.table.AbstractTableModel
+ + +

+A table model for the library viewer. +

+ +

+

+
Author:
+
Matt Windsor
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
LibraryTableModel(java.util.List<LibraryItem> data) + +
+          Construct a new table model.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.Class<?>getColumnClass(int c) + +
+           
+ intgetColumnCount() + +
+           
+ java.lang.StringgetColumnName(int index) + +
+           
+ intgetRowCount() + +
+           
+ java.lang.ObjectgetValueAt(int rowIndex, + int columnIndex) + +
+           
+  + + + + + + + +
Methods inherited from class javax.swing.table.AbstractTableModel
addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getListeners, getTableModelListeners, isCellEditable, removeTableModelListener, setValueAt
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LibraryTableModel

+
+public LibraryTableModel(java.util.List<LibraryItem> data)
+
+
Construct a new table model. +

+

+
Parameters:
data - The list of data on which the model will be based.
+
+ + + + + + + + +
+Method Detail
+ +

+getColumnCount

+
+public int getColumnCount()
+
+
+
+
+
+
+ +

+getRowCount

+
+public int getRowCount()
+
+
+
+
+
+
+ +

+getColumnClass

+
+public java.lang.Class<?> getColumnClass(int c)
+
+
+
Specified by:
getColumnClass in interface javax.swing.table.TableModel
Overrides:
getColumnClass in class javax.swing.table.AbstractTableModel
+
+
+
Parameters:
c - The column whose class should be investigated. +
Returns:
the column class of column c.
+
+
+
+ +

+getValueAt

+
+public java.lang.Object getValueAt(int rowIndex,
+                                   int columnIndex)
+
+
+
+
+
+
+ +

+getColumnName

+
+public java.lang.String getColumnName(int index)
+
+
+
Specified by:
getColumnName in interface javax.swing.table.TableModel
Overrides:
getColumnName in class javax.swing.table.AbstractTableModel
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/library/LibraryViewer.html b/doc/uk/org/ury/frontend/modules/library/LibraryViewer.html new file mode 100644 index 0000000..d597bcd --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/LibraryViewer.html @@ -0,0 +1,327 @@ + + + + + + +LibraryViewer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend.modules.library +
+Class LibraryViewer

+
+java.lang.Object
+  extended by uk.org.ury.frontend.AbstractFrontendModule
+      extended by uk.org.ury.frontend.modules.library.LibraryViewer
+
+
+
All Implemented Interfaces:
FrontendModule
+
+
+
+
public class LibraryViewer
extends AbstractFrontendModule
+ + +

+Module for investigating the track library. + + The LibraryViewer and its corresponding user + interface, LibraryViewerPanel, provide a + user interface for querying the server's library services + for track information. + + Subclasses of this module provide editing features for + the track library. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
LibraryViewer() + +
+          Constructs a new LibraryViewer as a frontend object.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddoSearch(java.lang.String search) + +
+          Does a library search.
+ java.util.List<LibraryItem>getLibraryList() + +
+           
+ FrontendModulePanelrunFrontend(FrontendMaster master) + +
+          Runs the library viewer frontend.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LibraryViewer

+
+public LibraryViewer()
+
+
Constructs a new LibraryViewer as a frontend object. +

+

+ + + + + + + + +
+Method Detail
+ +

+runFrontend

+
+public FrontendModulePanel runFrontend(FrontendMaster master)
+
+
Runs the library viewer frontend. +

+

+
Parameters:
master - The FrontendMaster driving the frontend. +
Returns:
the frontend panel to insert into the FrontendMaster.
+
+
+
+ +

+doSearch

+
+public void doSearch(java.lang.String search)
+              throws EmptySearchException,
+                     InvalidMessageException
+
+
Does a library search. + + This will update the library list to reflect the results of the search. +

+

+
Parameters:
search - The string fragment to use in searches. Cannot be empty or + null. +
Throws: +
EmptySearchException - if the search string is empty or null (from + LibraryUtils.search). +
InvalidMessageException - if the response from the server is invalid.
+
+
+
+ +

+getLibraryList

+
+public java.util.List<LibraryItem> getLibraryList()
+
+
+ +
Returns:
the current library list.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/library/LibraryViewerPanel.html b/doc/uk/org/ury/frontend/modules/library/LibraryViewerPanel.html new file mode 100644 index 0000000..8311c59 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/LibraryViewerPanel.html @@ -0,0 +1,424 @@ + + + + + + +LibraryViewerPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend.modules.library +
+Class LibraryViewerPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.FrontendModulePanel
+                          extended by uk.org.ury.frontend.modules.library.LibraryViewerPanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
+
public class LibraryViewerPanel
extends FrontendModulePanel
+ + +

+Frontend panel providing access to an underlying library viewer. +

+ +

+

+
Author:
+
Matt Windsor, Nathan Lasseter
+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
LibraryViewerPanel(LibraryViewer viewer, + FrontendMaster master) + +
+          Construct a new LibraryViewerPanel.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.StringgetModuleName() + +
+           
+ voidsearch() + +
+          Action method for performing a search, bound by the UI XML manifest to + the search field and button.
+  + + + + + + + +
Methods inherited from class uk.org.ury.frontend.FrontendModulePanel
getModule
+  + + + + + + + +
Methods inherited from class uk.org.ury.frontend.FrontendPanel
setMaster
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+LibraryViewerPanel

+
+public LibraryViewerPanel(LibraryViewer viewer,
+                          FrontendMaster master)
+                   throws UICreationFailureException
+
+
Construct a new LibraryViewerPanel. +

+

+
Parameters:
viewer - The LibraryViewer controlling this LibraryViewerPanel.
master - The FrontendMaster driving the frontend. +
Throws: +
UICreationFailureException - if the UI creation fails.
+
+ + + + + + + + +
+Method Detail
+ +

+getModuleName

+
+public java.lang.String getModuleName()
+
+
+
Specified by:
getModuleName in class FrontendModulePanel
+
+
+ +
Returns:
the name of the panel.
See Also:
FrontendModulePanel.getModuleName()
+
+
+
+ +

+search

+
+public void search()
+
+
Action method for performing a search, bound by the UI XML manifest to + the search field and button. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/library/class-use/LibraryTableModel.html b/doc/uk/org/ury/frontend/modules/library/class-use/LibraryTableModel.html new file mode 100644 index 0000000..7a9024f --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/class-use/LibraryTableModel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.modules.library.LibraryTableModel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.frontend.modules.library.LibraryTableModel

+
+No usage of uk.org.ury.frontend.modules.library.LibraryTableModel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/library/class-use/LibraryViewer.html b/doc/uk/org/ury/frontend/modules/library/class-use/LibraryViewer.html new file mode 100644 index 0000000..ceb0b60 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/class-use/LibraryViewer.html @@ -0,0 +1,179 @@ + + + + + + +Uses of Class uk.org.ury.frontend.modules.library.LibraryViewer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.frontend.modules.library.LibraryViewer

+
+ + + + + + + + + +
+Packages that use LibraryViewer
uk.org.ury.frontend.modules.library  
+  +

+ + + + + +
+Uses of LibraryViewer in uk.org.ury.frontend.modules.library
+  +

+ + + + + + + + +
Constructors in uk.org.ury.frontend.modules.library with parameters of type LibraryViewer
LibraryViewerPanel(LibraryViewer viewer, + FrontendMaster master) + +
+          Construct a new LibraryViewerPanel.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/library/class-use/LibraryViewerPanel.html b/doc/uk/org/ury/frontend/modules/library/class-use/LibraryViewerPanel.html new file mode 100644 index 0000000..57155be --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/class-use/LibraryViewerPanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.modules.library.LibraryViewerPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.frontend.modules.library.LibraryViewerPanel

+
+No usage of uk.org.ury.frontend.modules.library.LibraryViewerPanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/library/package-frame.html b/doc/uk/org/ury/frontend/modules/library/package-frame.html new file mode 100644 index 0000000..b60a755 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +uk.org.ury.frontend.modules.library + + + + + + + + + + + +uk.org.ury.frontend.modules.library + + + + +
+Classes  + +
+LibraryTableModel +
+LibraryViewer +
+LibraryViewerPanel
+ + + + diff --git a/doc/uk/org/ury/frontend/modules/library/package-summary.html b/doc/uk/org/ury/frontend/modules/library/package-summary.html new file mode 100644 index 0000000..ea5857c --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/package-summary.html @@ -0,0 +1,165 @@ + + + + + + +uk.org.ury.frontend.modules.library + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.frontend.modules.library +

+ + + + + + + + + + + + + + + + + +
+Class Summary
LibraryTableModelA table model for the library viewer.
LibraryViewerModule for investigating the track library.
LibraryViewerPanelFrontend panel providing access to an underlying library viewer.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/library/package-tree.html b/doc/uk/org/ury/frontend/modules/library/package-tree.html new file mode 100644 index 0000000..1bc2243 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/package-tree.html @@ -0,0 +1,174 @@ + + + + + + +uk.org.ury.frontend.modules.library Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package uk.org.ury.frontend.modules.library +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+
    +
  • java.lang.Object
      +
    • uk.org.ury.frontend.AbstractFrontendModule (implements uk.org.ury.frontend.FrontendModule) + +
    • javax.swing.table.AbstractTableModel (implements java.io.Serializable, javax.swing.table.TableModel) + +
    • java.awt.Component (implements java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable) +
        +
      • java.awt.Container
          +
        • javax.swing.JComponent (implements java.io.Serializable) + +
        +
      +
    +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/library/package-use.html b/doc/uk/org/ury/frontend/modules/library/package-use.html new file mode 100644 index 0000000..4c8eb56 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/library/package-use.html @@ -0,0 +1,170 @@ + + + + + + +Uses of Package uk.org.ury.frontend.modules.library + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
uk.org.ury.frontend.modules.library

+
+ + + + + + + + + +
+Packages that use uk.org.ury.frontend.modules.library
uk.org.ury.frontend.modules.library  
+  +

+ + + + + + + + +
+Classes in uk.org.ury.frontend.modules.library used by uk.org.ury.frontend.modules.library
LibraryViewer + +
+          Module for investigating the track library.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/menu/DemoMenu.html b/doc/uk/org/ury/frontend/modules/menu/DemoMenu.html new file mode 100644 index 0000000..c277d60 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/DemoMenu.html @@ -0,0 +1,307 @@ + + + + + + +DemoMenu + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend.modules.menu +
+Class DemoMenu

+
+java.lang.Object
+  extended by uk.org.ury.frontend.AbstractFrontendModule
+      extended by uk.org.ury.frontend.modules.menu.DemoMenu
+
+
+
All Implemented Interfaces:
FrontendModule
+
+
+
+
public class DemoMenu
extends AbstractFrontendModule
+ + +

+Application frontend, for testing early-stage frontend code. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
DemoMenu() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidloadModule(java.lang.String module) + +
+           
+ voidrun() + +
+          Run the demo menu, creating a user interface.
+ FrontendModulePanelrunFrontend(FrontendMaster master) + +
+          Run the demo menu in frontend mode.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DemoMenu

+
+public DemoMenu()
+
+
+ + + + + + + + +
+Method Detail
+ +

+loadModule

+
+public void loadModule(java.lang.String module)
+
+
+
+
+
+
+ +

+run

+
+public void run()
+
+
Run the demo menu, creating a user interface. +

+

+
+
+
+
+ +

+runFrontend

+
+public FrontendModulePanel runFrontend(FrontendMaster master)
+
+
Run the demo menu in frontend mode. +

+

+
Parameters:
master - The FrontendMaster driving the frontend. +
Returns:
the frontend panel to insert into the FrontendMaster.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/menu/DemoMenuPanel.html b/doc/uk/org/ury/frontend/modules/menu/DemoMenuPanel.html new file mode 100644 index 0000000..5833e8d --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/DemoMenuPanel.html @@ -0,0 +1,390 @@ + + + + + + +DemoMenuPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend.modules.menu +
+Class DemoMenuPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.FrontendModulePanel
+                          extended by uk.org.ury.frontend.modules.menu.DemoMenuPanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
+
public class DemoMenuPanel
extends FrontendModulePanel
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
DemoMenuPanel(FrontendMaster inMaster) + +
+          Construct a new DemoMenuPanel.
+  + + + + + + + + + + + +
+Method Summary
+ java.lang.StringgetModuleName() + +
+           
+  + + + + + + + +
Methods inherited from class uk.org.ury.frontend.FrontendModulePanel
getModule
+  + + + + + + + +
Methods inherited from class uk.org.ury.frontend.FrontendPanel
setMaster
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DemoMenuPanel

+
+public DemoMenuPanel(FrontendMaster inMaster)
+
+
Construct a new DemoMenuPanel. +

+

+
Parameters:
inMaster - The new frontend master of the panel, if any.
+
+ + + + + + + + +
+Method Detail
+ +

+getModuleName

+
+public java.lang.String getModuleName()
+
+
+
Specified by:
getModuleName in class FrontendModulePanel
+
+
+ +
Returns:
the name of the module.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/menu/class-use/DemoMenu.html b/doc/uk/org/ury/frontend/modules/menu/class-use/DemoMenu.html new file mode 100644 index 0000000..1b9abcb --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/class-use/DemoMenu.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.modules.menu.DemoMenu + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.frontend.modules.menu.DemoMenu

+
+No usage of uk.org.ury.frontend.modules.menu.DemoMenu +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/menu/class-use/DemoMenuPanel.html b/doc/uk/org/ury/frontend/modules/menu/class-use/DemoMenuPanel.html new file mode 100644 index 0000000..c427e9a --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/class-use/DemoMenuPanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.modules.menu.DemoMenuPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.frontend.modules.menu.DemoMenuPanel

+
+No usage of uk.org.ury.frontend.modules.menu.DemoMenuPanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/menu/package-frame.html b/doc/uk/org/ury/frontend/modules/menu/package-frame.html new file mode 100644 index 0000000..a8b1492 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +uk.org.ury.frontend.modules.menu + + + + + + + + + + + +uk.org.ury.frontend.modules.menu + + + + +
+Classes  + +
+DemoMenu +
+DemoMenuPanel
+ + + + diff --git a/doc/uk/org/ury/frontend/modules/menu/package-summary.html b/doc/uk/org/ury/frontend/modules/menu/package-summary.html new file mode 100644 index 0000000..706fd25 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/package-summary.html @@ -0,0 +1,161 @@ + + + + + + +uk.org.ury.frontend.modules.menu + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.frontend.modules.menu +

+ + + + + + + + + + + + + +
+Class Summary
DemoMenuApplication frontend, for testing early-stage frontend code.
DemoMenuPanel 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/menu/package-tree.html b/doc/uk/org/ury/frontend/modules/menu/package-tree.html new file mode 100644 index 0000000..c668386 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/package-tree.html @@ -0,0 +1,171 @@ + + + + + + +uk.org.ury.frontend.modules.menu Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package uk.org.ury.frontend.modules.menu +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+
    +
  • java.lang.Object
      +
    • uk.org.ury.frontend.AbstractFrontendModule (implements uk.org.ury.frontend.FrontendModule) +
        +
      • uk.org.ury.frontend.modules.menu.DemoMenu
      +
    • java.awt.Component (implements java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable) +
        +
      • java.awt.Container
          +
        • javax.swing.JComponent (implements java.io.Serializable) + +
        +
      +
    +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/menu/package-use.html b/doc/uk/org/ury/frontend/modules/menu/package-use.html new file mode 100644 index 0000000..d172ab8 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/menu/package-use.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Package uk.org.ury.frontend.modules.menu + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
uk.org.ury.frontend.modules.menu

+
+No usage of uk.org.ury.frontend.modules.menu +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/show/ChannelPanel.html b/doc/uk/org/ury/frontend/modules/show/ChannelPanel.html new file mode 100644 index 0000000..6b44c78 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/ChannelPanel.html @@ -0,0 +1,363 @@ + + + + + + +ChannelPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend.modules.show +
+Class ChannelPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.modules.show.ChannelPanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
+
public class ChannelPanel
extends FrontendPanel
+ + +

+A panel displaying channel information. +

+ +

+

+
Author:
+
Matt Windsor.
+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
ChannelPanel(int number, + ShowChannel channel) + +
+          Construct a new ChannelPanel.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class uk.org.ury.frontend.FrontendPanel
setMaster
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ChannelPanel

+
+public ChannelPanel(int number,
+                    ShowChannel channel)
+             throws UICreationFailureException
+
+
Construct a new ChannelPanel. + + This constructor reads the channel panel layout from the + XML manifest "channel_panel.xml" in the same directory as + this class file. +

+

+
Parameters:
number - The number of the channel.
channel - The channel whose data the ChannelPanel is viewing. +
Throws: +
UICreationFailureException - if the UI creation fails.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/show/ShowViewer.html b/doc/uk/org/ury/frontend/modules/show/ShowViewer.html new file mode 100644 index 0000000..9f9e174 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/ShowViewer.html @@ -0,0 +1,315 @@ + + + + + + +ShowViewer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend.modules.show +
+Class ShowViewer

+
+java.lang.Object
+  extended by uk.org.ury.frontend.AbstractFrontendModule
+      extended by uk.org.ury.frontend.modules.show.ShowViewer
+
+
+
All Implemented Interfaces:
FrontendModule
+
+
+
+
public class ShowViewer
extends AbstractFrontendModule
+ + +

+Frontend module for viewing show details. + + This serves as the base for the show playout and editor classes, but can be + used stand-alone as an (admittedly rather pointless) module. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
ShowViewer() + +
+          Construct a new ShowViewer as a frontend object.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.util.List<java.lang.String>getBins() + +
+           
+ ShowChannel[]getChannels() + +
+           
+ FrontendModulePanelrunFrontend(FrontendMaster master) + +
+          Run the library viewer frontend.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ShowViewer

+
+public ShowViewer()
+
+
Construct a new ShowViewer as a frontend object. +

+

+ + + + + + + + +
+Method Detail
+ +

+runFrontend

+
+public FrontendModulePanel runFrontend(FrontendMaster master)
+
+
Run the library viewer frontend. +

+

+
Parameters:
master - The FrontendMaster driving the frontend. +
Returns:
the frontend panel to insert into the FrontendMaster.
+
+
+
+ +

+getChannels

+
+public ShowChannel[] getChannels()
+
+
+ +
Returns:
the channel array.
+
+
+
+ +

+getBins

+
+public java.util.List<java.lang.String> getBins()
+                                         throws QueryFailureException
+
+
+ +
Returns:
the list of bin names. +
Throws: +
QueryFailureException - if the underlying database query fails.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/show/ShowViewerPanel.html b/doc/uk/org/ury/frontend/modules/show/ShowViewerPanel.html new file mode 100644 index 0000000..8f049d0 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/ShowViewerPanel.html @@ -0,0 +1,431 @@ + + + + + + +ShowViewerPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend.modules.show +
+Class ShowViewerPanel

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.FrontendModulePanel
+                          extended by uk.org.ury.frontend.modules.show.ShowViewerPanel
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
+
public class ShowViewerPanel
extends FrontendModulePanel
+ + +

+Frontend panel providing access to an underlying show viewer. + + The various show user interfaces (show editor, playout etc.) + are derived from this. +

+ +

+

+
Author:
+
Matt Windsor, Nathan Lasseter
+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
ShowViewerPanel(ShowViewer viewer, + FrontendMaster master) + +
+          Construct a new ShowViewerPanel.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.StringgetModuleName() + +
+           
+ voidsearch() + +
+          Initialise the library viewer for the purposes of adding tracks + and/or browsing the library.
+  + + + + + + + +
Methods inherited from class uk.org.ury.frontend.FrontendModulePanel
getModule
+  + + + + + + + +
Methods inherited from class uk.org.ury.frontend.FrontendPanel
setMaster
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ShowViewerPanel

+
+public ShowViewerPanel(ShowViewer viewer,
+                       FrontendMaster master)
+                throws UICreationFailureException
+
+
Construct a new ShowViewerPanel. + + The panel will interface with the given show viewer and is + expected to be placed as a sub-component in the given + FrontendMaster. +

+

+
Parameters:
viewer - The ShowViewer controlling this LibraryViewerPanel.
master - The FrontendMaster driving the frontend. +
Throws: +
UICreationFailureException - if the UI creation fails.
+
+ + + + + + + + +
+Method Detail
+ +

+getModuleName

+
+public java.lang.String getModuleName()
+
+
+
Specified by:
getModuleName in class FrontendModulePanel
+
+
+ +
Returns:
the name of the panel.
See Also:
FrontendModulePanel.getModuleName()
+
+
+
+ +

+search

+
+public void search()
+
+
Initialise the library viewer for the purposes of adding tracks + and/or browsing the library. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/show/TrackBin.html b/doc/uk/org/ury/frontend/modules/show/TrackBin.html new file mode 100644 index 0000000..e92ba8f --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/TrackBin.html @@ -0,0 +1,363 @@ + + + + + + +TrackBin + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.frontend.modules.show +
+Class TrackBin

+
+java.lang.Object
+  extended by java.awt.Component
+      extended by java.awt.Container
+          extended by javax.swing.JComponent
+              extended by javax.swing.JPanel
+                  extended by uk.org.ury.frontend.FrontendPanel
+                      extended by uk.org.ury.frontend.modules.show.TrackBin
+
+
+
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
+
+
+
+
public class TrackBin
extends FrontendPanel
+ + +

+A panel displaying track bin contents. +

+ +

+

+
Author:
+
Matt Windsor.
+
See Also:
Serialized Form
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
+  + + + + + + + + +
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
+  + + + + + + + +
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
+  + + + + + + + +
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
+  + + + + + + + + + + +
+Constructor Summary
TrackBin(java.lang.String name) + +
+          Construct a new TrackBin.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class uk.org.ury.frontend.FrontendPanel
setMaster
+  + + + + + + + +
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
+  + + + + + + + +
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
+  + + + + + + + +
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
+  + + + + + + + +
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TrackBin

+
+public TrackBin(java.lang.String name)
+         throws UICreationFailureException
+
+
Construct a new TrackBin. + + This constructor reads the channel panel layout from the + XML manifest "track_bin.xml" in the same directory as + this class file. + + TODO: add track list into constructor +

+

+
Parameters:
name - The name of the bin. +
Throws: +
UICreationFailureException - if the UI creation fails.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/show/class-use/ChannelPanel.html b/doc/uk/org/ury/frontend/modules/show/class-use/ChannelPanel.html new file mode 100644 index 0000000..347a935 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/class-use/ChannelPanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.modules.show.ChannelPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.frontend.modules.show.ChannelPanel

+
+No usage of uk.org.ury.frontend.modules.show.ChannelPanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/show/class-use/ShowViewer.html b/doc/uk/org/ury/frontend/modules/show/class-use/ShowViewer.html new file mode 100644 index 0000000..e0f5e8b --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/class-use/ShowViewer.html @@ -0,0 +1,179 @@ + + + + + + +Uses of Class uk.org.ury.frontend.modules.show.ShowViewer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.frontend.modules.show.ShowViewer

+
+ + + + + + + + + +
+Packages that use ShowViewer
uk.org.ury.frontend.modules.show  
+  +

+ + + + + +
+Uses of ShowViewer in uk.org.ury.frontend.modules.show
+  +

+ + + + + + + + +
Constructors in uk.org.ury.frontend.modules.show with parameters of type ShowViewer
ShowViewerPanel(ShowViewer viewer, + FrontendMaster master) + +
+          Construct a new ShowViewerPanel.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/show/class-use/ShowViewerPanel.html b/doc/uk/org/ury/frontend/modules/show/class-use/ShowViewerPanel.html new file mode 100644 index 0000000..565df7b --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/class-use/ShowViewerPanel.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.modules.show.ShowViewerPanel + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.frontend.modules.show.ShowViewerPanel

+
+No usage of uk.org.ury.frontend.modules.show.ShowViewerPanel +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/show/class-use/TrackBin.html b/doc/uk/org/ury/frontend/modules/show/class-use/TrackBin.html new file mode 100644 index 0000000..8cd76fd --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/class-use/TrackBin.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.modules.show.TrackBin + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.frontend.modules.show.TrackBin

+
+No usage of uk.org.ury.frontend.modules.show.TrackBin +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/show/package-frame.html b/doc/uk/org/ury/frontend/modules/show/package-frame.html new file mode 100644 index 0000000..1ffabea --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/package-frame.html @@ -0,0 +1,38 @@ + + + + + + +uk.org.ury.frontend.modules.show + + + + + + + + + + + +uk.org.ury.frontend.modules.show + + + + +
+Classes  + +
+ChannelPanel +
+ShowViewer +
+ShowViewerPanel +
+TrackBin
+ + + + diff --git a/doc/uk/org/ury/frontend/modules/show/package-summary.html b/doc/uk/org/ury/frontend/modules/show/package-summary.html new file mode 100644 index 0000000..a7e77b4 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/package-summary.html @@ -0,0 +1,169 @@ + + + + + + +uk.org.ury.frontend.modules.show + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.frontend.modules.show +

+ + + + + + + + + + + + + + + + + + + + + +
+Class Summary
ChannelPanelA panel displaying channel information.
ShowViewerFrontend module for viewing show details.
ShowViewerPanelFrontend panel providing access to an underlying show viewer.
TrackBinA panel displaying track bin contents.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/show/package-tree.html b/doc/uk/org/ury/frontend/modules/show/package-tree.html new file mode 100644 index 0000000..c4b0168 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/package-tree.html @@ -0,0 +1,171 @@ + + + + + + +uk.org.ury.frontend.modules.show Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package uk.org.ury.frontend.modules.show +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+
    +
  • java.lang.Object
      +
    • uk.org.ury.frontend.AbstractFrontendModule (implements uk.org.ury.frontend.FrontendModule) + +
    • java.awt.Component (implements java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable) +
        +
      • java.awt.Container
          +
        • javax.swing.JComponent (implements java.io.Serializable) + +
        +
      +
    +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/modules/show/package-use.html b/doc/uk/org/ury/frontend/modules/show/package-use.html new file mode 100644 index 0000000..a697637 --- /dev/null +++ b/doc/uk/org/ury/frontend/modules/show/package-use.html @@ -0,0 +1,170 @@ + + + + + + +Uses of Package uk.org.ury.frontend.modules.show + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
uk.org.ury.frontend.modules.show

+
+ + + + + + + + + +
+Packages that use uk.org.ury.frontend.modules.show
uk.org.ury.frontend.modules.show  
+  +

+ + + + + + + + +
+Classes in uk.org.ury.frontend.modules.show used by uk.org.ury.frontend.modules.show
ShowViewer + +
+          Frontend module for viewing show details.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/frontend/package-frame.html b/doc/uk/org/ury/frontend/package-frame.html index fe3138d..a7e56bb 100644 --- a/doc/uk/org/ury/frontend/package-frame.html +++ b/doc/uk/org/ury/frontend/package-frame.html @@ -2,7 +2,7 @@ - + uk.org.ury.frontend diff --git a/doc/uk/org/ury/frontend/package-summary.html b/doc/uk/org/ury/frontend/package-summary.html index 1428153..c55a261 100644 --- a/doc/uk/org/ury/frontend/package-summary.html +++ b/doc/uk/org/ury/frontend/package-summary.html @@ -2,7 +2,7 @@ - + uk.org.ury.frontend @@ -55,8 +55,8 @@ function windowTitle() - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE FRAMES    NO FRAMES   @@ -95,8 +95,8 @@ Package uk.org.ury.frontend FrontendModule -Interface for all system modules that are to be reachable from - the frontend array. +Interface for all system modules that are to be reachable from the frontend + array.   @@ -132,8 +132,8 @@ Package uk.org.ury.frontend FrontendFrame -A frame that hosts a FrontendModulePanel, used for serving frontend - panels in a window (application mode). +A frame that hosts a FrontendModulePanel, used for serving frontend panels in + a window (application mode). FrontendModulePanel @@ -190,8 +190,8 @@ Package uk.org.ury.frontend - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/frontend/package-tree.html b/doc/uk/org/ury/frontend/package-tree.html index bf3fd81..6f89e47 100644 --- a/doc/uk/org/ury/frontend/package-tree.html +++ b/doc/uk/org/ury/frontend/package-tree.html @@ -2,7 +2,7 @@ - + uk.org.ury.frontend Class Hierarchy @@ -55,8 +55,8 @@ function windowTitle() - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   @@ -117,7 +117,7 @@ Class Hierarchy
  • java.applet.Applet @@ -170,8 +170,8 @@ Interface Hierarchy - PREV  - NEXT + PREV  + NEXT FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/frontend/package-use.html b/doc/uk/org/ury/frontend/package-use.html index b2251ef..ca799a0 100644 --- a/doc/uk/org/ury/frontend/package-use.html +++ b/doc/uk/org/ury/frontend/package-use.html @@ -2,7 +2,7 @@ - + Uses of Package uk.org.ury.frontend @@ -94,15 +94,23 @@ Packages that use    -uk.org.ury.library.viewer +uk.org.ury.frontend.cpanels.menu    -uk.org.ury.show.viewer +uk.org.ury.frontend.cpanels.show    -uk.org.ury.testrig +uk.org.ury.frontend.modules.library +   + + +uk.org.ury.frontend.modules.menu +   + + +uk.org.ury.frontend.modules.show    @@ -131,8 +139,8 @@ Classes in uk.org FrontendFrame
    -          A frame that hosts a FrontendModulePanel, used for serving frontend - panels in a window (application mode). +          A frame that hosts a FrontendModulePanel, used for serving frontend panels in + a window (application mode). FrontendMaster @@ -145,8 +153,8 @@ Classes in uk.org FrontendModule
    -          Interface for all system modules that are to be reachable from - the frontend array. +          Interface for all system modules that are to be reachable from the frontend + array. FrontendModulePanel @@ -164,40 +172,84 @@ Classes in uk.org  

    - + + + + + + + + + + + +
    +Classes in uk.org.ury.frontend used by uk.org.ury.frontend.cpanels.menu
    FrontendControlPanel + +
    +          Abstract class for frontend module control panels.
    FrontendPanel + +
    +          An extension of JPanel providing common functionality for user + interface panels in the URY system frontend.
    +  +

    + + + + + + + + + + + +
    +Classes in uk.org.ury.frontend used by uk.org.ury.frontend.cpanels.show
    FrontendControlPanel + +
    +          Abstract class for frontend module control panels.
    FrontendPanel + +
    +          An extension of JPanel providing common functionality for user + interface panels in the URY system frontend.
    +  +

    + +Classes in uk.org.ury.frontend used by uk.org.ury.frontend.modules.library - - - +          Interface for all system modules that are to be reachable from the frontend + array. - -
    -Classes in uk.org.ury.frontend used by uk.org.ury.library.viewer
    AbstractFrontendModule +AbstractFrontendModule
              An abstract implementation of the FrontendModule interface.
    FrontendMaster +FrontendMaster
              Interface for classes providing the parent unit of a frontend session.
    FrontendModule +FrontendModule
    -          Interface for all system modules that are to be reachable from - the frontend array.
    FrontendModulePanel +FrontendModulePanel
              A frontend user interface panel.
    FrontendPanel +FrontendPanel
              An extension of JPanel providing common functionality for user @@ -206,46 +258,40 @@ Classes in uk.org
     

    - + +Classes in uk.org.ury.frontend used by uk.org.ury.frontend.modules.menu - - - - - - +          Interface for all system modules that are to be reachable from the frontend + array. - -
    -Classes in uk.org.ury.frontend used by uk.org.ury.show.viewer
    AbstractFrontendModule +AbstractFrontendModule
              An abstract implementation of the FrontendModule interface.
    FrontendControlPanel - -
    -          Abstract class for frontend module control panels.
    FrontendMaster +FrontendMaster
              Interface for classes providing the parent unit of a frontend session.
    FrontendModule +FrontendModule
    -          Interface for all system modules that are to be reachable from - the frontend array.
    FrontendModulePanel +FrontendModulePanel
              A frontend user interface panel.
    FrontendPanel +FrontendPanel
              An extension of JPanel providing common functionality for user @@ -254,46 +300,40 @@ Classes in uk.org
     

    - + +Classes in uk.org.ury.frontend used by uk.org.ury.frontend.modules.show - - - - - - +          Interface for all system modules that are to be reachable from the frontend + array. - -
    -Classes in uk.org.ury.frontend used by uk.org.ury.testrig
    AbstractFrontendModule +AbstractFrontendModule
              An abstract implementation of the FrontendModule interface.
    FrontendControlPanel - -
    -          Abstract class for frontend module control panels.
    FrontendMaster +FrontendMaster
              Interface for classes providing the parent unit of a frontend session.
    FrontendModule +FrontendModule
    -          Interface for all system modules that are to be reachable from - the frontend array.
    FrontendModulePanel +FrontendModulePanel
              A frontend user interface panel.
    FrontendPanel +FrontendPanel
              An extension of JPanel providing common functionality for user diff --git a/doc/uk/org/ury/frontend/testrig/ApplicationLauncher.html b/doc/uk/org/ury/frontend/testrig/ApplicationLauncher.html new file mode 100644 index 0000000..049e8a8 --- /dev/null +++ b/doc/uk/org/ury/frontend/testrig/ApplicationLauncher.html @@ -0,0 +1,289 @@ + + + + + + +ApplicationLauncher + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +uk.org.ury.frontend.testrig +
    +Class ApplicationLauncher

    +
    +java.lang.Object
+  extended by uk.org.ury.frontend.testrig.ApplicationLauncher
+
    +
    +
    All Implemented Interfaces:
    Launcher
    +
    +
    +
    +
    public class ApplicationLauncher
    extends java.lang.Object
    implements Launcher
    + + +

    +An application-based entry point into the frontend. + + If provided with no arguments, this will launch the main menu. +

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from interface uk.org.ury.frontend.testrig.Launcher
    DEFAULT_MODULE_NAME
    +  + + + + + + + + + + +
    +Constructor Summary
    ApplicationLauncher() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    +static voidmain(java.lang.String[] args) + +
    +          Main method.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ApplicationLauncher

    +
    +public ApplicationLauncher()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +main

    +
    +public static void main(java.lang.String[] args)
    +
    +
    Main method. +

    +

    +
    +
    +
    +
    Parameters:
    args - The command-line arguments to the program. These will + currently be ignored.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/testrig/Launcher.html b/doc/uk/org/ury/frontend/testrig/Launcher.html new file mode 100644 index 0000000..64dbf34 --- /dev/null +++ b/doc/uk/org/ury/frontend/testrig/Launcher.html @@ -0,0 +1,215 @@ + + + + + + +Launcher + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +uk.org.ury.frontend.testrig +
    +Interface Launcher

    +
    +
    All Known Implementing Classes:
    ApplicationLauncher, FrontendApplet
    +
    +
    +
    +
    public interface Launcher
    + + +

    +Interface for entry points into the frontend. +

    + +

    +

    +
    Author:
    +
    Matt Windsor
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringDEFAULT_MODULE_NAME + +
    +           
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +DEFAULT_MODULE_NAME

    +
    +static final java.lang.String DEFAULT_MODULE_NAME
    +
    +
    +
    See Also:
    Constant Field Values
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/testrig/class-use/ApplicationLauncher.html b/doc/uk/org/ury/frontend/testrig/class-use/ApplicationLauncher.html new file mode 100644 index 0000000..af4b74a --- /dev/null +++ b/doc/uk/org/ury/frontend/testrig/class-use/ApplicationLauncher.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.frontend.testrig.ApplicationLauncher + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    uk.org.ury.frontend.testrig.ApplicationLauncher

    +
    +No usage of uk.org.ury.frontend.testrig.ApplicationLauncher +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/testrig/class-use/Launcher.html b/doc/uk/org/ury/frontend/testrig/class-use/Launcher.html new file mode 100644 index 0000000..5c04771 --- /dev/null +++ b/doc/uk/org/ury/frontend/testrig/class-use/Launcher.html @@ -0,0 +1,210 @@ + + + + + + +Uses of Interface uk.org.ury.frontend.testrig.Launcher + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Interface
    uk.org.ury.frontend.testrig.Launcher

    +
    + + + + + + + + + + + + + +
    +Packages that use Launcher
    uk.org.ury.frontend  
    uk.org.ury.frontend.testrig  
    +  +

    + + + + + +
    +Uses of Launcher in uk.org.ury.frontend
    +  +

    + + + + + + + + + +
    Classes in uk.org.ury.frontend that implement Launcher
    + classFrontendApplet + +
    +          A frame that hosts a FrontendModulePanel, used for serving frontend panels in + a window (application mode).
    +  +

    + + + + + +
    +Uses of Launcher in uk.org.ury.frontend.testrig
    +  +

    + + + + + + + + + +
    Classes in uk.org.ury.frontend.testrig that implement Launcher
    + classApplicationLauncher + +
    +          An application-based entry point into the frontend.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/testrig/package-frame.html b/doc/uk/org/ury/frontend/testrig/package-frame.html new file mode 100644 index 0000000..6b1fed0 --- /dev/null +++ b/doc/uk/org/ury/frontend/testrig/package-frame.html @@ -0,0 +1,43 @@ + + + + + + +uk.org.ury.frontend.testrig + + + + + + + + + + + +uk.org.ury.frontend.testrig + + + + +
    +Interfaces  + +
    +Launcher
    + + + + + + +
    +Classes  + +
    +ApplicationLauncher
    + + + + diff --git a/doc/uk/org/ury/frontend/testrig/package-summary.html b/doc/uk/org/ury/frontend/testrig/package-summary.html new file mode 100644 index 0000000..14b8058 --- /dev/null +++ b/doc/uk/org/ury/frontend/testrig/package-summary.html @@ -0,0 +1,171 @@ + + + + + + +uk.org.ury.frontend.testrig + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package uk.org.ury.frontend.testrig +

    + + + + + + + + + +
    +Interface Summary
    LauncherInterface for entry points into the frontend.
    +  + +

    + + + + + + + + + +
    +Class Summary
    ApplicationLauncherAn application-based entry point into the frontend.
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/testrig/package-tree.html b/doc/uk/org/ury/frontend/testrig/package-tree.html new file mode 100644 index 0000000..d4af553 --- /dev/null +++ b/doc/uk/org/ury/frontend/testrig/package-tree.html @@ -0,0 +1,159 @@ + + + + + + +uk.org.ury.frontend.testrig Class Hierarchy + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package uk.org.ury.frontend.testrig +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +

    +Interface Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/uk/org/ury/frontend/testrig/package-use.html b/doc/uk/org/ury/frontend/testrig/package-use.html new file mode 100644 index 0000000..813f65a --- /dev/null +++ b/doc/uk/org/ury/frontend/testrig/package-use.html @@ -0,0 +1,189 @@ + + + + + + +Uses of Package uk.org.ury.frontend.testrig + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    uk.org.ury.frontend.testrig

    +
    + + + + + + + + + + + + + +
    +Packages that use uk.org.ury.frontend.testrig
    uk.org.ury.frontend  
    uk.org.ury.frontend.testrig  
    +  +

    + + + + + + + + +
    +Classes in uk.org.ury.frontend.testrig used by uk.org.ury.frontend
    Launcher + +
    +          Interface for entry points into the frontend.
    +  +

    + + + + + + + + +
    +Classes in uk.org.ury.frontend.testrig used by uk.org.ury.frontend.testrig
    Launcher + +
    +          Interface for entry points into the frontend.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + -- cgit v1.2.3