You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tasks/com/todoroo/andlib/data/ContentResolverDao.html

363 lines
16 KiB
HTML

<!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_26) on Thu Dec 22 20:39:06 PST 2011 -->
<TITLE>
ContentResolverDao
</TITLE>
<META NAME="date" CONTENT="2011-12-22">
<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="ContentResolverDao";
}
}
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ContentResolverDao.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/todoroo/andlib/data/AbstractModel.ContentValuesSavingVisitor.html" title="class in com.todoroo.andlib.data"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/todoroo/andlib/data/DatabaseDao.html" title="class in com.todoroo.andlib.data"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/todoroo/andlib/data/ContentResolverDao.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ContentResolverDao.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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">
com.todoroo.andlib.data</FONT>
<BR>
Class ContentResolverDao&lt;TYPE extends <A HREF="../../../../com/todoroo/andlib/data/AbstractModel.html" title="class in com.todoroo.andlib.data">AbstractModel</A>&gt;</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.todoroo.andlib.data.ContentResolverDao&lt;TYPE&gt;</B>
</PRE>
<DL>
<DT><DT><B>Type Parameters:</B><DD><CODE>TYPE</CODE> - model type</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/todoroo/astrid/data/MetadataApiDao.html" title="class in com.todoroo.astrid.data">MetadataApiDao</A>, <A HREF="../../../../com/todoroo/astrid/data/StoreObjectApiDao.html" title="class in com.todoroo.astrid.data">StoreObjectApiDao</A>, <A HREF="../../../../com/todoroo/astrid/data/TaskApiDao.html" title="class in com.todoroo.astrid.data">TaskApiDao</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>ContentResolverDao&lt;TYPE extends <A HREF="../../../../com/todoroo/andlib/data/AbstractModel.html" title="class in com.todoroo.andlib.data">AbstractModel</A>&gt;</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
DAO for reading and writing values from an Android ContentResolver
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>Tim Su <tim@todoroo.com></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="../../../../com/todoroo/andlib/data/ContentResolverDao.html#ContentResolverDao(java.lang.Class, android.content.Context, android.net.Uri)">ContentResolverDao</A></B>(java.lang.Class&lt;<A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html" title="type parameter in ContentResolverDao">TYPE</A>&gt;&nbsp;modelClass,
android.content.Context&nbsp;context,
android.net.Uri&nbsp;baseUri)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html#delete(long)">delete</A></B>(long&nbsp;id)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Delete specific item from the given table</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html#deleteWhere(com.todoroo.andlib.sql.Criterion)">deleteWhere</A></B>(<A HREF="../../../../com/todoroo/andlib/sql/Criterion.html" title="class in com.todoroo.andlib.sql">Criterion</A>&nbsp;where)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Delete by criteria</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html" title="type parameter in ContentResolverDao">TYPE</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html#fetch(long, com.todoroo.andlib.data.Property...)">fetch</A></B>(long&nbsp;id,
<A HREF="../../../../com/todoroo/andlib/data/Property.html" title="class in com.todoroo.andlib.data">Property</A>&lt;?&gt;...&nbsp;properties)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns object corresponding to the given identifier</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/todoroo/andlib/data/TodorooCursor.html" title="class in com.todoroo.andlib.data">TodorooCursor</A>&lt;<A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html" title="type parameter in ContentResolverDao">TYPE</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html#query(com.todoroo.andlib.sql.Query)">query</A></B>(<A HREF="../../../../com/todoroo/andlib/sql/Query.html" title="class in com.todoroo.andlib.sql">Query</A>&nbsp;query)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Query content provider</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html#save(TYPE)">save</A></B>(<A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html" title="type parameter in ContentResolverDao">TYPE</A>&nbsp;model)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create new or save existing model</TD>
</TR>
</TABLE>
&nbsp;<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>
&nbsp;
<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="ContentResolverDao(java.lang.Class, android.content.Context, android.net.Uri)"><!-- --></A><H3>
ContentResolverDao</H3>
<PRE>
public <B>ContentResolverDao</B>(java.lang.Class&lt;<A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html" title="type parameter in ContentResolverDao">TYPE</A>&gt;&nbsp;modelClass,
android.content.Context&nbsp;context,
android.net.Uri&nbsp;baseUri)</PRE>
<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="delete(long)"><!-- --></A><H3>
delete</H3>
<PRE>
public int <B>delete</B>(long&nbsp;id)</PRE>
<DL>
<DD>Delete specific item from the given table
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>id</CODE> -
<DT><B>Returns:</B><DD>number of rows affected</DL>
</DD>
</DL>
<HR>
<A NAME="deleteWhere(com.todoroo.andlib.sql.Criterion)"><!-- --></A><H3>
deleteWhere</H3>
<PRE>
public int <B>deleteWhere</B>(<A HREF="../../../../com/todoroo/andlib/sql/Criterion.html" title="class in com.todoroo.andlib.sql">Criterion</A>&nbsp;where)</PRE>
<DL>
<DD>Delete by criteria
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>where</CODE> -
<DT><B>Returns:</B><DD>number of rows affected</DL>
</DD>
</DL>
<HR>
<A NAME="query(com.todoroo.andlib.sql.Query)"><!-- --></A><H3>
query</H3>
<PRE>
public <A HREF="../../../../com/todoroo/andlib/data/TodorooCursor.html" title="class in com.todoroo.andlib.data">TodorooCursor</A>&lt;<A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html" title="type parameter in ContentResolverDao">TYPE</A>&gt; <B>query</B>(<A HREF="../../../../com/todoroo/andlib/sql/Query.html" title="class in com.todoroo.andlib.sql">Query</A>&nbsp;query)</PRE>
<DL>
<DD>Query content provider
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>query</CODE> -
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>
<A NAME="save(com.todoroo.andlib.data.AbstractModel)"><!-- --></A><A NAME="save(TYPE)"><!-- --></A><H3>
save</H3>
<PRE>
public boolean <B>save</B>(<A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html" title="type parameter in ContentResolverDao">TYPE</A>&nbsp;model)</PRE>
<DL>
<DD>Create new or save existing model
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>model</CODE> -
<DT><B>Returns:</B><DD>true if data was written to the db, false otherwise</DL>
</DD>
</DL>
<HR>
<A NAME="fetch(long, com.todoroo.andlib.data.Property...)"><!-- --></A><H3>
fetch</H3>
<PRE>
public <A HREF="../../../../com/todoroo/andlib/data/ContentResolverDao.html" title="type parameter in ContentResolverDao">TYPE</A> <B>fetch</B>(long&nbsp;id,
<A HREF="../../../../com/todoroo/andlib/data/Property.html" title="class in com.todoroo.andlib.data">Property</A>&lt;?&gt;...&nbsp;properties)</PRE>
<DL>
<DD>Returns object corresponding to the given identifier
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>database</CODE> - <DD><CODE>table</CODE> - name of table<DD><CODE>properties</CODE> - properties to read<DD><CODE>id</CODE> - id of item
<DT><B>Returns:</B><DD>null if no item found</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ContentResolverDao.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/todoroo/andlib/data/AbstractModel.ContentValuesSavingVisitor.html" title="class in com.todoroo.andlib.data"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/todoroo/andlib/data/DatabaseDao.html" title="class in com.todoroo.andlib.data"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/todoroo/andlib/data/ContentResolverDao.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ContentResolverDao.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>