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 ++++++++++++++++++++++++ 1 file changed, 277 insertions(+) create mode 100644 doc/uk/org/ury/common/library/LibraryUtils.html (limited to 'doc/uk/org/ury/common/library/LibraryUtils.html') 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
+ + + +
+ + + -- cgit v1.2.3