1
/* SQLData.java -- Custom mapping for a user defined datatype
2
Copyright (C) 1999, 2000 Free Software Foundation, Inc.
4
This file is part of GNU Classpath.
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)
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.
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., 59 Temple Place, Suite 330, Boston, MA
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
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. */
42
* This interface is used for mapping SQL data to user defined datatypes.
44
* @author Aaron M. Renn (arenn@urbanophile.com)
46
public interface SQLData
50
* This method returns the user defined datatype name for this object.
52
* @return The user defined data type name for this object.
54
* @exception SQLException If an error occurs.
56
public abstract String
57
getSQLTypeName() throws SQLException;
59
/*************************************************************************/
62
* This method populates the data in the object from the specified stream.
64
* @param stream The stream to read the data from.
65
* @param name The data type name of the data on the stream.
67
* @exception SQLException If an error occurs.
70
readSQL(SQLInput stream, String name) throws SQLException;
72
/*************************************************************************/
75
* This method writes the data in this object to the specified stream.
77
* @param stream The stream to write the data to.
79
* @exception SQLException If an error occurs.
82
writeSQL(SQLOutput stream) throws SQLException;
84
} // interface SQLData