| 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.DocumentInfo
|
| 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.DOMToDBMS.html#_top_">Previous</a> <a href="de.tudarmstadt.ito.xmldbms.LinkInfo.html#_top_">Next</a> <a href="AllNames.html">Index</a></pre>
|
| 14 |
|
|
<hr>
|
| 15 |
|
|
<h1>
|
| 16 |
|
|
Class de.tudarmstadt.ito.xmldbms.DocumentInfo
|
| 17 |
|
|
</h1>
|
| 18 |
|
|
<pre>
|
| 19 |
|
|
java.lang.Object
|
| 20 |
|
|
|
|
| 21 |
|
|
+----de.tudarmstadt.ito.xmldbms.DocumentInfo
|
| 22 |
|
|
</pre>
|
| 23 |
|
|
<hr>
|
| 24 |
|
|
<dl>
|
| 25 |
|
|
<dt> public class <b>DocumentInfo</b>
|
| 26 |
|
|
<dt> extends Object
|
| 27 |
|
|
</dl>
|
| 28 |
|
|
Contains information necessary to retrieve a document.
|
| 29 |
|
|
<P>The DocumentInfo class contains information necessary to
|
| 30 |
|
|
retrieve a single XML document from the database: the names of the
|
| 31 |
|
|
root tables in which the document was stored, the names of the
|
| 32 |
|
|
key columns in these tables, the applicable key values, and the
|
| 33 |
|
|
names of the order columns in these tables.</P>
|
| 34 |
|
|
<p>There will be more than one set of values only if the root element
|
| 35 |
|
|
type is ignored, in which case there is one set of values for each
|
| 36 |
|
|
child. These can point to the same table (the child element types
|
| 37 |
|
|
are all the same) or multiple tables (the child element types are
|
| 38 |
|
|
different).</P>
|
| 39 |
|
|
<P>DocumentInfo objects are returned by DOMToDBMS.storeDocument
|
| 40 |
|
|
and may be passed to DBMSToDOM.retrieveDocument(DocumentInfo).</P>
|
| 41 |
|
|
<p>
|
| 42 |
|
|
<dl>
|
| 43 |
|
|
<dt> <b>See Also:</b>
|
| 44 |
|
|
<dd> <a href="de.tudarmstadt.ito.xmldbms.DOMToDBMS.html#storeDocument(Document)">storeDocument</a>, <a href="de.tudarmstadt.ito.xmldbms.DBMSToDOM.html#retrieveDocument(DocumentInfo)">retrieveDocument</a>
|
| 45 |
|
|
</dl>
|
| 46 |
|
|
<hr>
|
| 47 |
|
|
<a name="index"></a>
|
| 48 |
|
|
<h2>
|
| 49 |
|
|
<img src="images/constructor-index.gif" width=275 height=38 alt="Constructor Index">
|
| 50 |
|
|
</h2>
|
| 51 |
|
|
<dl>
|
| 52 |
|
|
<dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
|
| 53 |
|
|
<a href="#DocumentInfo()"><b>DocumentInfo</b></a>()
|
| 54 |
|
|
<dd> Construct a DocumentInfo object.
|
| 55 |
|
|
<dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
|
| 56 |
|
|
<a href="#DocumentInfo(java.lang.String, java.lang.String[], java.lang.Object[], java.lang.String)"><b>DocumentInfo</b></a>(String, String[], Object[], String)
|
| 57 |
|
|
<dd> Construct a DocumentInfo object and initialize it from table and column
|
| 58 |
|
|
names.
|
| 59 |
|
|
<dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
|
| 60 |
|
|
<a href="#DocumentInfo(de.tudarmstadt.ito.xmldbms.Table, de.tudarmstadt.ito.xmldbms.Column[], java.lang.Object[], de.tudarmstadt.ito.xmldbms.Column)"><b>DocumentInfo</b></a>(Table, Column[], Object[], Column)
|
| 61 |
|
|
<dd> Construct a DocumentInfo object and initialize from Table and Column
|
| 62 |
|
|
objects.
|
| 63 |
|
|
</dl>
|
| 64 |
|
|
<h2>
|
| 65 |
|
|
<img src="images/method-index.gif" width=207 height=38 alt="Method Index">
|
| 66 |
|
|
</h2>
|
| 67 |
|
|
<dl>
|
| 68 |
|
|
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
|
| 69 |
|
|
<a href="#addInfo(java.lang.String, java.lang.String[], java.lang.Object[], java.lang.String)"><b>addInfo</b></a>(String, String[], Object[], String)
|
| 70 |
|
|
<dd> Add a set of values to the DocumentInfo object using table and column
|
| 71 |
|
|
names.
|
| 72 |
|
|
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
|
| 73 |
|
|
<a href="#addInfo(de.tudarmstadt.ito.xmldbms.Table, de.tudarmstadt.ito.xmldbms.Column[], java.lang.Object[], de.tudarmstadt.ito.xmldbms.Column)"><b>addInfo</b></a>(Table, Column[], Object[], Column)
|
| 74 |
|
|
<dd> Add a set of values to the DocumentInfo object using Table and
|
| 75 |
|
|
Column objects.
|
| 76 |
|
|
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
|
| 77 |
|
|
<a href="#getKey(int)"><b>getKey</b></a>(int)
|
| 78 |
|
|
<dd> Get the ith key.
|
| 79 |
|
|
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
|
| 80 |
|
|
<a href="#getKeyColumnNames(int)"><b>getKeyColumnNames</b></a>(int)
|
| 81 |
|
|
<dd> Get the names of the key columns for the ith table.
|
| 82 |
|
|
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
|
| 83 |
|
|
<a href="#getOrderColumnName(int)"><b>getOrderColumnName</b></a>(int)
|
| 84 |
|
|
<dd> Get the name of the order column for the ith table.
|
| 85 |
|
|
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
|
| 86 |
|
|
<a href="#getTableName(int)"><b>getTableName</b></a>(int)
|
| 87 |
|
|
<dd> Get the name of the ith table.
|
| 88 |
|
|
<dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
|
| 89 |
|
|
<a href="#size()"><b>size</b></a>()
|
| 90 |
|
|
<dd> Get the number of keys.
|
| 91 |
|
|
</dl>
|
| 92 |
|
|
<a name="constructors"></a>
|
| 93 |
|
|
<h2>
|
| 94 |
|
|
<img src="images/constructors.gif" width=231 height=38 alt="Constructors">
|
| 95 |
|
|
</h2>
|
| 96 |
|
|
<a name="DocumentInfo"></a>
|
| 97 |
|
|
<a name="DocumentInfo()"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
|
| 98 |
|
|
<b>DocumentInfo</b>
|
| 99 |
|
|
<pre>
|
| 100 |
|
|
public DocumentInfo()
|
| 101 |
|
|
</pre>
|
| 102 |
|
|
<dl>
|
| 103 |
|
|
<dd> Construct a DocumentInfo object.
|
| 104 |
|
|
<p>
|
| 105 |
|
|
</dl>
|
| 106 |
|
|
<a name="DocumentInfo(de.tudarmstadt.ito.xmldbms.Table, de.tudarmstadt.ito.xmldbms.Column[], java.lang.Object[], de.tudarmstadt.ito.xmldbms.Column)"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
|
| 107 |
|
|
<b>DocumentInfo</b>
|
| 108 |
|
|
<pre>
|
| 109 |
|
|
public DocumentInfo(<a href="de.tudarmstadt.ito.xmldbms.Table.html#_top_">Table</a> table,
|
| 110 |
|
|
<a href="de.tudarmstadt.ito.xmldbms.Column.html#_top_">Column</a> keyColumns[],
|
| 111 |
|
|
Object key[],
|
| 112 |
|
|
<a href="de.tudarmstadt.ito.xmldbms.Column.html#_top_">Column</a> orderColumn)
|
| 113 |
|
|
</pre>
|
| 114 |
|
|
<dl>
|
| 115 |
|
|
<dd> Construct a DocumentInfo object and initialize from Table and Column
|
| 116 |
|
|
objects.
|
| 117 |
|
|
<p>
|
| 118 |
|
|
<dd><dl>
|
| 119 |
|
|
<dt> <b>Parameters:</b>
|
| 120 |
|
|
<dd> table - Table object for the table containing the data.
|
| 121 |
|
|
<dd> keyColumns - Column objects for the key columns in the table.
|
| 122 |
|
|
<dd> key - Key used to retrieve the data.
|
| 123 |
|
|
<dd> orderColumn - Column object for the column stating the order in
|
| 124 |
|
|
which the data values are to be retrieved. Null if there is no order
|
| 125 |
|
|
column.
|
| 126 |
|
|
</dl></dd>
|
| 127 |
|
|
</dl>
|
| 128 |
|
|
<a name="DocumentInfo(java.lang.String, java.lang.String[], java.lang.Object[], java.lang.String)"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
|
| 129 |
|
|
<b>DocumentInfo</b>
|
| 130 |
|
|
<pre>
|
| 131 |
|
|
public DocumentInfo(String tableName,
|
| 132 |
|
|
String keyColumnNames[],
|
| 133 |
|
|
Object key[],
|
| 134 |
|
|
String orderColumnName)
|
| 135 |
|
|
</pre>
|
| 136 |
|
|
<dl>
|
| 137 |
|
|
<dd> Construct a DocumentInfo object and initialize it from table and column
|
| 138 |
|
|
names.
|
| 139 |
|
|
<p>
|
| 140 |
|
|
<dd><dl>
|
| 141 |
|
|
<dt> <b>Parameters:</b>
|
| 142 |
|
|
<dd> tableName - Name of the table containing the data.
|
| 143 |
|
|
<dd> keyColumnNames - Names of the key columns in the table.
|
| 144 |
|
|
<dd> key - Key used to retrieve the data.
|
| 145 |
|
|
<dd> orderColumnName - Name of the column stating the order in
|
| 146 |
|
|
which the data values are to be retrieved. Null if there is no order
|
| 147 |
|
|
column.
|
| 148 |
|
|
</dl></dd>
|
| 149 |
|
|
</dl>
|
| 150 |
|
|
<a name="methods"></a>
|
| 151 |
|
|
<h2>
|
| 152 |
|
|
<img src="images/methods.gif" width=151 height=38 alt="Methods">
|
| 153 |
|
|
</h2>
|
| 154 |
|
|
<a name="size()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
|
| 155 |
|
|
<a name="size"><b>size</b></a>
|
| 156 |
|
|
<pre>
|
| 157 |
|
|
public int size()
|
| 158 |
|
|
</pre>
|
| 159 |
|
|
<dl>
|
| 160 |
|
|
<dd> Get the number of keys.
|
| 161 |
|
|
<p>
|
| 162 |
|
|
</dl>
|
| 163 |
|
|
<a name="getTableName(int)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
|
| 164 |
|
|
<a name="getTableName"><b>getTableName</b></a>
|
| 165 |
|
|
<pre>
|
| 166 |
|
|
public String getTableName(int num)
|
| 167 |
|
|
</pre>
|
| 168 |
|
|
<dl>
|
| 169 |
|
|
<dd> Get the name of the ith table.
|
| 170 |
|
|
<p>
|
| 171 |
|
|
<dd><dl>
|
| 172 |
|
|
<dt> <b>Parameters:</b>
|
| 173 |
|
|
<dd> num - Table number.
|
| 174 |
|
|
<dt> <b>Returns:</b>
|
| 175 |
|
|
<dd> Name of the table.
|
| 176 |
|
|
</dl></dd>
|
| 177 |
|
|
</dl>
|
| 178 |
|
|
<a name="getKeyColumnNames(int)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
|
| 179 |
|
|
<a name="getKeyColumnNames"><b>getKeyColumnNames</b></a>
|
| 180 |
|
|
<pre>
|
| 181 |
|
|
public String[] getKeyColumnNames(int num)
|
| 182 |
|
|
</pre>
|
| 183 |
|
|
<dl>
|
| 184 |
|
|
<dd> Get the names of the key columns for the ith table.
|
| 185 |
|
|
<p>
|
| 186 |
|
|
<dd><dl>
|
| 187 |
|
|
<dt> <b>Parameters:</b>
|
| 188 |
|
|
<dd> num - Table number.
|
| 189 |
|
|
<dt> <b>Returns:</b>
|
| 190 |
|
|
<dd> Names of the key columns.
|
| 191 |
|
|
</dl></dd>
|
| 192 |
|
|
</dl>
|
| 193 |
|
|
<a name="getKey(int)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
|
| 194 |
|
|
<a name="getKey"><b>getKey</b></a>
|
| 195 |
|
|
<pre>
|
| 196 |
|
|
public Object[] getKey(int num)
|
| 197 |
|
|
</pre>
|
| 198 |
|
|
<dl>
|
| 199 |
|
|
<dd> Get the ith key.
|
| 200 |
|
|
<p>
|
| 201 |
|
|
<dd><dl>
|
| 202 |
|
|
<dt> <b>Parameters:</b>
|
| 203 |
|
|
<dd> num - Key number.
|
| 204 |
|
|
<dt> <b>Returns:</b>
|
| 205 |
|
|
<dd> Key value.
|
| 206 |
|
|
</dl></dd>
|
| 207 |
|
|
</dl>
|
| 208 |
|
|
<a name="getOrderColumnName(int)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
|
| 209 |
|
|
<a name="getOrderColumnName"><b>getOrderColumnName</b></a>
|
| 210 |
|
|
<pre>
|
| 211 |
|
|
public String getOrderColumnName(int num)
|
| 212 |
|
|
</pre>
|
| 213 |
|
|
<dl>
|
| 214 |
|
|
<dd> Get the name of the order column for the ith table.
|
| 215 |
|
|
<p>
|
| 216 |
|
|
<dd><dl>
|
| 217 |
|
|
<dt> <b>Parameters:</b>
|
| 218 |
|
|
<dd> num - Table number.
|
| 219 |
|
|
<dt> <b>Returns:</b>
|
| 220 |
|
|
<dd> Name of the order column. Null if there is no order column.
|
| 221 |
|
|
</dl></dd>
|
| 222 |
|
|
</dl>
|
| 223 |
|
|
<a name="addInfo(de.tudarmstadt.ito.xmldbms.Table, de.tudarmstadt.ito.xmldbms.Column[], java.lang.Object[], de.tudarmstadt.ito.xmldbms.Column)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
|
| 224 |
|
|
<a name="addInfo"><b>addInfo</b></a>
|
| 225 |
|
|
<pre>
|
| 226 |
|
|
public void addInfo(<a href="de.tudarmstadt.ito.xmldbms.Table.html#_top_">Table</a> table,
|
| 227 |
|
|
<a href="de.tudarmstadt.ito.xmldbms.Column.html#_top_">Column</a> keyColumns[],
|
| 228 |
|
|
Object key[],
|
| 229 |
|
|
<a href="de.tudarmstadt.ito.xmldbms.Column.html#_top_">Column</a> orderColumn)
|
| 230 |
|
|
</pre>
|
| 231 |
|
|
<dl>
|
| 232 |
|
|
<dd> Add a set of values to the DocumentInfo object using Table and
|
| 233 |
|
|
Column objects.
|
| 234 |
|
|
<p>
|
| 235 |
|
|
<dd><dl>
|
| 236 |
|
|
<dt> <b>Parameters:</b>
|
| 237 |
|
|
<dd> table - Table object for the table containing the data.
|
| 238 |
|
|
<dd> keyColumns - Column objects for the key columns in the table.
|
| 239 |
|
|
<dd> key - Key used to retrieve the data.
|
| 240 |
|
|
<dd> orderColumn - Column object for the column stating the order in
|
| 241 |
|
|
which the data values are to be retrieved. Null if there is no order
|
| 242 |
|
|
column.
|
| 243 |
|
|
</dl></dd>
|
| 244 |
|
|
</dl>
|
| 245 |
|
|
<a name="addInfo(java.lang.String, java.lang.String[], java.lang.Object[], java.lang.String)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
|
| 246 |
|
|
<a name="addInfo"><b>addInfo</b></a>
|
| 247 |
|
|
<pre>
|
| 248 |
|
|
public void addInfo(String tableName,
|
| 249 |
|
|
String keyColumnNames[],
|
| 250 |
|
|
Object key[],
|
| 251 |
|
|
String orderColumnName)
|
| 252 |
|
|
</pre>
|
| 253 |
|
|
<dl>
|
| 254 |
|
|
<dd> Add a set of values to the DocumentInfo object using table and column
|
| 255 |
|
|
names.
|
| 256 |
|
|
<p>
|
| 257 |
|
|
<dd><dl>
|
| 258 |
|
|
<dt> <b>Parameters:</b>
|
| 259 |
|
|
<dd> tableName - Name of the table containing the data.
|
| 260 |
|
|
<dd> keyColumnNames - Names of the key columns in the table.
|
| 261 |
|
|
<dd> key - Key used to retrieve the data.
|
| 262 |
|
|
<dd> orderColumnName - Name of the column stating the order in
|
| 263 |
|
|
which the data values are to be retrieved. Null if there is no order
|
| 264 |
|
|
column.
|
| 265 |
|
|
</dl></dd>
|
| 266 |
|
|
</dl>
|
| 267 |
|
|
<hr>
|
| 268 |
|
|
<pre>
|
| 269 |
|
|
<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.DOMToDBMS.html#_top_">Previous</a> <a href="de.tudarmstadt.ito.xmldbms.LinkInfo.html#_top_">Next</a> <a href="AllNames.html">Index</a></pre>
|
| 270 |
|
|
</body>
|
| 271 |
|
|
</html>
|