Java Doc for Ref.java in  » 6.0-JDK-Core » sql » java » sql » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » sql » java.sql 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.sql.Ref

All known Subclasses:   javax.sql.rowset.serial.SerialRef,
Ref
public interface Ref (Code)
The mapping in the Java programming language of an SQL REF value, which is a reference to an SQL structured type value in the database.

SQL REF values are stored in a table that contains instances of a referenceable SQL structured type, and each REF value is a unique identifier for one instance in that table. An SQL REF value may be used in place of the SQL structured type it references, either as a column value in a table or an attribute value in a structured type.

Because an SQL REF value is a logical pointer to an SQL structured type, a Ref object is by default also a logical pointer. Thus, retrieving an SQL REF value as a Ref object does not materialize the attributes of the structured type on the client.

A Ref object can be stored in the database using the PreparedStatement.setRef method.

All methods on the Ref interface must be fully implemented if the JDBC driver supports the data type.
See Also:   Struct
since:
   1.2





Method Summary
 StringgetBaseTypeName()
     Retrieves the fully-qualified SQL name of the SQL structured type that this Ref object references.
 ObjectgetObject(java.util.Map<String, Class<?>> map)
     Retrieves the referenced object and maps it to a Java type using the given type map.
 ObjectgetObject()
     Retrieves the SQL structured type instance referenced by this Ref object.
 voidsetObject(Object value)
     Sets the structured type value that this Ref object references to the given instance of Object.



Method Detail
getBaseTypeName
String getBaseTypeName() throws SQLException(Code)
Retrieves the fully-qualified SQL name of the SQL structured type that this Ref object references. the fully-qualified SQL name of the referenced SQL structured type
exception:
  SQLException - if a database access error occurs
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.2


getObject
Object getObject(java.util.Map<String, Class<?>> map) throws SQLException(Code)
Retrieves the referenced object and maps it to a Java type using the given type map.
Parameters:
  map - a java.util.Map object that contains the mapping to use (the fully-qualified name of the SQLstructured type being referenced and the class object forSQLData implementation to which the SQLstructured type will be mapped) a Java Object that is the custom mapping for the SQL structured type to which this Refobject refers
exception:
  SQLException - if a database access error occurs
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.4
See Also:   Ref.setObject


getObject
Object getObject() throws SQLException(Code)
Retrieves the SQL structured type instance referenced by this Ref object. If the connection's type map has an entry for the structured type, the instance will be custom mapped to the Java class indicated in the type map. Otherwise, the structured type instance will be mapped to a Struct object. a Java Object that is the mapping for the SQL structured type to which this Refobject refers
exception:
  SQLException - if a database access error occurs
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.4
See Also:   Ref.setObject


setObject
void setObject(Object value) throws SQLException(Code)
Sets the structured type value that this Ref object references to the given instance of Object. The driver converts this to an SQL structured type when it sends it to the database.
Parameters:
  value - an Object representing the SQL structured type instance that thisRef object will reference
exception:
  SQLException - if a database access error occurs
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.4
See Also:   Ref.getObject()
See Also:   Ref.getObject(Map)
See Also:   PreparedStatement.setObject(intObject)
See Also:   CallableStatement.setObject(StringObject)


www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.