1f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes/* 2adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 3adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 4adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this work for additional information regarding copyright ownership. 5adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 6adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * (the "License"); you may not use this file except in compliance with 7adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the License. You may obtain a copy of the License at 8f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 9adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 10f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 11adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Unless required by applicable law or agreed to in writing, software 12adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 13adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * See the License for the specific language governing permissions and 15adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * limitations under the License. 16adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 17adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 18adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpackage java.sql; 19adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 20adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.util.Map; 21adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 22adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/** 23f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * An interface which provides facilities for manipulating an SQL structured type 24adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * as a Java object. The {@code Struct} object has a value for each attribute of the SQL structured 25adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * type. 26adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 27adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpublic interface Struct { 28adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 29adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 30adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Gets the SQL Type name of the SQL structured type that this {@code 31adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Struct} represents. 32f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 33adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the fully qualified name of SQL structured type. 34adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws SQLException 35adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if a database error occurs. 36adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 37adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String getSQLTypeName() throws SQLException; 38adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 39adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 40adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Gets the values of the attributes of this SQL structured type. This 41adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * method uses the type map associated with the {@link Connection} for 42adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * customized type mappings. Where there is no entry in the type mapping 43adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * which matches this structured type, the JDBC driver uses the standard 44adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * mapping. 45f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 46adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return an {@code Object} array containing the ordered attributes. 47adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws SQLException 48adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if a database error occurs. 49adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 50adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public Object[] getAttributes() throws SQLException; 51adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 52adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 53adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Gets the values of the attributes of this SQL structured type. This 54adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * method uses the supplied type mapping to determine how to map SQL types 55adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * to their corresponding Java objects. In the 56adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * case where there is no entry in the type mapping which matches this 57adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * structured type, the JDBC driver uses the default mapping. The {@code 58adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Connection} type map is <i>never</i> utilized by this method. 59f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 60adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param theMap 61adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * a Map describing how SQL Type names are mapped to classes. 62adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return an Object array containing the ordered attributes,. 63adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws SQLException 64adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if a database error occurs. 65adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 66adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public Object[] getAttributes(Map<String, Class<?>> theMap) 67adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throws SQLException; 68adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project} 69