src/share/classes/javax/sql/rowset/serial/package.html

Print this page




  70 to locate a given pattern of bytes or a <tt>Blob </tt>object within a <tt>SerialBlob
  71 </tt>object. <br>
  72 
  73 <h3>3.0 SerialClob</h3>
  74 A serializable mapping in the Java programming language of an SQL CLOB
  75 value.  <br>
  76 <br>
  77 The <tt>SerialClob </tt>class provides a constructor for creating an instance
  78 from a <tt>Clob </tt>object. Note that the <tt>Clob </tt>object should have
  79 brought the SQL CLOB value's data over to the client before a <tt>SerialClob
  80 </tt>object is constructed from it. The data of an SQL CLOB value can be
  81 materialized on the client as a stream of Unicode characters. <br>
  82 <br>
  83 <tt>SerialClob </tt>methods make it possible to get a substring from a 
  84 <tt>SerialClob </tt>object or to locate the start of a pattern of characters. 
  85 <br>
  86 
  87 <h3>5.0 SerialDatalink</h3>
  88 A serializable mapping in the Java programming language of an SQL DATALINK
  89 value. A DATALINK value references a file outside of the underlying data source
  90 that the the originating data source manages. <br>
  91 <br>
  92 <code>RowSet</code> implementations can use the method <tt>RowSet.getURL() </tt>to retrieve
  93 a <code>java.net.URL</code> object, which can be used to manipulate the external data.
  94 <br>
  95 <br>
  96 &nbsp;&nbsp;<tt>&nbsp;&nbsp;&nbsp; java.net.URL url = rowset.getURL(1);</tt><br>
  97 
  98 <h3>6.0 SerialJavaObject</h3>
  99 A serializable mapping in the Java programming language of an SQL JAVA_OBJECT
 100 value. Assuming the Java object instance implements the Serializable interface,
 101 this simply wraps the serialization process. <br>
 102 <br>
 103 If however, the serialization is not possible in the case where the Java
 104 object is not immediately serializable, this class will attempt to serialize
 105 all non static members to permit the object instance state to be serialized.
 106 Static or transient fields cannot be serialized and attempting to do so 
 107 will result in a <tt>SerialException </tt>being thrown. <br>
 108 
 109 <h3>7.0 SerialRef</h3>
 110 A serializable mapping between the SQL REF type and the Java programming


 124 to the method <code>getAttributes</code>, the structured type is custom mapped 
 125 according to the mapping specified in the <code>Map</code> object.
 126   <br>
 127   The <tt>SerialStruct </tt>class provides a constructor for creating an
 128 instance  from a <tt>Struct</tt> object, a method for retrieving the SQL
 129 type name of the SQL structured type in the database, and methods for retrieving
 130 its attribute values. <br>
 131    
 132 <h3>9.0 SQLInputImpl</h3>
 133   An input stream used for custom mapping user-defined types (UDTs). An 
 134   <tt>SQLInputImpl</tt> object is an input stream that contains a stream of 
 135   values that are
 136 the attributes of a UDT. This class is used by the driver behind the scenes
 137 when the method <tt>getObject</tt> is called on an SQL structured or distinct
 138 type that has a custom mapping; a programmer never invokes <tt>SQLInputImpl
 139 </tt> methods directly. <br>
 140   <br>
 141   The <tt>SQLInputImpl</tt> class provides a set of reader methods
 142  analogous to the <tt>ResultSet</tt> getter methods. These methods make it
 143  possible to read the values in an <tt>SQLInputImpl</tt> object. The method
 144 <code>wasNull</code> is used to determine whether the the last value read was SQL NULL.
 145  <br>
 146   <br>
 147   When a constructor or getter method that takes a <code>Map</code> object is called, 
 148 the JDBC driver calls the method
 149 <tt>SQLData.getSQLType</tt> to determine the SQL type of the UDT being custom
 150 mapped. The driver  creates an instance of <code>SQLInputImpl</code>, populating it with
 151 the attributes of  the UDT. The driver then passes the input stream to the
 152 method <tt>SQLData.readSQL</tt>,  which in turn calls the <tt>SQLInputImpl</tt>
 153 methods to read the  attributes from the input stream. <br>
 154    
 155 <h3>10.0 SQLOutputImpl</h3>
 156   The output stream for writing the attributes of a custom mapped user-defined
 157  type (UDT) back to the database. The driver uses this interface internally,
 158  and its methods are never directly invoked by an application programmer.
 159 <br>
 160   <br>
 161   When an application calls the method <tt>PreparedStatement.setObject, </tt>the
 162  driver checks to see whether the value to be written is a UDT with a custom
 163  mapping. If it is, there will be an entry in a type map containing the Class
 164  object for the class that implements <tt>SQLData </tt>for this UDT. If the




  70 to locate a given pattern of bytes or a <tt>Blob </tt>object within a <tt>SerialBlob
  71 </tt>object. <br>
  72 
  73 <h3>3.0 SerialClob</h3>
  74 A serializable mapping in the Java programming language of an SQL CLOB
  75 value.  <br>
  76 <br>
  77 The <tt>SerialClob </tt>class provides a constructor for creating an instance
  78 from a <tt>Clob </tt>object. Note that the <tt>Clob </tt>object should have
  79 brought the SQL CLOB value's data over to the client before a <tt>SerialClob
  80 </tt>object is constructed from it. The data of an SQL CLOB value can be
  81 materialized on the client as a stream of Unicode characters. <br>
  82 <br>
  83 <tt>SerialClob </tt>methods make it possible to get a substring from a 
  84 <tt>SerialClob </tt>object or to locate the start of a pattern of characters. 
  85 <br>
  86 
  87 <h3>5.0 SerialDatalink</h3>
  88 A serializable mapping in the Java programming language of an SQL DATALINK
  89 value. A DATALINK value references a file outside of the underlying data source
  90 that the originating data source manages. <br>
  91 <br>
  92 <code>RowSet</code> implementations can use the method <tt>RowSet.getURL() </tt>to retrieve
  93 a <code>java.net.URL</code> object, which can be used to manipulate the external data.
  94 <br>
  95 <br>
  96 &nbsp;&nbsp;<tt>&nbsp;&nbsp;&nbsp; java.net.URL url = rowset.getURL(1);</tt><br>
  97 
  98 <h3>6.0 SerialJavaObject</h3>
  99 A serializable mapping in the Java programming language of an SQL JAVA_OBJECT
 100 value. Assuming the Java object instance implements the Serializable interface,
 101 this simply wraps the serialization process. <br>
 102 <br>
 103 If however, the serialization is not possible in the case where the Java
 104 object is not immediately serializable, this class will attempt to serialize
 105 all non static members to permit the object instance state to be serialized.
 106 Static or transient fields cannot be serialized and attempting to do so 
 107 will result in a <tt>SerialException </tt>being thrown. <br>
 108 
 109 <h3>7.0 SerialRef</h3>
 110 A serializable mapping between the SQL REF type and the Java programming


 124 to the method <code>getAttributes</code>, the structured type is custom mapped 
 125 according to the mapping specified in the <code>Map</code> object.
 126   <br>
 127   The <tt>SerialStruct </tt>class provides a constructor for creating an
 128 instance  from a <tt>Struct</tt> object, a method for retrieving the SQL
 129 type name of the SQL structured type in the database, and methods for retrieving
 130 its attribute values. <br>
 131    
 132 <h3>9.0 SQLInputImpl</h3>
 133   An input stream used for custom mapping user-defined types (UDTs). An 
 134   <tt>SQLInputImpl</tt> object is an input stream that contains a stream of 
 135   values that are
 136 the attributes of a UDT. This class is used by the driver behind the scenes
 137 when the method <tt>getObject</tt> is called on an SQL structured or distinct
 138 type that has a custom mapping; a programmer never invokes <tt>SQLInputImpl
 139 </tt> methods directly. <br>
 140   <br>
 141   The <tt>SQLInputImpl</tt> class provides a set of reader methods
 142  analogous to the <tt>ResultSet</tt> getter methods. These methods make it
 143  possible to read the values in an <tt>SQLInputImpl</tt> object. The method
 144 <code>wasNull</code> is used to determine whether the last value read was SQL NULL.
 145  <br>
 146   <br>
 147   When a constructor or getter method that takes a <code>Map</code> object is called, 
 148 the JDBC driver calls the method
 149 <tt>SQLData.getSQLType</tt> to determine the SQL type of the UDT being custom
 150 mapped. The driver  creates an instance of <code>SQLInputImpl</code>, populating it with
 151 the attributes of  the UDT. The driver then passes the input stream to the
 152 method <tt>SQLData.readSQL</tt>,  which in turn calls the <tt>SQLInputImpl</tt>
 153 methods to read the  attributes from the input stream. <br>
 154    
 155 <h3>10.0 SQLOutputImpl</h3>
 156   The output stream for writing the attributes of a custom mapped user-defined
 157  type (UDT) back to the database. The driver uses this interface internally,
 158  and its methods are never directly invoked by an application programmer.
 159 <br>
 160   <br>
 161   When an application calls the method <tt>PreparedStatement.setObject, </tt>the
 162  driver checks to see whether the value to be written is a UDT with a custom
 163  mapping. If it is, there will be an entry in a type map containing the Class
 164  object for the class that implements <tt>SQLData </tt>for this UDT. If the