Project

General

Profile

1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
2
<!--NewPage-->
3
<html>
4
<head>
5
<!-- Generated by javadoc on Fri Sep 24 03:23:03 CEST 1999 -->
6
<title>
7
  Class de.tudarmstadt.ito.xmldbms.TableMap
8
</title>
9
</head>
10
<body>
11
<a name="_top_"></a>
12
<pre>
13
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-de.tudarmstadt.ito.xmldbms.html">This Package</a>  <a href="de.tudarmstadt.ito.xmldbms.Table.html#_top_">Previous</a>  <a href="Package-de.tudarmstadt.ito.xmldbms.html">Next</a>  <a href="AllNames.html">Index</a></pre>
14
<hr>
15
<h1>
16
  Class de.tudarmstadt.ito.xmldbms.TableMap
17
</h1>
18
<pre>
19
java.lang.Object
20
   |
21
   +----de.tudarmstadt.ito.xmldbms.TableMap
22
</pre>
23
<hr>
24
<dl>
25
  <dt> public class <b>TableMap</b>
26
  <dt> extends Object
27
</dl>
28
Maps a table to a class or property; <A HREF="../readme.html#NotForUse">
29
 not for general use</A>.
30
 <P>TableMaps contain all the information necessary to map a table to
31
 a class or property: table information, class (element type) name,
32
 column maps, information about related tables, and so on. Note that
33
 the arrays containing information about related tables (relatedTables,
34
 parentKeyIsCandidate, parentKeys, childKeys, and orderColumns) are read
35
 in parallel and must contain the same number of entries in the same
36
 order.</P>
37
 <P>TableMaps are stored in an array in the Map class and in the
38
 relatedTableMaps hash table in TableMap, which is keyed by table name.</P>
39
<p>
40
<hr>
41
<a name="index"></a>
42
<h2>
43
  <img src="images/variable-index.gif" width=207 height=38 alt="Variable Index">
44
</h2>
45
<dl>
46
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
47
	<a href="#childKeys"><b>childKeys</b></a>
48
  <dd>  An array containing the Columns in each child key used to join the
49
 parent table to the child table (see parentKeyIsCandidate).
50
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
51
	<a href="#columnMaps"><b>columnMaps</b></a>
52
  <dd>  ColumnMaps for each column in the table.
53
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
54
	<a href="#elementType"><b>elementType</b></a>
55
  <dd>  Unprefixed name of the element type to which a class table is
56
 mapped.
57
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
58
	<a href="#orderColumns"><b>orderColumns</b></a>
59
  <dd>  An array containing order Columns and/or nulls.
60
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
61
	<a href="#parentKeyIsCandidate"><b>parentKeyIsCandidate</b></a>
62
  <dd>  An array stating whether the parent table or the child table contains
63
 the candidate key.
64
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
65
	<a href="#parentKeys"><b>parentKeys</b></a>
66
  <dd>  An array containing the Columns in each parent key used to join the
67
 parent table to each child table (see parentKeyIsCandidate).
68
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
69
	<a href="#prefixedElementType"><b>prefixedElementType</b></a>
70
  <dd>  Prefixed name of the element type to which a class table is
71
 mapped.
72
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
73
	<a href="#relatedTables"><b>relatedTables</b></a>
74
  <dd>  An array containing a TableMap for each related property table or
75
 class table.
76
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
77
	<a href="#table"><b>table</b></a>
78
  <dd> Table object of the mapped table.
79
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
80
	<a href="#type"><b>type</b></a>
81
  <dd>  What the table is mapped to: TYPE_CLASSTABLE or TYPE_PROPERTYTABLE.
82
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
83
	<a href="#TYPE_CLASSTABLE"><b>TYPE_CLASSTABLE</b></a>
84
  <dd> Map the table to a class.
85
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
86
	<a href="#TYPE_PROPERTYTABLE"><b>TYPE_PROPERTYTABLE</b></a>
87
  <dd> Map the table to a property.
