Struct

  • Struct is a Java mapping for an SQL structured type, holding a value for each attribute of the SQL type.

  • It provides methods to retrieve the SQL type name (getSQLTypeName) and the ordered attribute values (getAttributes).

  • getAttributes can customize type mappings using a provided map or the connection's type map.

  • JDBC drivers must fully implement Struct interface methods if they support the corresponding data type.
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.

All methods on the Struct interface must be fully implemented if the JDBC driver supports the data type.

Public Method Summary

abstract Object[]
getAttributes()
Produces the ordered values of the attributes of the SQL structured type that this Struct object represents.
abstract Object[]
getAttributes(Map<String, Class<?>> map)
Produces the ordered values of the attributes of the SQL structured type that this Struct object represents.
abstract String
getSQLTypeName()
Retrieves the SQL type name of the SQL structured type that this Struct object represents.

Public Methods

public abstract Object[] getAttributes ()

Produces the ordered values of the attributes of the SQL structured type that this Struct object represents. As individual attributes are processed, 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 an attribute 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 if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

public abstract Object[] getAttributes (Map<String, Class<?>> map)

Produces the ordered values of the attributes of the SQL structured type that this Struct object represents. As individual attrbutes are proccessed, 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 an attribute 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 if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

public abstract String getSQLTypeName ()

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 if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method