Interface Struct
-
- All Known Implementing Classes:
- SerialStruct
public interface StructThe standard mapping in the Java programming language for an SQL structured type. A
Structobject contains a value for each attribute of the SQL structured type that it represents. By default, an instance ofStructis valid as long as the application has a reference to it.All methods on the
Structinterface must be fully implemented if the JDBC driver supports the data type.- Since:
- 1.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description Object[]getAttributes()Produces the ordered values of the attributes of the SQL structured type that thisStructobject represents.Object[]getAttributes(Map<String,Class<?>> map)Produces the ordered values of the attributes of the SQL structured type that thisStructobject represents.StringgetSQLTypeName()Retrieves the SQL type name of the SQL structured type that thisStructobject represents.
-
-
-
Method Detail
getSQLTypeName
String getSQLTypeName() throws SQLException
Retrieves the SQL type name of the SQL structured type that thisStructobject represents.- Returns:
-
the fully-qualified type name of the SQL structured type for which this
Structobject is the generic representation - Throws:
-
SQLException- if a database access error occurs -
SQLFeatureNotSupportedException- if the JDBC driver does not support this method - Since:
- 1.2
getAttributes
Object[] getAttributes() throws SQLException
Produces the ordered values of the attributes of the SQL structured type that thisStructobject 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
getObjecton 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 - Since:
- 1.2
getAttributes
Object[] getAttributes(Map<String,Class<?>> map) throws SQLException
Produces the ordered values of the attributes of the SQL structured type that thisStructobject represents. As individual attributes are processed, 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
getObjecton 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 - Since:
- 1.2
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
