diff options
Diffstat (limited to 'doc/uk/org/ury/backend/database/DatabaseItem.html')
| -rw-r--r-- | doc/uk/org/ury/backend/database/DatabaseItem.html | 320 |
1 files changed, 320 insertions, 0 deletions
diff --git a/doc/uk/org/ury/backend/database/DatabaseItem.html b/doc/uk/org/ury/backend/database/DatabaseItem.html new file mode 100644 index 0000000..1d98e28 --- /dev/null +++ b/doc/uk/org/ury/backend/database/DatabaseItem.html @@ -0,0 +1,320 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_20) on Mon Mar 21 21:53:08 GMT 2011 --> +<TITLE> +DatabaseItem +</TITLE> + +<META NAME="date" CONTENT="2011-03-21"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="DatabaseItem"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DatabaseItem.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../uk/org/ury/backend/database/DatabaseDriver.html" title="class in uk.org.ury.backend.database"><B>PREV CLASS</B></A> + <A HREF="../../../../../uk/org/ury/backend/database/UserClass.html" title="enum in uk.org.ury.backend.database"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?uk/org/ury/backend/database/DatabaseItem.html" target="_top"><B>FRAMES</B></A> + <A HREF="DatabaseItem.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + 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> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +uk.org.ury.backend.database</FONT> +<BR> +Class DatabaseItem<E,T></H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>uk.org.ury.backend.database.DatabaseItem<E,T></B> +</PRE> +<DL> +<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../uk/org/ury/common/library/item/LibraryItem.html" title="class in uk.org.ury.common.library.item">LibraryItem</A>, <A HREF="../../../../../uk/org/ury/common/show/item/ShowItem.html" title="class in uk.org.ury.common.show.item">ShowItem</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public abstract class <B>DatabaseItem<E,T></B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Matt Windsor</DD> +</DL> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_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>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html#DatabaseItem(java.util.Map)">DatabaseItem</A></B>(java.util.Map<<A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html" title="type parameter in DatabaseItem">E</A>,<A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html" title="type parameter in DatabaseItem">T</A>> properties)</CODE> + +<BR> + Construct a new item from an existing list of properties.</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_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>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Map<java.lang.String,java.lang.String></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html#asResponse()">asResponse</A></B>()</CODE> + +<BR> + Retrieve a map of string representations of the properties.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html" title="type parameter in DatabaseItem">T</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html#get(E)">get</A></B>(<A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html" title="type parameter in DatabaseItem">E</A> property)</CODE> + +<BR> + Query this item for a property.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html#has(E)">has</A></B>(<A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html" title="type parameter in DatabaseItem">E</A> property)</CODE> + +<BR> + Check whether a property has been set in the item.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></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.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="DatabaseItem(java.util.Map)"><!-- --></A><H3> +DatabaseItem</H3> +<PRE> +public <B>DatabaseItem</B>(java.util.Map<<A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html" title="type parameter in DatabaseItem">E</A>,<A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html" title="type parameter in DatabaseItem">T</A>> properties)</PRE> +<DL> +<DD>Construct a new item from an existing list of properties. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>properties</CODE> - The map of properties that the new item will inherit.</DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="has(java.lang.Object)"><!-- --></A><A NAME="has(E)"><!-- --></A><H3> +has</H3> +<PRE> +public boolean <B>has</B>(<A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html" title="type parameter in DatabaseItem">E</A> property)</PRE> +<DL> +<DD>Check whether a property has been set in the item. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>true if the property has been set; false otherwise.</DL> +</DD> +</DL> +<HR> + +<A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(E)"><!-- --></A><H3> +get</H3> +<PRE> +public <A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html" title="type parameter in DatabaseItem">T</A> <B>get</B>(<A HREF="../../../../../uk/org/ury/backend/database/DatabaseItem.html" title="type parameter in DatabaseItem">E</A> property) + throws <A HREF="../../../../../uk/org/ury/backend/database/exceptions/MissingPropertyException.html" title="class in uk.org.ury.backend.database.exceptions">MissingPropertyException</A></PRE> +<DL> +<DD>Query this item for a property. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>property</CODE> - The property to query. +<DT><B>Returns:</B><DD>The property, if it exists. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../uk/org/ury/backend/database/exceptions/MissingPropertyException.html" title="class in uk.org.ury.backend.database.exceptions">MissingPropertyException</A></CODE> - if the property does not exist.</DL> +</DD> +</DL> +<HR> + +<A NAME="asResponse()"><!-- --></A><H3> +asResponse</H3> +<PRE> +public java.util.Map<java.lang.String,java.lang.String> <B>asResponse</B>()</PRE> +<DL> +<DD>Retrieve a map of string representations of the properties. + + This relies on E and T having meaningful toString methods. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>a list of lines representing the response.</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DatabaseItem.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../uk/org/ury/backend/database/DatabaseDriver.html" title="class in uk.org.ury.backend.database"><B>PREV CLASS</B></A> + <A HREF="../../../../../uk/org/ury/backend/database/UserClass.html" title="enum in uk.org.ury.backend.database"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?uk/org/ury/backend/database/DatabaseItem.html" target="_top"><B>FRAMES</B></A> + <A HREF="DatabaseItem.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + 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> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> |