| <!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.5.0_15) on Wed Aug 06 14:58:22 GMT-06:00 2008 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| RowManager (OpenJPA 1.2.0 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.openjpa.jdbc.sql.RowManager interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="RowManager (OpenJPA 1.2.0 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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/RowManager.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-all.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="../../../../../org/apache/openjpa/jdbc/sql/RowImpl.html" title="class in org.apache.openjpa.jdbc.sql"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/sql/RowManagerImpl.html" title="class in org.apache.openjpa.jdbc.sql"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/jdbc/sql/RowManager.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="RowManager.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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"> |
| org.apache.openjpa.jdbc.sql</FONT> |
| <BR> |
| Interface RowManager</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/openjpa/jdbc/sql/RowManagerImpl.html" title="class in org.apache.openjpa.jdbc.sql">RowManagerImpl</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/StateComparisonVersionStrategy.CustomUpdate.html" title="class in org.apache.openjpa.jdbc.meta.strats">StateComparisonVersionStrategy.CustomUpdate</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>RowManager</B></DL> |
| </PRE> |
| |
| <P> |
| Manages rows during an insert/update/delete process. Row managers |
| do not have to be threadsafe. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Abe White</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== 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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/sql/RowManager.html#flushAllRows(org.apache.openjpa.jdbc.sql.Row)">flushAllRows</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</A> row)</CODE> |
| |
| <BR> |
| Flush the logical row.</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="../../../../../org/apache/openjpa/jdbc/sql/RowManager.html#flushSecondaryRow(org.apache.openjpa.jdbc.sql.Row)">flushSecondaryRow</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</A> row)</CODE> |
| |
| <BR> |
| Flush the secondary row; after flushing the row is available for reuse.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/sql/RowManager.html#getAllRows(org.apache.openjpa.jdbc.schema.Table, int)">getAllRows</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table, |
| int action)</CODE> |
| |
| <BR> |
| Return a logical row representing an update that should be made to |
| all rows of the given table.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/sql/RowManager.html#getRow(org.apache.openjpa.jdbc.schema.Table, int, org.apache.openjpa.kernel.OpenJPAStateManager, boolean)">getRow</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table, |
| int action, |
| <A HREF="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| boolean create)</CODE> |
| |
| <BR> |
| Return the row for the given table and owner object, or null if |
| <code>create</code> is false and the row has not already been created.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/sql/RowManager.html#getSecondaryRow(org.apache.openjpa.jdbc.schema.Table, int)">getSecondaryRow</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table, |
| int action)</CODE> |
| |
| <BR> |
| Return a row for the given secondary table.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ 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="getRow(org.apache.openjpa.jdbc.schema.Table, int, org.apache.openjpa.kernel.OpenJPAStateManager, boolean)"><!-- --></A><H3> |
| getRow</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</A> <B>getRow</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table, |
| int action, |
| <A HREF="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| boolean create)</PRE> |
| <DL> |
| <DD>Return the row for the given table and owner object, or null if |
| <code>create</code> is false and the row has not already been created. |
| The action must be one of <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_INSERT"><CODE>Row.ACTION_INSERT</CODE></A>, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_UPDATE"><CODE>Row.ACTION_UPDATE</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_DELETE"><CODE>Row.ACTION_DELETE</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSecondaryRow(org.apache.openjpa.jdbc.schema.Table, int)"><!-- --></A><H3> |
| getSecondaryRow</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</A> <B>getSecondaryRow</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table, |
| int action)</PRE> |
| <DL> |
| <DD>Return a row for the given secondary table. |
| The action must be one of <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_INSERT"><CODE>Row.ACTION_INSERT</CODE></A>, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_UPDATE"><CODE>Row.ACTION_UPDATE</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_DELETE"><CODE>Row.ACTION_DELETE</CODE></A>. |
| Note that secondary rows are not considered when creating the foreign |
| key dependency graph, with can cause constraint violations when using |
| the <code>UPDATE</code> action. Only use this action if the secondary |
| row does not have restrict-action foreign keys. Otherwise use both |
| a delete and then an insert to perform the update. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="flushSecondaryRow(org.apache.openjpa.jdbc.sql.Row)"><!-- --></A><H3> |
| flushSecondaryRow</H3> |
| <PRE> |
| void <B>flushSecondaryRow</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</A> row) |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/SQLException.html" title="class or interface in java.sql">SQLException</A></PRE> |
| <DL> |
| <DD>Flush the secondary row; after flushing the row is available for reuse. |
| It will retain all previously set values. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/SQLException.html" title="class or interface in java.sql">SQLException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAllRows(org.apache.openjpa.jdbc.schema.Table, int)"><!-- --></A><H3> |
| getAllRows</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</A> <B>getAllRows</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table, |
| int action)</PRE> |
| <DL> |
| <DD>Return a logical row representing an update that should be made to |
| all rows of the given table. The action must be one of |
| <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_UPDATE"><CODE>Row.ACTION_UPDATE</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html#ACTION_DELETE"><CODE>Row.ACTION_DELETE</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="flushAllRows(org.apache.openjpa.jdbc.sql.Row)"><!-- --></A><H3> |
| flushAllRows</H3> |
| <PRE> |
| void <B>flushAllRows</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/sql/Row.html" title="interface in org.apache.openjpa.jdbc.sql">Row</A> row) |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/SQLException.html" title="class or interface in java.sql">SQLException</A></PRE> |
| <DL> |
| <DD>Flush the logical row. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/SQLException.html" title="class or interface in java.sql">SQLException</A></CODE></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/RowManager.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-all.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="../../../../../org/apache/openjpa/jdbc/sql/RowImpl.html" title="class in org.apache.openjpa.jdbc.sql"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/sql/RowManagerImpl.html" title="class in org.apache.openjpa.jdbc.sql"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/jdbc/sql/RowManager.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="RowManager.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006-2008 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
