Project

General

Profile

1 14 jones
<!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.ClassMap
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="Package-de.tudarmstadt.ito.xmldbms.html">Previous</a>  <a href="de.tudarmstadt.ito.xmldbms.Column.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
14
<hr>
15
<h1>
16
  Class de.tudarmstadt.ito.xmldbms.ClassMap
17
</h1>
18
<pre>
19
java.lang.Object
20
   |
21
   +----de.tudarmstadt.ito.xmldbms.ClassMap
22
</pre>
23
<hr>
24
<dl>
25
  <dt> public class <b>ClassMap</b>
26
  <dt> extends Object
27
</dl>
28
Maps an element type as a class; <A HREF="../readme.html#NotForUse">not for
29
 general use</A>.
30
 <P>ClassMap contains information about an element type-as-class:
31
 how it is mapped, what table it is mapped to, maps for attributes,
32
 PCDATA, and child element types, etc. ClassMaps
33
 are stored in RootClassMaps and RelatedClassMaps, which are
34
 accessed through hash tables keyed by element type name.</P>
35
<p>
36
<hr>
37
<a name="index"></a>
38
<h2>
39
  <img src="images/variable-index.gif" width=207 height=38 alt="Variable Index">
40
</h2>
41
<dl>
42
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
43
	<a href="#attributeMaps"><b>attributeMaps</b></a>
44
  <dd>  A Hashtable containing PropertyMaps for attributes.
45
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
46
	<a href="#name"><b>name</b></a>
47
  <dd>  Name of the class (element type).
48
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
49
	<a href="#pcdataMap"><b>pcdataMap</b></a>
50
  <dd>  The PropertyMap for the PCDATA.
51
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
52
	<a href="#subElementTypeMaps"><b>subElementTypeMaps</b></a>
53
  <dd>  A Hashtable containing maps for child element types.
54
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
55
	<a href="#table"><b>table</b></a>
56
  <dd>  The table to which the class is mapped.
57
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
58
	<a href="#type"><b>type</b></a>
59
  <dd>  How the class is mapped: to a root table, to a class table,
60
 ignored, or passed-through.
61
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
62
	<a href="#TYPE_IGNOREROOT"><b>TYPE_IGNOREROOT</b></a>
63
  <dd> Ignore the element type.
64
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
65
	<a href="#TYPE_PASSTHROUGH"><b>TYPE_PASSTHROUGH</b></a>
66
  <dd> Map the element type as pass-through; not implemented yet.
67
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
68
	<a href="#TYPE_TOCLASSTABLE"><b>TYPE_TOCLASSTABLE</b></a>
69
  <dd> Map the element type to a class table.
70
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
71
	<a href="#TYPE_TOROOTTABLE"><b>TYPE_TOROOTTABLE</b></a>
72
  <dd> Map the element type to a root table.
73
</dl>
74
<h2>
75
  <img src="images/constructor-index.gif" width=275 height=38 alt="Constructor Index">
76
</h2>
77
<dl>
78
  <dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
79
	<a href="#ClassMap()"><b>ClassMap</b></a>()
80
  <dd>  Construct a ClassMap.
81
</dl>
82
<h2>
83
  <img src="images/method-index.gif" width=207 height=38 alt="Method Index">
84
</h2>
85
<dl>
86
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
87
	<a href="#getAttributeMap(java.lang.String)"><b>getAttributeMap</b></a>(String)
88
  <dd>  Get a map for an attribute.
89
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
90
	<a href="#getElementTypeMap(java.lang.String)"><b>getElementTypeMap</b></a>(String)
91
  <dd>  Get a map for a child element.
92
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
93
	<a href="#getPCDATAMap()"><b>getPCDATAMap</b></a>()
94
  <dd>  Get a map for PCDATA.
95
</dl>
96
<a name="variables"></a>
97
<h2>
98
  <img src="images/variables.gif" width=153 height=38 alt="Variables">
99
</h2>
100
<a name="TYPE_TOROOTTABLE"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
101
<b>TYPE_TOROOTTABLE</b>
102
<pre>
103
 public static final int TYPE_TOROOTTABLE
104
</pre>
105
<dl>
106
  <dd> Map the element type to a root table.<p>
107
</dl>
108
<a name="TYPE_TOCLASSTABLE"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
109
<b>TYPE_TOCLASSTABLE</b>
110
<pre>
111
 public static final int TYPE_TOCLASSTABLE
112
</pre>
113
<dl>
114
  <dd> Map the element type to a class table.<p>
115
</dl>
116
<a name="TYPE_IGNOREROOT"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
117
<b>TYPE_IGNOREROOT</b>
118
<pre>
119
 public static final int TYPE_IGNOREROOT
120
</pre>
121
<dl>
122
  <dd> Ignore the element type.<p>
123
</dl>
124
<a name="TYPE_PASSTHROUGH"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
125
<b>TYPE_PASSTHROUGH</b>
126
<pre>
127
 public static final int TYPE_PASSTHROUGH
128
</pre>
129
<dl>
130
  <dd> Map the element type as pass-through; not implemented yet.<p>
