java.sql
Interface Struct

All Known Implementing Classes:
SerialStruct sample code for javax.sql.rowset.serial.SerialStruct definition code for javax.sql.rowset.serial.SerialStruct

public interface Struct

The standard mapping in the Java programming language for an SQL structured type. A Struct object contains a value for each attribute of the SQL structured type that it represents. By default, an instance ofStruct is valid as long as the application has a reference to it.

Since:
1.2

Method Summary
 Object sample code for java.lang.Object definition code for java.lang.Object [] getAttributes sample code for java.sql.Struct.getAttributes() definition code for java.sql.Struct.getAttributes() ()
          Produces the ordered values of the attributes of the SQL structurec type that this Struct object represents.
 Object sample code for java.lang.Object definition code for java.lang.Object [] getAttributes sample code for java.sql.Struct.getAttributes(java.util.Map) definition code for java.sql.Struct.getAttributes(java.util.Map) (Map sample code for java.util.Map definition code for java.util.Map <String sample code for java.lang.String definition code for java.lang.String ,Class sample code for java.lang.Class definition code for java.lang.Class <?>> map)
          Produces the ordered values of the attributes of the SQL structurec type that this Struct object represents.
 String sample code for java.lang.String definition code for java.lang.String getSQLTypeName sample code for java.sql.Struct.getSQLTypeName() definition code for java.sql.Struct.getSQLTypeName() ()
          Retrieves the SQL type name of the SQL structured type that this Struct object represents.
 

Method Detail

getSQLTypeName sample code for java.sql.Struct.getSQLTypeName() definition code for java.sql.Struct.getSQLTypeName()

String sample code for java.lang.String definition code for java.lang.String  getSQLTypeName()
                      throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Retrieves the SQL type name of the SQL structured type that this Struct object represents.

Returns:
the fully-qualified type name of the SQL structured type for which this Struct object is the generic representation
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

getAttributes sample code for java.sql.Struct.getAttributes() definition code for java.sql.Struct.getAttributes()

Object sample code for java.lang.Object definition code for java.lang.Object [] getAttributes()
                       throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Produces the ordered values of the attributes of the SQL structurec type that this Struct object represents. This method uses the type map associated with the connection for customizations of the type mappings. If there is no entry in the connection's type map that matches the structured type that this Struct object represents, the driver uses the standard mapping.

Conceptually, this method calls the method getObject on each attribute of the structured type and returns a Java array containing the result.

Returns:
an array containing the ordered attribute values
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

getAttributes sample code for java.sql.Struct.getAttributes(java.util.Map<java.lang.String, java.lang.Class<?>>) definition code for java.sql.Struct.getAttributes(java.util.Map<java.lang.String, java.lang.Class<?>>)

Object sample code for java.lang.Object definition code for java.lang.Object [] getAttributes(Map sample code for java.util.Map definition code for java.util.Map <String sample code for java.lang.String definition code for java.lang.String ,Class sample code for java.lang.Class definition code for java.lang.Class <?>> map)
                       throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Produces the ordered values of the attributes of the SQL structurec type that this Struct object represents. This method uses the given type map for customizations of the type mappings. If there is no entry in the given type map that matches the structured type that this Struct object represents, the driver uses the standard mapping. This method never uses the type map associated with the connection.

Conceptually, this method calls the method getObject on each attribute of the structured type and returns a Java array containing the result.

Parameters:
map - a mapping of SQL type names to Java classes
Returns:
an array containing the ordered attribute values
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs