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.LinkInfo
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.DocumentInfo.html#_top_">Previous</a>  <a href="de.tudarmstadt.ito.xmldbms.Map.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
14
<hr>
15
<h1>
16
  Class de.tudarmstadt.ito.xmldbms.LinkInfo
17
</h1>
18
<pre>
19
java.lang.Object
20
   |
21
   +----de.tudarmstadt.ito.xmldbms.LinkInfo
22
</pre>
23
<hr>
24
<dl>
25
  <dt> public class <b>LinkInfo</b>
26
  <dt> extends Object
27
</dl>
28
Provides information needed to link two tables;
29
  <A HREF="../readme.html#NotForUse">not for general use</A>.
30
 <P>LinkInfo contains contains the information needed to link two tables:
31
 the columns in each key, whether to generate the key, and which key appears
32
 in which table. LinkInfo structures occur in RelatedClassMaps and
33
 PropertyMaps to link the class table to the related class table or property
34
 table. They also occur in RootClassMaps, where only the child key information
35
 is used.</P>
36
 <P>&quot;Parent&quot; and &quot;child&quot; refer to the relationship between
37
 the structures in the XML document, not the relationship between two tables
38
 in the database. In a class / property relationship, such as between an
39
 element type-as-class and an element type-as-property, PCDATA, or attribute,
40
 the class is always the parent. In a class / class relationship, such as
41
 that between two element types-as-classes and mapped by a ClassMap and its
42
 subordinate RelatedClassMaps, the class referred to in the ClassMap is
43
 always the parent and the class referred to in the RelatedClassMap is always
44
 the child.</P>
45
 <P>Note that the parent / child relationship is independent of where the
46
 candidate key is located. That is, it could be in the table of the parent
47
 or the child. Which table it is in is stated by the parentKeyIsCandidate
48
 member variable.</P>
49
<p>
50
<hr>
51
<a name="index"></a>
52
<h2>
53
  <img src="images/variable-index.gif" width=207 height=38 alt="Variable Index">
54
</h2>
55
<dl>
56
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
57
	<a href="#childKey"><b>childKey</b></a>
58
  <dd> Columns in the child key.
59
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
60
	<a href="#generateKey"><b>generateKey</b></a>
61
  <dd> Whether the candidate key is to be generated.
62
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
63
	<a href="#parentKey"><b>parentKey</b></a>
64
  <dd> Columns in the parent key.
65
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
66
	<a href="#parentKeyIsCandidate"><b>parentKeyIsCandidate</b></a>
67
  <dd> Whether the parent key is the candidate key.
68
</dl>
69
<h2>
70
  <img src="images/constructor-index.gif" width=275 height=38 alt="Constructor Index">
71
</h2>
72
<dl>
73
  <dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
74
	<a href="#LinkInfo()"><b>LinkInfo</b></a>()
75
  <dd>
76
</dl>
77
<a name="variables"></a>
78
<h2>
79
  <img src="images/variables.gif" width=153 height=38 alt="Variables">
80
</h2>
81
<a name="parentKey"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
82
<b>parentKey</b>
83
<pre>
84
 public <a href="de.tudarmstadt.ito.xmldbms.Column.html#_top_">Column</a> parentKey[]
85
</pre>
86
<dl>
87
  <dd> Columns in the parent key.<p>
88
</dl>
89
<a name="childKey"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
90
<b>childKey</b>
91
<pre>
92
 public <a href="de.tudarmstadt.ito.xmldbms.Column.html#_top_">Column</a> childKey[]
93
</pre>
94
<dl>
95
  <dd> Columns in the child key.<p>
96
</dl>
97
<a name="generateKey"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
98
<b>generateKey</b>
99
<pre>
100
 public boolean generateKey
101
</pre>
102
<dl>
103
  <dd> Whether the candidate key is to be generated.<p>
104
</dl>
105
<a name="parentKeyIsCandidate"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
106
<b>parentKeyIsCandidate</b>
107
<pre>
108
 public boolean parentKeyIsCandidate
109
</pre>
110
<dl>
111
  <dd> Whether the parent key is the candidate key.<p>
112
</dl>
113
<a name="constructors"></a>
114
<h2>
115
  <img src="images/constructors.gif" width=231 height=38 alt="Constructors">
116
</h2>
117
<a name="LinkInfo"></a>
118
<a name="LinkInfo()"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
119
<b>LinkInfo</b>
120
<pre>
121
 public LinkInfo()
122
</pre>
123
<hr>
124
<pre>
125
<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.DocumentInfo.html#_top_">Previous</a>  <a href="de.tudarmstadt.ito.xmldbms.Map.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
126
</body>
127
</html>