88
</dl>
89
<h2>
90
  <img src="images/constructor-index.gif" width=275 height=38 alt="Constructor Index">
91
</h2>
92
<dl>
93
  <dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
94
	<a href="#TableMap()"><b>TableMap</b></a>()
95
  <dd> Construct a TableMap.
96
  <dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
97
	<a href="#TableMap(de.tudarmstadt.ito.xmldbms.Table, int, java.lang.String, java.lang.String, de.tudarmstadt.ito.xmldbms.ColumnMap[], int)"><b>TableMap</b></a>(Table, int, String, String, ColumnMap[], int)
98
  <dd> Construct and initialize a TableMap.
99
</dl>
100
<a name="variables"></a>
101
<h2>
102
  <img src="images/variables.gif" width=153 height=38 alt="Variables">
103
</h2>
104
<a name="TYPE_CLASSTABLE"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
105
<b>TYPE_CLASSTABLE</b>
106
<pre>
107
 public static final int TYPE_CLASSTABLE
108
</pre>
109
<dl>
110
  <dd> Map the table to a class.<p>
111
</dl>
112
<a name="TYPE_PROPERTYTABLE"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
113
<b>TYPE_PROPERTYTABLE</b>
114
<pre>
115
 public static final int TYPE_PROPERTYTABLE
116
</pre>
117
<dl>
118
  <dd> Map the table to a property.<p>
119
</dl>
120
<a name="table"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
121
<b>table</b>
122
<pre>
123
 public <a href="de.tudarmstadt.ito.xmldbms.Table.html#_top_">Table</a> table
124
</pre>
125
<dl>
126
  <dd> Table object of the mapped table.<p>
127
</dl>
128
<a name="type"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
129
<b>type</b>
130
<pre>
131
 public int type
132
</pre>
133
<dl>
134
  <dd> What the table is mapped to: TYPE_CLASSTABLE or TYPE_PROPERTYTABLE.<p>
135
</dl>
136
<a name="elementType"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
137
<b>elementType</b>
138
<pre>
139
 public String elementType
140
</pre>
141
<dl>
142
  <dd> Unprefixed name of the element type to which a class table is
143
 mapped. Null if the table is mapped to a property. In the future,
144
 this and prefixedElementType should probably be replaced by an NSName.<p>
145
  <dd><dl> 
146
    <dt> <b>See Also:</b>
147
    <dd> <a href="de.tudarmstadt.ito.xmldbms.DBMSToDOM.html#usePrefixes(boolean)">usePrefixes</a>
148
  </dl></dd>
149
</dl>
150
<a name="prefixedElementType"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
151
<b>prefixedElementType</b>
152
<pre>
153
 public String prefixedElementType
154
</pre>
155
<dl>
156
  <dd> Prefixed name of the element type to which a class table is
157
 mapped. Null if the table is mapped to a property. In the future,
158
 this and elementType should probably be replaced by an NSName.<p>
159
  <dd><dl> 
160
    <dt> <b>See Also:</b>
161
    <dd> <a href="de.tudarmstadt.ito.xmldbms.DBMSToDOM.html#usePrefixes(boolean)">usePrefixes</a>
162
  </dl></dd>
163
</dl>
164
<a name="columnMaps"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
165
<b>columnMaps</b>
166
<pre>
167
 public <a href="de.tudarmstadt.ito.xmldbms.ColumnMap.html#_top_">ColumnMap</a> columnMaps[]
168
</pre>
169
<dl>
170
  <dd> ColumnMaps for each column in the table.
171
 <P>These must be ordered such that all columns mapped to element types
172
 occur before any columns mapped to attributes of these elements or
173
 PCDATA. This guarantees that, when retrieving data from the database,
174
 the desired element will be available when the attribute column is
175
 processed.</P>
176
 <P>A table mapped to a property can contain only one ColumnMap -- that of
177
 the column containing the property. In the future, if we allow attributes
178
 of element types-as-properties to be stored, then one column map of the