131
</dl>
132
<a name="name"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
133
<b>name</b>
134
<pre>
135
 public <a href="de.tudarmstadt.ito.utils.NSName.html#_top_">NSName</a> name
136
</pre>
137
<dl>
138
  <dd> Name of the class (element type). This name includes full namespace
139
 information.<p>
140
</dl>
141
<a name="type"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
142
<b>type</b>
143
<pre>
144
 public int type
145
</pre>
146
<dl>
147
  <dd> How the class is mapped: to a root table, to a class table,
148
 ignored, or passed-through.<p>
149
</dl>
150
<a name="table"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
151
<b>table</b>
152
<pre>
153
 public <a href="de.tudarmstadt.ito.xmldbms.Table.html#_top_">Table</a> table
154
</pre>
155
<dl>
156
  <dd> The table to which the class is mapped. Null if the class is
157
 ignored or passed through.<p>
158
</dl>
159
<a name="attributeMaps"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
160
<b>attributeMaps</b>
161
<pre>
162
 public Hashtable attributeMaps
163
</pre>
164
<dl>
165
  <dd> A Hashtable containing PropertyMaps for attributes. The Hashtable
166
 is keyed by the namespace-qualified attribute name. Null if no
167
 attributes are mapped.<p>
168
</dl>
169
<a name="pcdataMap"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
170
<b>pcdataMap</b>
171
<pre>
172
 public <a href="de.tudarmstadt.ito.xmldbms.PropertyMap.html#_top_">PropertyMap</a> pcdataMap
173
</pre>
174
<dl>
175
  <dd> The PropertyMap for the PCDATA. Null if the PCDATA is not mapped.<p>
176
</dl>
177
<a name="subElementTypeMaps"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
178
<b>subElementTypeMaps</b>
179
<pre>
180
 public Hashtable subElementTypeMaps
181
</pre>
182
<dl>
183
  <dd> A Hashtable containing maps for child element types. The Hashtable
184
 is keyed by the namespace-qualified element type name. It can
185
 contain RelatedClassMaps (for child element types-as-classes) or
186
 PropertyMaps (for child element types-as-properties). In the
187
 future, it will also contain PassThroughMaps (for passed-through
188
 child element types). Null if no child element types are mapped.<p>
189
</dl>
190
<a name="constructors"></a>
191
<h2>
192
  <img src="images/constructors.gif" width=231 height=38 alt="Constructors">
193
</h2>
194
<a name="ClassMap"></a>
195
<a name="ClassMap()"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
196
<b>ClassMap</b>
197
<pre>
198
 public ClassMap()
199
</pre>
200
<dl>
201
  <dd> Construct a ClassMap.
202
<p>
203
</dl>
204
<a name="methods"></a>
205
<h2>
206
  <img src="images/methods.gif" width=151 height=38 alt="Methods">
207
</h2>
208
<a name="getPCDATAMap()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
209
<a name="getPCDATAMap"><b>getPCDATAMap</b></a>
210
<pre>
211
 public <a href="de.tudarmstadt.ito.xmldbms.PropertyMap.html#_top_">PropertyMap</a> getPCDATAMap()
212
</pre>
213
<dl>
214
  <dd> Get a map for PCDATA.
215
<p>
216
  <dd><dl>
217
    <dt> <b>Returns:</b>
218
    <dd> The PropertyMap for the class' PCDATA. Null if the PCDATA
219
  is not mapped.
220
  </dl></dd>
221
</dl>
222
<a name="getElementTypeMap(java.lang.String)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
223
<a name="getElementTypeMap"><b>getElementTypeMap</b></a>
224
<pre>
225
 public Object getElementTypeMap(String qualifiedElementName)
226
</pre>
227
<dl>
228
  <dd> Get a map for a child element.
229
<p>
230
  <dd><dl>
231
    <dt> <b>Parameters:</b>
232
    <dd> qualifiedElementName - The namespace-qualified name of the
233
  element.
234
    <dt> <b>Returns:</b>
235
    <dd> A PropertyMap (for element type-as-property children) or
236
  RelatedClassMap (for element type-as-class children). Null if the
237
  child element is not mapped.
238
  </dl></dd>
239
</dl>
240
<a name="getAttributeMap(java.lang.String)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
241
<a name="getAttributeMap"><b>getAttributeMap</b></a>
242
<pre>
243
 public <a href="de.tudarmstadt.ito.xmldbms.PropertyMap.html#_top_">PropertyMap</a> getAttributeMap(String qualifiedAttrName)
244
</pre>
245
<dl>
246
  <dd> Get a map for an attribute.
247
<p>
248
  <dd><dl>
249
    <dt> <b>Parameters:</b>
250
    <dd> qualifiedAttrName - The namespace-qualified name of the
251
  attribute.
252
    <dt> <b>Returns:</b>
253
    <dd> A PropertyMap for the attribute. Null if the attribute
254
  is not mapped.
255
  </dl></dd>
256
</dl>
257
<hr>
258
<pre>
259
<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="Package-de.tudarmstadt.ito.xmldbms.html">Previous</a>  <a href="de.tudarmstadt.ito.xmldbms.Column.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
260
</body>
261
</html>