Ref object, which is the mapping in the
+ * Java programming language of an SQL REF value.
+ *
+ * The SerialRef class provides a constructor for
+ * creating a SerialRef instance from a Ref
+ * object and provides methods for getting and setting the Ref object.
+ *
+ *
Ref as an Object.
+ */
+ private Object object;
+
+ /**
+ * Private copy of the Ref reference.
+ */
+ private Ref reference;
+
+ /**
+ * Constructs a SerialRef object from the given Ref
+ * object.
+ *
+ * @param ref a Ref object; cannot be null
+ * @throws SQLException if a database access occurs; if ref
+ * is null; or if the Ref object returns a
+ * null value base type name.
+ * @throws SerialException if an error occurs serializing the Ref
+ * object
+ */
+ public SerialRef(Ref ref) throws SerialException, SQLException {
+ if (ref == null) {
+ throw new SQLException("Cannot instantiate a SerialRef object " +
+ "with a null Ref object");
+ }
+ reference = ref;
+ object = ref;
+ if (ref.getBaseTypeName() == null) {
+ throw new SQLException("Cannot instantiate a SerialRef object " +
+ "that returns a null base type name");
+ } else {
+ baseTypeName = ref.getBaseTypeName();
+ }
+ }
+
+ /**
+ * Returns a string describing the base type name of the Ref.
+ *
+ * @return a string of the base type name of the Ref
+ * @throws SerialException in no Ref object has been set
+ */
+ public String getBaseTypeName() throws SerialException {
+ return baseTypeName;
+ }
+
+ /**
+ * Returns an Object representing the SQL structured type
+ * to which this SerialRef object refers. The attributes
+ * of the structured type are mapped according to the given type map.
+ *
+ * @param map a java.util.Map object containing zero or
+ * more entries, with each entry consisting of 1) a String
+ * giving the fully qualified name of a UDT and 2) the
+ * Class object for the SQLData implementation
+ * that defines how the UDT is to be mapped
+ * @return an object instance resolved from the Ref reference and mapped
+ * according to the supplied type map
+ * @throws SerialException if an error is encountered in the reference
+ * resolution
+ */
+ public Object getObject(java.util.MapObject representing the SQL structured type
+ * to which this SerialRef object refers.
+ *
+ * @return an object instance resolved from the Ref reference
+ * @throws SerialException if an error is encountered in the reference
+ * resolution
+ */
+ public Object getObject() throws SerialException {
+
+ if (reference != null) {
+ try {
+ return reference.getObject();
+ } catch (SQLException e) {
+ throw new SerialException("SQLException: " + e.getMessage());
+ }
+ }
+
+ if (object != null) {
+ return object;
+ }
+
+
+ throw new SerialException("The object is not set");
+
+ }
+
+ /**
+ * Sets the SQL structured type that this SerialRef object
+ * references to the given Object object.
+ *
+ * @param obj an Object representing the SQL structured type
+ * to be referenced
+ * @throws SerialException if an error is encountered generating the
+ * the structured type referenced by this SerialRef object
+ */
+ public void setObject(Object obj) throws SerialException {
+ try {
+ reference.setObject(obj);
+ } catch (SQLException e) {
+ throw new SerialException("SQLException: " + e.getMessage());
+ }
+ object = obj;
+ }
+
+ /**
+ * Compares this SerialRef to the specified object. The result is {@code
+ * true} if and only if the argument is not {@code null} and is a {@code
+ * SerialRef} object that represents the same object as this
+ * object.
+ *
+ * @param obj The object to compare this {@code SerialRef} against
+ *
+ * @return {@code true} if the given object represents a {@code SerialRef}
+ * equivalent to this SerialRef, {@code false} otherwise
+ *
+ */
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if(obj instanceof SerialRef) {
+ SerialRef ref = (SerialRef)obj;
+ return baseTypeName.equals(ref.baseTypeName) &&
+ object.equals(ref.object);
+ }
+ return false;
+ }
+
+ /**
+ * Returns a hash code for this {@code SerialRef}.
+ * @return a hash code value for this object.
+ */
+ public int hashCode() {
+ return (31 + object.hashCode()) * 31 + baseTypeName.hashCode();
+ }
+
+ /**
+ * Returns a clone of this {@code SerialRef}.
+ * The underlying {@code Ref} object will be set to null.
+ *
+ * @return a clone of this SerialRef
+ */
+ public Object clone() {
+ try {
+ SerialRef ref = (SerialRef) super.clone();
+ ref.reference = null;
+ return ref;
+ } catch (CloneNotSupportedException ex) {
+ // this shouldn't happen, since we are Cloneable
+ throw new InternalError();
+ }
+
+ }
+
+ /**
+ * readObject is called to restore the state of the SerialRef from
+ * a stream.
+ */
+ private void readObject(ObjectInputStream s)
+ throws IOException, ClassNotFoundException {
+ ObjectInputStream.GetField fields = s.readFields();
+ object = fields.get("object", null);
+ baseTypeName = (String) fields.get("baseTypeName", null);
+ reference = (Ref) fields.get("reference", null);
+ }
+
+ /**
+ * writeObject is called to save the state of the SerialRef
+ * to a stream.
+ */
+ private void writeObject(ObjectOutputStream s)
+ throws IOException, ClassNotFoundException {
+
+ ObjectOutputStream.PutField fields = s.putFields();
+ fields.put("baseTypeName", baseTypeName);
+ fields.put("object", object);
+ // Note: this check to see if it is an instance of Serializable
+ // is for backwards compatibility
+ fields.put("reference", reference instanceof Serializable ? reference : null);
+ s.writeFields();
+ }
+
+ /**
+ * The identifier that assists in the serialization of this SerialRef
+ * object.
+ */
+ static final long serialVersionUID = -4727123500609662274L;
+
+
+}