src/share/classes/javax/sql/rowset/JoinRowSet.java

Print this page
rev 10065 : 8046389: Add missing @since tag under javax.sql.**
Reviewed-by:


 200  * <UL>
 201  *   <LI>Methods for adding one or more <code>RowSet</code> objects<BR>
 202  *       These methods allow an application to add one <code>RowSet</code> object
 203  *       at a time or to add multiple <code>RowSet</code> objects at one time. In
 204  *       either case, the methods may specify the match column for each
 205  *       <code>RowSet</code> object being added.
 206  *   <LI>Methods for getting information<BR>
 207  *       One method retrieves the <code>RowSet</code> objects in the
 208  *       <code>JoinRowSet</code> object, and another method retrieves the
 209  *       <code>RowSet</code> names.  A third method retrieves either the SQL
 210  *       <code>WHERE</code> clause used behind the scenes to form the
 211  *       <code>JOIN</code> or a text description of what the <code>WHERE</code>
 212  *       clause does.
 213  *   <LI>Methods related to the type of <code>JOIN</code><BR>
 214  *       One method sets the <code>JOIN</code> type, and five methods find out whether
 215  *       the <code>JoinRowSet</code> object supports a given type.
 216  *   <LI>A method to make a separate copy of the <code>JoinRowSet</code> object<BR>
 217  *       This method creates a copy that can be persisted to the data source.
 218  * </UL>
 219  *

 220  */
 221 
 222 public interface JoinRowSet extends WebRowSet {
 223 
 224     /**
 225      * Adds the given <code>RowSet</code> object to this <code>JoinRowSet</code>
 226      * object. If the <code>RowSet</code> object
 227      * is the first to be added to this <code>JoinRowSet</code>
 228      * object, it forms the basis of the <code>JOIN</code> relationship to be
 229      * established.
 230      * <P>
 231      * This method should be used only when the given <code>RowSet</code>
 232      * object already has a match column that was set with the <code>Joinable</code>
 233      * method <code>setMatchColumn</code>.
 234      * <p>
 235      * Note: A <code>Joinable</code> object is any <code>RowSet</code> object
 236      * that has implemented the <code>Joinable</code> interface.
 237      *
 238      * @param rowset the <code>RowSet</code> object that is to be added to this
 239      *        <code>JoinRowSet</code> object; it must implement the




 200  * <UL>
 201  *   <LI>Methods for adding one or more <code>RowSet</code> objects<BR>
 202  *       These methods allow an application to add one <code>RowSet</code> object
 203  *       at a time or to add multiple <code>RowSet</code> objects at one time. In
 204  *       either case, the methods may specify the match column for each
 205  *       <code>RowSet</code> object being added.
 206  *   <LI>Methods for getting information<BR>
 207  *       One method retrieves the <code>RowSet</code> objects in the
 208  *       <code>JoinRowSet</code> object, and another method retrieves the
 209  *       <code>RowSet</code> names.  A third method retrieves either the SQL
 210  *       <code>WHERE</code> clause used behind the scenes to form the
 211  *       <code>JOIN</code> or a text description of what the <code>WHERE</code>
 212  *       clause does.
 213  *   <LI>Methods related to the type of <code>JOIN</code><BR>
 214  *       One method sets the <code>JOIN</code> type, and five methods find out whether
 215  *       the <code>JoinRowSet</code> object supports a given type.
 216  *   <LI>A method to make a separate copy of the <code>JoinRowSet</code> object<BR>
 217  *       This method creates a copy that can be persisted to the data source.
 218  * </UL>
 219  *
 220  * @since 1.5
 221  */
 222 
 223 public interface JoinRowSet extends WebRowSet {
 224 
 225     /**
 226      * Adds the given <code>RowSet</code> object to this <code>JoinRowSet</code>
 227      * object. If the <code>RowSet</code> object
 228      * is the first to be added to this <code>JoinRowSet</code>
 229      * object, it forms the basis of the <code>JOIN</code> relationship to be
 230      * established.
 231      * <P>
 232      * This method should be used only when the given <code>RowSet</code>
 233      * object already has a match column that was set with the <code>Joinable</code>
 234      * method <code>setMatchColumn</code>.
 235      * <p>
 236      * Note: A <code>Joinable</code> object is any <code>RowSet</code> object
 237      * that has implemented the <code>Joinable</code> interface.
 238      *
 239      * @param rowset the <code>RowSet</code> object that is to be added to this
 240      *        <code>JoinRowSet</code> object; it must implement the