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/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 ++++++ 54 files changed, 10625 insertions(+) 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 (limited to 'doc/uk/org/ury/common') 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   +  + + + +
+ + + +
+ + + -- cgit v1.2.3