summaryrefslogtreecommitdiff
path: root/java/sql/Struct.java
blob: 5fa3c13a0dfb20dfa459a014c19321857b52c4bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*************************************************************************
/* Struct.java -- Mapping for a SQL structured type.
/*
/* Copyright (c) 1999 Free Software Foundation, Inc.
/* Written by Aaron M. Renn (arenn@urbanophile.com)
/*
/* This library is free software; you can redistribute it and/or modify
/* it under the terms of the GNU Library General Public License as published 
/* by the Free Software Foundation, either version 2 of the License, or
/* (at your option) any later verion.
/*
/* This library is distributed in the hope that it will be useful, but
/* WITHOUT ANY WARRANTY; without even the implied warranty of
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
/* GNU Library General Public License for more details.
/*
/* You should have received a copy of the GNU Library General Public License
/* along with this library; if not, write to the Free Software Foundation
/* Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307 USA
/*************************************************************************/

package java.sql;

import java.util.Map;

/**
  * This interface implements the standard type mapping for a SQL 
  * structured type.
  *
  * @author Aaron M. Renn (arenn@urbanophile.com)
  */
public abstract interface Struct
{

/**
  * This method returns the name of the SQL structured type for this
  * object.
  *
  * @return The SQL structured type name.
  *
  * @exception SQLException If an error occurs.
  */
public abstract String
getSQLTypeName() throws SQLException;

/*************************************************************************/

/**
  * This method returns the attributes of this SQL structured type.
  *
  * @return The attributes of this structure type.
  *
  * @exception SQLException If an error occurs.
  */
public abstract Object[]
getAttributes() throws SQLException;

/*************************************************************************/

/**
  * This method returns the attributes of this SQL structured type.
  * The specified map of type mappings overrides the default mappings.
  *
  * @param map The map of SQL type mappings.
  *
  * @return The attributes of this structure type.
  *
  * @exception SQLException If a error occurs.
  */
public abstract Object[]
getAttributes(Map map) throws SQLException;

} // interface Struct