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

Print this page




 981     * An SQL <code>NULL</code> column value must be represented as a <code>null</code>
 982     * in the Java programming language.
 983     * <P>
 984     * The standard reference implementation for the <code>CachedRowSet</code>
 985     * interface uses a <code>TreeMap</code> object for the rowset, with the
 986     * values in each row being contained in  <code>Vector</code> objects. It is
 987     * expected that most implementations will do the same.
 988     * <P>
 989     * The <code>TreeMap</code> type of collection guarantees that the map will be in
 990     * ascending key order, sorted according to the natural order for the
 991     * key's class.
 992     * Each key references a <code>Vector</code> object that corresponds to one
 993     * row of a <code>RowSet</code> object. Therefore, the size of each
 994     * <code>Vector</code> object  must be exactly equal to the number of
 995     * columns in the <code>RowSet</code> object.
 996     * The key used by the <code>TreeMap</code> collection is determined by the
 997     * implementation, which may choose to leverage a set key that is
 998     * available within the internal <code>RowSet</code> tabular structure by
 999     * virtue of a key already set either on the <code>RowSet</code> object
1000     * itself or on the underlying SQL data.
1001     * <P>
1002     *
1003     * @return a <code>Collection</code> object that contains the values in
1004     * each row in this <code>CachedRowSet</code> object
1005     * @throws SQLException if an error occurs generating the collection
1006     * @see #toCollection(int)
1007     * @see #toCollection(String)
1008     */
1009     public Collection<?> toCollection() throws SQLException;
1010 
1011    /**
1012     * Converts the designated column in this <code>CachedRowSet</code> object
1013     * to a <code>Collection</code> object. Implementations have some latitude in
1014     * how they can represent this <code>Collection</code> object because of the
1015     * abstract nature of the <code>Collection</code> framework.
1016     * Each column value should be fully represented in either a
1017     * general purpose <code>Collection</code> implementation or a specialized
1018     * <code>Collection</code> implementation, such as a <code>Vector</code> object.
1019     * An SQL <code>NULL</code> column value must be represented as a <code>null</code>
1020     * in the Java programming language.
1021     * <P>




 981     * An SQL <code>NULL</code> column value must be represented as a <code>null</code>
 982     * in the Java programming language.
 983     * <P>
 984     * The standard reference implementation for the <code>CachedRowSet</code>
 985     * interface uses a <code>TreeMap</code> object for the rowset, with the
 986     * values in each row being contained in  <code>Vector</code> objects. It is
 987     * expected that most implementations will do the same.
 988     * <P>
 989     * The <code>TreeMap</code> type of collection guarantees that the map will be in
 990     * ascending key order, sorted according to the natural order for the
 991     * key's class.
 992     * Each key references a <code>Vector</code> object that corresponds to one
 993     * row of a <code>RowSet</code> object. Therefore, the size of each
 994     * <code>Vector</code> object  must be exactly equal to the number of
 995     * columns in the <code>RowSet</code> object.
 996     * The key used by the <code>TreeMap</code> collection is determined by the
 997     * implementation, which may choose to leverage a set key that is
 998     * available within the internal <code>RowSet</code> tabular structure by
 999     * virtue of a key already set either on the <code>RowSet</code> object
1000     * itself or on the underlying SQL data.

1001     *
1002     * @return a <code>Collection</code> object that contains the values in
1003     * each row in this <code>CachedRowSet</code> object
1004     * @throws SQLException if an error occurs generating the collection
1005     * @see #toCollection(int)
1006     * @see #toCollection(String)
1007     */
1008     public Collection<?> toCollection() throws SQLException;
1009 
1010    /**
1011     * Converts the designated column in this <code>CachedRowSet</code> object
1012     * to a <code>Collection</code> object. Implementations have some latitude in
1013     * how they can represent this <code>Collection</code> object because of the
1014     * abstract nature of the <code>Collection</code> framework.
1015     * Each column value should be fully represented in either a
1016     * general purpose <code>Collection</code> implementation or a specialized
1017     * <code>Collection</code> implementation, such as a <code>Vector</code> object.
1018     * An SQL <code>NULL</code> column value must be represented as a <code>null</code>
1019     * in the Java programming language.
1020     * <P>