SerialRef JDK 1.6)

Description

public class SerialRef

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:

Constructors

public SerialRef (Ref ref) throws SerialException SQLException

Constructs a SerialRef object from the given Ref object.

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

Methods

Hide/Show inherited methods

public String getBaseTypeName () throws SerialException [Specified in Ref]

Returns a string describing the base type name of the Ref.

Returns a string describing the base type name of the Ref.
Returns: a string of the base type name of the Ref
Throws:
- SerialException - in no Ref object has been set

public Object getObject () throws SerialException [Specified in Ref]

Returns an Object representing the SQL structured type to which this SerialRef object refers.

Returns an Object representing the SQL structured type
to which this SerialRef object refers.
Returns: an object instance resolved from the Ref reference
Throws:
- SerialException - if an error is encountered in the reference resolution

public Object getObject (Map<String, Class<Object>> map) throws SerialException [Specified in Ref]

Returns an Object representing the SQL structured type to which this SerialRef object refers.

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 instance resolved from the Ref reference and mapped according to the supplied type map
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
Throws:
- SerialException - if an error is encountered in the reference resolution

public void setObject (Object obj) throws SerialException [Specified in Ref]

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

Sets the SQL structured type that this SerialRef object
references to the given Object object.
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