Overview Package Class Source Tree Index About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.sql.rowset.serial

Class SerialRef

Implemented Interfaces:
Cloneable, Ref, Serializable
public class SerialRef
extends Object
implements Ref, Serializable, Cloneable
A serialized mapping of a 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.

See Also:
Serialized Form

Constructor Summary

SerialRef(Ref ref)
Constructs a SerialRef object from the given Ref object.

Method Summary

String
getBaseTypeName()
Returns a string describing the base type name of the Ref.
Object
getObject()
Returns an Object representing the SQL structured type to which this SerialRef object refers.
Object
getObject(java.util.Map> map)
Returns an Object representing the SQL structured type to which this SerialRef object refers.
void
setObject(Object obj)
Sets the SQL structured type that this SerialRef object references to the given Object object.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SerialRef

public SerialRef(Ref ref)
            throws SerialException,
                   SQLException
Constructs a SerialRef object from the given Ref object.
Parameters:
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.
SerialException - if an error occurs serializing the Ref object

Method Details

getBaseTypeName

public String getBaseTypeName()
            throws SerialException
Returns a string describing the base type name of the Ref.
Specified by:
getBaseTypeName in interface Ref
Returns:
a string of the base type name of the Ref
Throws:
SerialException - in no Ref object has been set

getObject

public Object getObject()
            throws SerialException
Returns an Object representing the SQL structured type to which this SerialRef object refers.
Specified by:
getObject in interface Ref
Returns:
an object instance resolved from the Ref reference
Throws:
SerialException - if an error is encountered in the reference resolution

getObject

public Object getObject(java.util.Map> map)
            throws SerialException
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.
Specified by:
getObject in interface Ref
Parameters:
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
Returns:
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

setObject

public void setObject(Object obj)
            throws SerialException
Sets the SQL structured type that this SerialRef object references to the given Object object.
Specified by:
setObject in interface Ref
Parameters:
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

Overview Package Class Source Tree Index About
Java API(Doc)