javax.sql.rowset.serial
Class SerialRef

java.lang.Object
  javax.sql.rowset.serial.SerialRef

All Implemented Interfaces:

Serializable , Cloneable , Ref

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. A serializable mapping between the SQL REF type and the Java programming language.

The SerialRef class provides a constructor for creating a SerialRef instance from a Ref object type, and provides methods for getting and gettinga nd setting the Ref object. object type.

See Also:

Serialized Form

Constructor Summary
SerialRef ( Ref           Constructs a the SerialRef object from the given any Ref object. object instance.

 

Method Summary
String	getBaseTypeName ()           Returns a string describing the base type name of the Ref.
Object	getObject ()           Returns an Object representing object resolved from the SQL structured type to which this SerialRef object refers. stored Ref reference.
Object	getObject ( Map < String , Class           Returns an Object representing object mapped according to the SQL structured supplied type to which this SerialRef object refers. mapping from the resolved Ref reference.
void	setObject ( Object           Sets the SQL structured type that this SerialRef           Set object references to the given Object object. be referenced.

 

Methods inherited from class java.lang. Object
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait

 

Constructor Detail

SerialRef

public SerialRef(Ref ref)
          throws SerialException,
                 SQLException

Constructs a the SerialRef object from the given any Ref object. object instance.

Parameters:

ref - a Ref object; object instance; cannot be null

Throws:

SQLException - if a database access occurs; if ref is null; occurs or if the Ref object returns a null ref value base type name. is null.

SerialException - if an error occurs serializing the Ref object object.

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(Map<String,Class<?>> 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. Returns an object mapped according to the supplied type mapping from the resolved Ref reference.

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

See Also:

Ref.setObject(java.lang.Object)

getObject

public Object getObject()
                 throws SerialException

Returns an Object representing the SQL structured type to which this SerialRef object refers. Returns an object resolved from the stored Ref reference.

Specified by:

getObject in interface Ref

Returns:

an object instance resolved resolve from the Ref reference refernce

Throws:

SerialException - if an error is encountered encounter in the reference resolution

See Also:

Ref.setObject(java.lang.Object)

setObject

public void setObject(Object obj)
               throws SerialException

Sets the SQL structured type that this SerialRef object references to the given Object object. Set object to be referenced.

Specified by:

setObject in interface Ref

Parameters:

obj - an Object representing the SQL structured type to be referenced obj - object instance to be referenced.

Throws:

SerialException - if an error is encountered generating the the structured type referenced by reference for this SerialRef object

See Also:

Ref.getObject() , Ref.getObject(Map) , PreparedStatement.setObject(int, Object) , CallableStatement.setObject(String, Object)