sql/rowset/JoinRowSet.java

38  * The <code>JoinRowSet</code> interface provides a mechanism for combining related
39  * data from different <code>RowSet</code> objects into one <code>JoinRowSet</code>
41  * In other words, a <code>JoinRowSet</code> object acts as a
56  * reconnecting to the data source. The <code>JoinRowSet</code>
60  * can be added to a <code>JoinRowSet</code> object to become
68  * <code>JdbcRowSet</code> object to be added to a <code>JoinRowSet</code> object
72  * instance of <code>JoinRowSet</code> provided that they
82  * a <code>JoinRowSet</code> object establishes <code>JOIN</code> relationships
87  * one of the <code>JoinRowSet</code> constants using the method
98  * <code>JoinRowSet</code> interface explain these <code>JOIN</code> types, which are
101  * <h3>2.0 Using a <code>JoinRowSet</code> Object for Creating a <code>JOIN</code></h3>
102  * When a <code>JoinRowSet</code> object is created, it is empty.
106  * <code>RowSet</code> objects to be added to the <code>JoinRowSet</code> object
118  *  object is added to a <code>JoinRowSet</code> object. The <code>RowSet</code> object
122  *  <li>By calling one of the versions of the <code>JoinRowSet</code> method
127  *  object is being added to a <code>JoinRowSet</code> object.
132  * objects to a <code>JoinRowSet</code> object. Note that in this example,
138  * <code>JoinRowSet</code> object <i>jrs</i>. Then
145  * in the table <code>ESSP_BONUS_PLAN</code> are added to the <code>JoinRowSet</code>
150  *     JoinRowSet jrs = new JoinRowSetImpl();
183  * <code>CachedRowSet</code> object is added to the <code>JoinRowSet</code> object.
191  * The <code>JoinRowSet</code> object <i>jrs</i> now contains values from all three
196  * <h3>4.0 <code>JoinRowSet</code> Methods</h3>
197  * The <code>JoinRowSet</code> interface supplies several methods for adding
199  * <code>JoinRowSet</code> object.
208  *       <code>JoinRowSet</code> object, and another method retrieves the
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>
223 public interface JoinRowSet extends WebRowSet {
226      * Adds the given <code>RowSet</code> object to this <code>JoinRowSet</code>
228      * is the first to be added to this <code>JoinRowSet</code>
240      *        <code>JoinRowSet</code> object; it must implement the
243      *         <code>JoinRowSet</code> object, (2) a match column has not been
251      * Adds the given <code>RowSet</code> object to this <code>JoinRowSet</code>
254      * is the first to be added to this <code>JoinRowSet</code>
262      *        <code>JoinRowSet</code> object; it may implement the
273      * Adds <i>rowset</i> to this <code>JoinRowSet</code> object and
275      * is the first to be added to this <code>JoinRowSet</code>
283      *        <code>JoinRowSet</code> object; it may implement the
296      * array of <code>RowSet</code> objects to this <code>JoinRowSet</code>
305      * The first <code>RowSet</code> object added to this <code>JoinRowSet</code>
318      *         <code>JoinRowSet</code> object, (2) a match column is not set
328      * array of <code>RowSet</code> objects to this <code>JoinRowSet</code>
337      * The first <code>RowSet</code> object added to this <code>JoinRowSet</code>
350      *         <code>JoinRowSet</code> object, (2) a match column is not set
361      * <code>JoinRowSet</code> object.
367      *        <code>RowSet</code> objects added to this <code>JoinRowSet</code>
376      *         <code>RowSet</code> objects added to this <code>JoinRowSet</code>
380      *         <code>RowSet</code> objects in this <code>JoinRowSet</code>
390      * data in this <code>JoinRowSet</code> object, which can be saved
394      * If any updates or modifications have been applied to the JoinRowSet
404      * should be used and called on a JoinRowSet object instance. Implementations
409      * @return a CachedRowSet containing the contents of the JoinRowSet
419      * Indicates if CROSS_JOIN is supported by a JoinRowSet
427      * Indicates if INNER_JOIN is supported by a JoinRowSet
435      * Indicates if LEFT_OUTER_JOIN is supported by a JoinRowSet
443      * Indicates if RIGHT_OUTER_JOIN is supported by a JoinRowSet
451      * Indicates if FULL_JOIN is supported by a JoinRowSet
460      * on tables contained within the JoinRowSet object instance.
464      * @param joinType the standard JoinRowSet.XXX static field definition
465      * of a SQL <code>JOIN</code> to re-configure a JoinRowSet instance on
474      * in a JoinRowSet object. An implementation can describe
477      * description to assist applications using a <code>JoinRowSet</code>
480      * WHERE clause used in the JoinRowSet instance
488      * governing this JoinRowSet instance. The returned type will be one of
489      * standard JoinRowSet types: <code>CROSS_JOIN</code>, <code>INNER_JOIN</code>,
493      * @return joinType one of the standard JoinRowSet static field
494      *     definitions of a SQL <code>JOIN</code>. <code>JoinRowSet.INNER_JOIN</code>
498      *     type supported by the JoinRowSet instance.