179
 property table would map to an element type and all other column maps
180
 would map to attributes of that element type.</P><p>
181
</dl>
182
<a name="relatedTables"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
183
<b>relatedTables</b>
184
<pre>
185
 public <a href="#_top_">TableMap</a> relatedTables[]
186
</pre>
187
<dl>
188
  <dd> An array containing a TableMap for each related property table or
189
 class table.<p>
190
</dl>
191
<a name="parentKeyIsCandidate"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
192
<b>parentKeyIsCandidate</b>
193
<pre>
194
 public boolean parentKeyIsCandidate[]
195
</pre>
196
<dl>
197
  <dd> An array stating whether the parent table or the child table contains
198
 the candidate key. The parent table is the table described in this
199
 TableMap; the child table is the table described in the TableMap in
200
 relatedTables. The array must match relatedTables in size and order.<p>
201
</dl>
202
<a name="parentKeys"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
203
<b>parentKeys</b>
204
<pre>
205
 public <a href="de.tudarmstadt.ito.xmldbms.Column.html#_top_">Column</a> parentKeys[][]
206
</pre>
207
<dl>
208
  <dd> An array containing the Columns in each parent key used to join the
209
 parent table to each child table (see parentKeyIsCandidate). The
210
 outer array must match relatedTables in size and order.<p>
211
</dl>
212
<a name="childKeys"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
213
<b>childKeys</b>
214
<pre>
215
 public <a href="de.tudarmstadt.ito.xmldbms.Column.html#_top_">Column</a> childKeys[][]
216
</pre>
217
<dl>
218
  <dd> An array containing the Columns in each child key used to join the
219
 parent table to the child table (see parentKeyIsCandidate). The
220
 outer array must match relatedTables in size and order.<p>
221
</dl>
222
<a name="orderColumns"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
223
<b>orderColumns</b>
224
<pre>
225
 public <a href="de.tudarmstadt.ito.xmldbms.Column.html#_top_">Column</a> orderColumns[]
226
</pre>
227
<dl>
228
  <dd> An array containing order Columns and/or nulls. For related class
229
 tables, an entry can be a Column that describes the order in which
230
 the class elements are to be created in the parent element or null
231
 if there is no such column. For related property tables, an entry
232
 is always null, as property order information is stored in the
233
 ColumnMap for the column corresponding to the property.<p>
234
</dl>
235
<a name="constructors"></a>
236
<h2>
237
  <img src="images/constructors.gif" width=231 height=38 alt="Constructors">
238
</h2>
239
<a name="TableMap"></a>
240
<a name="TableMap()"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
241
<b>TableMap</b>
242
<pre>
243
 public TableMap()
244
</pre>
245
<dl>
246
  <dd> Construct a TableMap.
247
<p>
248
</dl>
249
<a name="TableMap(de.tudarmstadt.ito.xmldbms.Table, int, java.lang.String, java.lang.String, de.tudarmstadt.ito.xmldbms.ColumnMap[], int)"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
250
<b>TableMap</b>
251
<pre>
252
 public TableMap(<a href="de.tudarmstadt.ito.xmldbms.Table.html#_top_">Table</a> table,
253
                 int type,
254
                 String elementType,
255
                 String prefixedElementType,
256
                 <a href="de.tudarmstadt.ito.xmldbms.ColumnMap.html#_top_">ColumnMap</a> columnMaps[],
257
                 int numRelatedTables)
258
</pre>
259
<dl>
260
  <dd> Construct and initialize a TableMap.
261
<p>
262
</dl>
263
<hr>
264
<pre>
265
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-de.tudarmstadt.ito.xmldbms.html">This Package</a>  <a href="de.tudarmstadt.ito.xmldbms.Table.html#_top_">Previous</a>  <a href="Package-de.tudarmstadt.ito.xmldbms.html">Next</a>  <a href="AllNames.html">Index</a></pre>
266
</body>
267
</html>
(66-66/72)