added in API level 1

Struct

public interface Struct

java.sql.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.

Summary

Public methods

abstract Object[] getAttributes()

Produces the ordered values of the attributes of the SQL structured type that this Struct object represents.

abstract Object[] getAttributes(Map<StringClass<?>> 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

getAttributes

added in API level 1
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
Object[] 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

getAttributes

added in API level 1
public abstract Object[] getAttributes (Map<StringClass<?>> 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 Map: a mapping of SQL type names to Java classes

Returns
Object[] 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

getSQLTypeName

added in API level 1
public abstract String getSQLTypeName ()

Retrieves the SQL type name of the SQL structured type that this Struct object represents.

Returns
String 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