diff options
Diffstat (limited to 'doc/uk/org/ury/library/viewer/LibraryViewer.html')
| -rw-r--r-- | doc/uk/org/ury/library/viewer/LibraryViewer.html | 192 |
1 files changed, 26 insertions, 166 deletions
diff --git a/doc/uk/org/ury/library/viewer/LibraryViewer.html b/doc/uk/org/ury/library/viewer/LibraryViewer.html index 5138c9b..e1f328e 100644 --- a/doc/uk/org/ury/library/viewer/LibraryViewer.html +++ b/doc/uk/org/ury/library/viewer/LibraryViewer.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_22) on Tue Mar 15 10:21:42 GMT 2011 --> +<!-- Generated by javadoc (build 1.6.0_20) on Sun Mar 20 03:05:31 GMT 2011 --> <TITLE> LibraryViewer </TITLE> -<META NAME="date" CONTENT="2011-03-15"> +<META NAME="date" CONTENT="2011-03-20"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> @@ -55,7 +55,7 @@ function windowTitle() <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - PREV CLASS + <A HREF="../../../../../uk/org/ury/library/viewer/LibraryTableModel.html" title="class in uk.org.ury.library.viewer"><B>PREV CLASS</B></A> <A HREF="../../../../../uk/org/ury/library/viewer/LibraryViewerPanel.html" title="class in uk.org.ury.library.viewer"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?uk/org/ury/library/viewer/LibraryViewer.html" target="_top"><B>FRAMES</B></A> @@ -76,7 +76,7 @@ function windowTitle() </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: <A HREF="#nested_classes_inherited_from_class_java.awt.Component">NESTED</A> | <A HREF="#fields_inherited_from_class_java.awt.Component">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> @@ -93,16 +93,11 @@ uk.org.ury.library.viewer</FONT> Class LibraryViewer</H2> <PRE> java.lang.Object - <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.awt.Component - <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.awt.Container - <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.awt.Panel - <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">java.applet.Applet - <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">javax.swing.JApplet - <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../uk/org/ury/frontend/AbstractFrontendModule.html" title="class in uk.org.ury.frontend">uk.org.ury.frontend.AbstractFrontendModule</A> - <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>uk.org.ury.library.viewer.LibraryViewer</B> + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../uk/org/ury/frontend/AbstractFrontendModule.html" title="class in uk.org.ury.frontend">uk.org.ury.frontend.AbstractFrontendModule</A> + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>uk.org.ury.library.viewer.LibraryViewer</B> </PRE> <DL> -<DT><B>All Implemented Interfaces:</B> <DD>java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, <A HREF="../../../../../uk/org/ury/frontend/FrontendModule.html" title="interface in uk.org.ury.frontend">FrontendModule</A></DD> +<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../uk/org/ury/frontend/FrontendModule.html" title="interface in uk.org.ury.frontend">FrontendModule</A></DD> </DL> <HR> <DL> @@ -110,58 +105,18 @@ java.lang.Object </PRE> <P> +Module for investigating the track library. +<P> + +<P> <DL> -<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#uk.org.ury.library.viewer.LibraryViewer">Serialized Form</A></DL> +<DT><B>Author:</B></DT> + <DD>Matt Windsor</DD> +</DL> <HR> <P> -<!-- ======== NESTED CLASS SUMMARY ======== --> -<A NAME="nested_class_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Nested Class Summary</B></FONT></TH> -</TR> -</TABLE> - <A NAME="nested_classes_inherited_from_class_java.awt.Component"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Nested classes/interfaces inherited from class java.awt.Component</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>java.awt.Component.BaselineResizeBehavior</CODE></TD> -</TR> -</TABLE> - -<!-- =========== FIELD SUMMARY =========== --> - -<A NAME="field_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Field Summary</B></FONT></TH> -</TR> -</TABLE> - <A NAME="fields_inherited_from_class_java.awt.Component"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Fields inherited from class java.awt.Component</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT</CODE></TD> -</TR> -</TABLE> - <A NAME="fields_inherited_from_class_java.awt.image.ImageObserver"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Fields inherited from interface java.awt.image.ImageObserver</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH</CODE></TD> -</TR> -</TABLE> - <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> @@ -196,7 +151,7 @@ java.lang.Object </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.util.List<<A HREF="../../../../../uk/org/ury/library/LibraryItem.html" title="class in uk.org.ury.library">LibraryItem</A>></CODE></FONT></TD> +<CODE> java.util.List<<A HREF="../../../../../uk/org/ury/library/item/LibraryItem.html" title="class in uk.org.ury.library.item">LibraryItem</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../uk/org/ury/library/viewer/LibraryViewer.html#getLibraryList()">getLibraryList</A></B>()</CODE> <BR> @@ -204,73 +159,12 @@ java.lang.Object </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../uk/org/ury/library/viewer/LibraryViewer.html#init()">init</A></B>()</CODE> - -<BR> - Initialise the library viewer frontend as an applet.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../uk/org/ury/frontend/FrontendModulePanel.html" title="class in uk.org.ury.frontend">FrontendModulePanel</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../uk/org/ury/library/viewer/LibraryViewer.html#runFrontend(uk.org.ury.frontend.FrontendMaster)">runFrontend</A></B>(<A HREF="../../../../../uk/org/ury/frontend/FrontendMaster.html" title="interface in uk.org.ury.frontend">FrontendMaster</A> master)</CODE> <BR> Run the library viewer frontend.</TD> </TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../uk/org/ury/library/viewer/LibraryViewer.html#start()">start</A></B>()</CODE> - -<BR> - Run the library viewer frontend as an applet.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_javax.swing.JApplet"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class javax.swing.JApplet</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, remove, repaint, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update</CODE></TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.applet.Applet"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.applet.Applet</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>destroy, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus, stop</CODE></TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.awt.Panel"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.awt.Panel</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>addNotify</CODE></TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.awt.Container"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.awt.Container</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate</CODE></TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.awt.Component"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.awt.Component</B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle</CODE></TD> -</TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> @@ -278,7 +172,7 @@ java.lang.Object <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> +<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> @@ -313,38 +207,6 @@ public <B>LibraryViewer</B>()</PRE> </TR> </TABLE> -<A NAME="init()"><!-- --></A><H3> -init</H3> -<PRE> -public void <B>init</B>()</PRE> -<DL> -<DD>Initialise the library viewer frontend as an applet. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../uk/org/ury/frontend/AbstractFrontendModule.html#init()">init</A></CODE> in class <CODE><A HREF="../../../../../uk/org/ury/frontend/AbstractFrontendModule.html" title="class in uk.org.ury.frontend">AbstractFrontendModule</A></CODE></DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="start()"><!-- --></A><H3> -start</H3> -<PRE> -public void <B>start</B>()</PRE> -<DL> -<DD>Run the library viewer frontend as an applet. -<P> -<DD><DL> -<DT><B>Overrides:</B><DD><CODE>start</CODE> in class <CODE>java.applet.Applet</CODE></DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - <A NAME="runFrontend(uk.org.ury.frontend.FrontendMaster)"><!-- --></A><H3> runFrontend</H3> <PRE> @@ -365,21 +227,19 @@ doSearch</H3> <PRE> public void <B>doSearch</B>(java.lang.String search) throws <A HREF="../../../../../uk/org/ury/library/exceptions/EmptySearchException.html" title="class in uk.org.ury.library.exceptions">EmptySearchException</A>, - <A HREF="../../../../../uk/org/ury/database/exceptions/QueryFailureException.html" title="class in uk.org.ury.database.exceptions">QueryFailureException</A></PRE> + <A HREF="../../../../../uk/org/ury/protocol/exceptions/InvalidMessageException.html" title="class in uk.org.ury.protocol.exceptions">InvalidMessageException</A></PRE> <DL> <DD>Do a library search. - This will update the library list to reflect the results of the - search. + This will update the library list to reflect the results of the search. <P> <DD><DL> -<DT><B>Parameters:</B><DD><CODE>search</CODE> - The string fragment to use in searches. - Cannot be empty or null. +<DT><B>Parameters:</B><DD><CODE>search</CODE> - The string fragment to use in searches. Cannot be empty or + null. <DT><B>Throws:</B> -<DD><CODE><A HREF="../../../../../uk/org/ury/library/exceptions/EmptySearchException.html" title="class in uk.org.ury.library.exceptions">EmptySearchException</A></CODE> - if the search string is - empty or null (from LibraryUtils.search). -<DD><CODE><A HREF="../../../../../uk/org/ury/database/exceptions/QueryFailureException.html" title="class in uk.org.ury.database.exceptions">QueryFailureException</A></CODE> - if the search query - fails (from LibraryUtils.search).</DL> +<DD><CODE><A HREF="../../../../../uk/org/ury/library/exceptions/EmptySearchException.html" title="class in uk.org.ury.library.exceptions">EmptySearchException</A></CODE> - if the search string is empty or null (from + LibraryUtils.search). +<DD><CODE><A HREF="../../../../../uk/org/ury/protocol/exceptions/InvalidMessageException.html" title="class in uk.org.ury.protocol.exceptions">InvalidMessageException</A></CODE> - if the response from the server is invalid.</DL> </DD> </DL> <HR> @@ -387,7 +247,7 @@ public void <B>doSearch</B>(java.lang.String search) <A NAME="getLibraryList()"><!-- --></A><H3> getLibraryList</H3> <PRE> -public java.util.List<<A HREF="../../../../../uk/org/ury/library/LibraryItem.html" title="class in uk.org.ury.library">LibraryItem</A>> <B>getLibraryList</B>()</PRE> +public java.util.List<<A HREF="../../../../../uk/org/ury/library/item/LibraryItem.html" title="class in uk.org.ury.library.item">LibraryItem</A>> <B>getLibraryList</B>()</PRE> <DL> <DD><DL> @@ -425,7 +285,7 @@ public java.util.List<<A HREF="../../../../../uk/org/ury/library/LibraryItem. <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - PREV CLASS + <A HREF="../../../../../uk/org/ury/library/viewer/LibraryTableModel.html" title="class in uk.org.ury.library.viewer"><B>PREV CLASS</B></A> <A HREF="../../../../../uk/org/ury/library/viewer/LibraryViewerPanel.html" title="class in uk.org.ury.library.viewer"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?uk/org/ury/library/viewer/LibraryViewer.html" target="_top"><B>FRAMES</B></A> @@ -446,7 +306,7 @@ public java.util.List<<A HREF="../../../../../uk/org/ury/library/LibraryItem. </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: <A HREF="#nested_classes_inherited_from_class_java.awt.Component">NESTED</A> | <A HREF="#fields_inherited_from_class_java.awt.Component">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> |