| 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 |
|
|
Interface de.tudarmstadt.ito.xmldbms.KeyGenerator
|
| 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="Package-de.tudarmstadt.ito.xmldbms.html">Next</a> <a href="AllNames.html">Index</a></pre>
|
| 14 |
|
|
<hr>
|
| 15 |
|
|
<h1>
|
| 16 |
|
|
Interface de.tudarmstadt.ito.xmldbms.KeyGenerator
|
| 17 |
|
|
</h1>
|
| 18 |
|
|
<dl>
|
| 19 |
|
|
<dt> public interface <b>KeyGenerator</b>
|
| 20 |
|
|
</dl>
|
| 21 |
|
|
Interface for a class that generates key values (object IDs).
|
| 22 |
|
|
<P>Applications that want DOMToDBMS to generate key values pass an
|
| 23 |
|
|
instance of an object that implements this class to DOMToDBMS. Keys
|
| 24 |
|
|
are used to join tables (class table-to-class table or class table-
|
| 25 |
|
|
to-property table) and also to retrieve data from root tables.
|
| 26 |
|
|
Whether DOMToDBMS generates a key for a given table (or one or more
|
| 27 |
|
|
properties are mapped to the key columns) depends on the mapping to
|
| 28 |
|
|
that table.</P>
|
| 29 |
|
|
<P>Programmers using XML-DBMS never need to call the method (generateKey)
|
| 30 |
|
|
in this interface; it is called only by DOMToDBMS. Programmers only
|
| 31 |
|
|
need to supply an object that implements this interface to DOMToDBMS if
|
| 32 |
|
|
they want DOMToDBMS to generate keys.</P>
|
| 33 |
|
|
<P>The helper class KeyGeneratorImpl provides a default implementation
|
| 34 |
|
|
of this interface.</P>
|
| 35 |
|
|
<p>
|
| 36 |
|
|
<dl>
|
| 37 |
|
|
<dt> <b>See Also:</b>
|
| 38 |
|
|
<dd> <a href="de.tudarmstadt.ito.xmldbms.helpers.KeyGeneratorImpl.html#_top_">KeyGeneratorImpl</a>
|
| 39 |
|
|
</dl>
|
| 40 |
|
|
<hr>
|
| 41 |
|
|
<a name="index"></a>
|
| 42 |
|
|
<h2>
|
| 43 |
|
|
<img src="images/method-index.gif" width=207 height=38 alt="Method Index">
|
| 44 |
|
|
</h2>
|
| 45 |
|
|
<dl>
|
| 46 |
|
|
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
|
| 47 |
|
|
<a href="#generateKey()"><b>generateKey</b></a>()
|
| 48 |
|
|
<dd> Generates a key.
|
| 49 |
|
|
</dl>
|
| 50 |
|
|
<a name="methods"></a>
|
| 51 |
|
|
<h2>
|
| 52 |
|
|
<img src="images/methods.gif" width=151 height=38 alt="Methods">
|
| 53 |
|
|
</h2>
|
| 54 |
|
|
<a name="generateKey()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
|
| 55 |
|
|
<a name="generateKey"><b>generateKey</b></a>
|
| 56 |
|
|
<pre>
|
| 57 |
|
|
public abstract Object[] generateKey() throws <a href="de.tudarmstadt.ito.xmldbms.KeyException.html#_top_">KeyException</a>
|
| 58 |
|
|
</pre>
|
| 59 |
|
|
<dl>
|
| 60 |
|
|
<dd> Generates a key.
|
| 61 |
|
|
<P>This method is called by DOMToDBMS. Programmers using DOMToDBMS
|
| 62 |
|
|
do not need to call this method.</P>
|
| 63 |
|
|
<p>
|
| 64 |
|
|
<dd><dl>
|
| 65 |
|
|
<dt> <b>Returns:</b>
|
| 66 |
|
|
<dd> The key as an array of Objects.
|
| 67 |
|
|
<dt> <b>Throws:</b> <a href="de.tudarmstadt.ito.xmldbms.KeyException.html#_top_">KeyException</a>
|
| 68 |
|
|
<dd> An error occured while generating the key.
|
| 69 |
|
|
</dl></dd>
|
| 70 |
|
|
</dl>
|
| 71 |
|
|
<hr>
|
| 72 |
|
|
<pre>
|
| 73 |
|
|
<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="Package-de.tudarmstadt.ito.xmldbms.html">Next</a> <a href="AllNames.html">Index</a></pre>
|
| 74 |
|
|
</body>
|
| 75 |
|
|
</html>
|