1: /* Struct.java -- Mapping for a SQL structured type. 2: Copyright (C) 1999, 2000, 2002 Free Software Foundation, Inc. 3: 4: This file is part of GNU Classpath. 5: 6: GNU Classpath is free software; you can redistribute it and/or modify 7: it under the terms of the GNU General Public License as published by 8: the Free Software Foundation; either version 2, or (at your option) 9: any later version. 10: 11: GNU Classpath is distributed in the hope that it will be useful, but 12: WITHOUT ANY WARRANTY; without even the implied warranty of 13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14: General Public License for more details. 15: 16: You should have received a copy of the GNU General Public License 17: along with GNU Classpath; see the file COPYING. If not, write to the 18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19: 02110-1301 USA. 20: 21: Linking this library statically or dynamically with other modules is 22: making a combined work based on this library. Thus, the terms and 23: conditions of the GNU General Public License cover the whole 24: combination. 25: 26: As a special exception, the copyright holders of this library give you 27: permission to link this library with independent modules to produce an 28: executable, regardless of the license terms of these independent 29: modules, and to copy and distribute the resulting executable under 30: terms of your choice, provided that you also meet, for each linked 31: independent module, the terms and conditions of the license of that 32: module. An independent module is a module which is not derived from 33: or based on this library. If you modify this library, you may extend 34: this exception to your version of the library, but you are not 35: obligated to do so. If you do not wish to do so, delete this 36: exception statement from your version. */ 37: 38: 39: package java.sql; 40: 41: import java.util.Map; 42: 43: /** 44: * This interface implements the standard type mapping for a SQL 45: * structured type. 46: * 47: * @author Aaron M. Renn (arenn@urbanophile.com) 48: */ 49: public interface Struct 50: { 51: /** 52: * This method returns the name of the SQL structured type for this 53: * object. 54: * 55: * @return The SQL structured type name. 56: * @exception SQLException If an error occurs. 57: */ 58: String getSQLTypeName() throws SQLException; 59: 60: /** 61: * This method returns the attributes of this SQL structured type. 62: * 63: * @return The attributes of this structure type. 64: * @exception SQLException If an error occurs. 65: */ 66: Object[] getAttributes() throws SQLException; 67: 68: /** 69: * This method returns the attributes of this SQL structured type. 70: * The specified map of type mappings overrides the default mappings. 71: * 72: * @param map The map of SQL type mappings. 73: * @return The attributes of this structure type. 74: * @exception SQLException If a error occurs. 75: */ 76: Object[] getAttributes(Map<String, Class<?>> map) throws SQLException; 77: }