- 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 aRef
object, which is the mapping in the Java programming language of an SQLREF
value.The
SerialRef
class provides a constructor for creating aSerialRef
instance from aRef
object and provides methods for getting and setting theRef
object.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description SerialRef(Ref ref)
Constructs aSerialRef
object from the givenRef
object.
-
Method Summary
Methods Modifier and Type Method and Description String
getBaseTypeName()
Returns a string describing the base type name of theRef
.Object
getObject()
Returns anObject
representing the SQL structured type to which thisSerialRef
object refers.Object
getObject(Map<String,Class<?>> map)
Returns anObject
representing the SQL structured type to which thisSerialRef
object refers.void
setObject(Object obj)
Sets the SQL structured type that thisSerialRef
object references to the givenObject
object.
-
-
-
Constructor Detail
-
SerialRef
public SerialRef(Ref ref) throws SerialException, SQLException
Constructs aSerialRef
object from the givenRef
object.- Parameters:
ref
- a Ref object; cannot benull
- Throws:
SQLException
- if a database access occurs; ifref
isnull
; or if theRef
object returns anull
value base type name.SerialException
- if an error occurs serializing theRef
object
-
-
Method Detail
-
getBaseTypeName
public String getBaseTypeName() throws SerialException
Returns a string describing the base type name of theRef
.- Specified by:
getBaseTypeName
in interfaceRef
- 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 anObject
representing the SQL structured type to which thisSerialRef
object refers. The attributes of the structured type are mapped according to the given type map.- Specified by:
getObject
in interfaceRef
- Parameters:
map
- ajava.util.Map
object containing zero or more entries, with each entry consisting of 1) aString
giving the fully qualified name of a UDT and 2) theClass
object for theSQLData
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 anObject
representing the SQL structured type to which thisSerialRef
object refers.- Specified by:
getObject
in interfaceRef
- Returns:
- an object instance resolved from the Ref reference
- Throws:
SerialException
- if an error is encountered 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 thisSerialRef
object references to the givenObject
object.- Specified by:
setObject
in interfaceRef
- Parameters:
obj
- anObject
representing the SQL structured type to be referenced- Throws:
SerialException
- if an error is encountered generating the the structured type referenced by thisSerialRef
object- See Also:
Ref.getObject()
,Ref.getObject(Map)
,PreparedStatement.setObject(int, Object)
,CallableStatement.setObject(String, Object)
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/sql/rowset/serial/serialref.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.