Struct (Java 2 Platform SE 5.0) (original) (raw)

java.sql

Interface Struct

All Known Implementing Classes:

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

Method Detail

getSQLTypeName

String getSQLTypeName() throws 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](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

getAttributes

Object[] getAttributes() throws 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 methodgetObject 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](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

getAttributes

Object[] getAttributes(Map<String,Class<?>> map) throws 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 methodgetObject 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](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.