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