/usr/share/doc/libolap4j-java/api/src-html/org/olap4j/OlapConnection.html is in libolap4j-java-doc 1.0.1.500-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span>// $Id: OlapConnection.java 482 2012-01-05 23:27:27Z jhyde $<a name="line.2"></a>
<span class="sourceLineNo">003</span>//<a name="line.3"></a>
<span class="sourceLineNo">004</span>// Licensed to Julian Hyde under one or more contributor license<a name="line.4"></a>
<span class="sourceLineNo">005</span>// agreements. See the NOTICE file distributed with this work for<a name="line.5"></a>
<span class="sourceLineNo">006</span>// additional information regarding copyright ownership.<a name="line.6"></a>
<span class="sourceLineNo">007</span>//<a name="line.7"></a>
<span class="sourceLineNo">008</span>// Julian Hyde licenses this file to you under the Apache License,<a name="line.8"></a>
<span class="sourceLineNo">009</span>// Version 2.0 (the "License"); you may not use this file except in<a name="line.9"></a>
<span class="sourceLineNo">010</span>// compliance with the License. You may obtain a copy of the License at:<a name="line.10"></a>
<span class="sourceLineNo">011</span>//<a name="line.11"></a>
<span class="sourceLineNo">012</span>// http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
<span class="sourceLineNo">013</span>//<a name="line.13"></a>
<span class="sourceLineNo">014</span>// Unless required by applicable law or agreed to in writing, software<a name="line.14"></a>
<span class="sourceLineNo">015</span>// distributed under the License is distributed on an "AS IS" BASIS,<a name="line.15"></a>
<span class="sourceLineNo">016</span>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.16"></a>
<span class="sourceLineNo">017</span>// See the License for the specific language governing permissions and<a name="line.17"></a>
<span class="sourceLineNo">018</span>// limitations under the License.<a name="line.18"></a>
<span class="sourceLineNo">019</span>*/<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.olap4j;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.olap4j.mdx.parser.MdxParserFactory;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.olap4j.metadata.*;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.sql.*;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Locale;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Connection to an OLAP server.<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * <p>OlapConnection is a subclass of {@link Connection}. It can be pooled<a name="line.32"></a>
<span class="sourceLineNo">033</span> * by a connection pooling framework or obtained directly via the Java<a name="line.33"></a>
<span class="sourceLineNo">034</span> * standard {@link DriverManager}. The JDBC URL prefix of olap connections<a name="line.34"></a>
<span class="sourceLineNo">035</span> * is dependent of the driver implementation. Such implementations are,<a name="line.35"></a>
<span class="sourceLineNo">036</span> * among others possible:<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * <ul><li>Olap4j's XML/A driver</li><li>Mondrian</li></ul><a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * <p>Olap connections have a different metadata hierarchy than regular<a name="line.40"></a>
<span class="sourceLineNo">041</span> * JDBC. The connection's metadata is available using<a name="line.41"></a>
<span class="sourceLineNo">042</span> * {@link OlapConnection#getMetaData()}, and returns a specialized subclass<a name="line.42"></a>
<span class="sourceLineNo">043</span> * of {@link DatabaseMetaData}. The objects at the root of the hierarchy<a name="line.43"></a>
<span class="sourceLineNo">044</span> * are {@link Database} class objects.<a name="line.44"></a>
<span class="sourceLineNo">045</span> *<a name="line.45"></a>
<span class="sourceLineNo">046</span> * <p>A connection needs be bound to a database, a catalog and a schema.<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Implementations are expected to automatically discover these if no<a name="line.47"></a>
<span class="sourceLineNo">048</span> * driver specific parameters indicated which ones to use.<a name="line.48"></a>
<span class="sourceLineNo">049</span> *<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @author jhyde<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @version $Id: OlapConnection.java 482 2012-01-05 23:27:27Z jhyde $<a name="line.51"></a>
<span class="sourceLineNo">052</span> * @since Aug 22, 2006<a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span>public interface OlapConnection extends Connection, OlapWrapper {<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> // overrides Connection, with refined return type and throws list<a name="line.56"></a>
<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
<span class="sourceLineNo">058</span> * {@inheritDoc}<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @throws OlapException if database error occurs<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span> OlapDatabaseMetaData getMetaData() throws OlapException;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> /**<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Creates a prepared OLAP Statement.<a name="line.64"></a>
<span class="sourceLineNo">065</span> *<a name="line.65"></a>
<span class="sourceLineNo">066</span> * <p>This method is the equivalent, for OLAP, of the<a name="line.66"></a>
<span class="sourceLineNo">067</span> * {@link Connection#prepareStatement(String)} JDBC method.</p><a name="line.67"></a>
<span class="sourceLineNo">068</span> *<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @param mdx MDX query string<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @return prepared statement<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @throws OlapException if database error occurs<a name="line.71"></a>
<span class="sourceLineNo">072</span> */<a name="line.72"></a>
<span class="sourceLineNo">073</span> PreparedOlapStatement prepareOlapStatement(String mdx) throws OlapException;<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
<span class="sourceLineNo">076</span> * Returns the factory used to create MDX parsers in this connection.<a name="line.76"></a>
<span class="sourceLineNo">077</span> *<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @return MDX parser factory<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span> MdxParserFactory getParserFactory();<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> // overrides Connection, with refined return type and throws list<a name="line.82"></a>
<span class="sourceLineNo">083</span> /**<a name="line.83"></a>
<span class="sourceLineNo">084</span> * {@inheritDoc}<a name="line.84"></a>
<span class="sourceLineNo">085</span> * @throws OlapException if database error occurs<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> OlapStatement createStatement() throws OlapException;<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> /**<a name="line.89"></a>
<span class="sourceLineNo">090</span> * Returns the database name currently active for this connection. If no<a name="line.90"></a>
<span class="sourceLineNo">091</span> * database name was specified either through the JDBC URL or through<a name="line.91"></a>
<span class="sourceLineNo">092</span> * {@link OlapConnection#setDatabase(String)}, the driver will select the<a name="line.92"></a>
<span class="sourceLineNo">093</span> * first one available.<a name="line.93"></a>
<span class="sourceLineNo">094</span> *<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @return The name of the database currently active for this connection.<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @throws OlapException<a name="line.96"></a>
<span class="sourceLineNo">097</span> * An exception will be thrown, if any of these conditions<a name="line.97"></a>
<span class="sourceLineNo">098</span> * are true:<a name="line.98"></a>
<span class="sourceLineNo">099</span> * <ul><a name="line.99"></a>
<span class="sourceLineNo">100</span> * <li>A server error occurs.</li><a name="line.100"></a>
<span class="sourceLineNo">101</span> * <li>No databases exist on the server.</li><a name="line.101"></a>
<span class="sourceLineNo">102</span> * <li>The user specified a database name which does not<a name="line.102"></a>
<span class="sourceLineNo">103</span> * exist on the server.</li><a name="line.103"></a>
<span class="sourceLineNo">104</span> * </ul><a name="line.104"></a>
<span class="sourceLineNo">105</span> */<a name="line.105"></a>
<span class="sourceLineNo">106</span> String getDatabase() throws OlapException;<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> /**<a name="line.108"></a>
<span class="sourceLineNo">109</span> * Sets the name of the database that will be used for this connection.<a name="line.109"></a>
<span class="sourceLineNo">110</span> * Overrides the value passed, if any, through the JDBC URL.<a name="line.110"></a>
<span class="sourceLineNo">111</span> *<a name="line.111"></a>
<span class="sourceLineNo">112</span> * @param databaseName<a name="line.112"></a>
<span class="sourceLineNo">113</span> * The name of the database to use.<a name="line.113"></a>
<span class="sourceLineNo">114</span> * @throws OlapException<a name="line.114"></a>
<span class="sourceLineNo">115</span> * An exception will be thrown, if any of these conditions<a name="line.115"></a>
<span class="sourceLineNo">116</span> * are true:<a name="line.116"></a>
<span class="sourceLineNo">117</span> * <ul><a name="line.117"></a>
<span class="sourceLineNo">118</span> * <li>A server error occurs.</li><a name="line.118"></a>
<span class="sourceLineNo">119</span> * <li>The user specified a database name which does not<a name="line.119"></a>
<span class="sourceLineNo">120</span> * exist on the server.</li><a name="line.120"></a>
<span class="sourceLineNo">121</span> * </ul><a name="line.121"></a>
<span class="sourceLineNo">122</span> */<a name="line.122"></a>
<span class="sourceLineNo">123</span> void setDatabase(String databaseName) throws OlapException;<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
<span class="sourceLineNo">126</span> * Returns the current active {@link org.olap4j.metadata.Database} of this<a name="line.126"></a>
<span class="sourceLineNo">127</span> * connection.<a name="line.127"></a>
<span class="sourceLineNo">128</span> *<a name="line.128"></a>
<span class="sourceLineNo">129</span> * <p>If the user has not specified a database name to use for this<a name="line.129"></a>
<span class="sourceLineNo">130</span> * connection, the driver will auto-select the first Database available.<a name="line.130"></a>
<span class="sourceLineNo">131</span> *<a name="line.131"></a>
<span class="sourceLineNo">132</span> * @see #setDatabase(String)<a name="line.132"></a>
<span class="sourceLineNo">133</span> * @see #getOlapDatabases()<a name="line.133"></a>
<span class="sourceLineNo">134</span> * @return The currently active Database, or null of none are currently<a name="line.134"></a>
<span class="sourceLineNo">135</span> * selected.<a name="line.135"></a>
<span class="sourceLineNo">136</span> * @throws OlapException<a name="line.136"></a>
<span class="sourceLineNo">137</span> * An exception will be thrown, if any of these conditions<a name="line.137"></a>
<span class="sourceLineNo">138</span> * are true:<a name="line.138"></a>
<span class="sourceLineNo">139</span> * <ul><a name="line.139"></a>
<span class="sourceLineNo">140</span> * <li>A server error occurs.</li><a name="line.140"></a>
<span class="sourceLineNo">141</span> * <li>No databases exist on the server.</li><a name="line.141"></a>
<span class="sourceLineNo">142</span> * <li>The user specified a database name which does not<a name="line.142"></a>
<span class="sourceLineNo">143</span> * exist on the server.</li><a name="line.143"></a>
<span class="sourceLineNo">144</span> * </ul><a name="line.144"></a>
<span class="sourceLineNo">145</span> */<a name="line.145"></a>
<span class="sourceLineNo">146</span> Database getOlapDatabase() throws OlapException;<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> /**<a name="line.148"></a>
<span class="sourceLineNo">149</span> * Returns a list of {@link org.olap4j.metadata.Database} objects which<a name="line.149"></a>
<span class="sourceLineNo">150</span> * belong to this connection's OLAP server.<a name="line.150"></a>
<span class="sourceLineNo">151</span> *<a name="line.151"></a>
<span class="sourceLineNo">152</span> * <p>The caller should assume that the list is immutable;<a name="line.152"></a>
<span class="sourceLineNo">153</span> * if the caller modifies the list, behavior is undefined.</p><a name="line.153"></a>
<span class="sourceLineNo">154</span> *<a name="line.154"></a>
<span class="sourceLineNo">155</span> * @return List of Database objects in this connection's OLAP server<a name="line.155"></a>
<span class="sourceLineNo">156</span> * @throws OlapException if a database access error occurs<a name="line.156"></a>
<span class="sourceLineNo">157</span> */<a name="line.157"></a>
<span class="sourceLineNo">158</span> NamedList<Database> getOlapDatabases() throws OlapException;<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> /**<a name="line.160"></a>
<span class="sourceLineNo">161</span> * Returns the {@link Catalog} name which is currently active for this<a name="line.161"></a>
<span class="sourceLineNo">162</span> * connection.<a name="line.162"></a>
<span class="sourceLineNo">163</span> *<a name="line.163"></a>
<span class="sourceLineNo">164</span> * <p><a name="line.164"></a>
<span class="sourceLineNo">165</span> * If the user has not specified a database name to use for this<a name="line.165"></a>
<span class="sourceLineNo">166</span> * connection, the driver will automatically select the first one<a name="line.166"></a>
<span class="sourceLineNo">167</span> * available. If the user has not specified a catalog name to use,<a name="line.167"></a>
<span class="sourceLineNo">168</span> * the driver will also use the first one available on the server.<a name="line.168"></a>
<span class="sourceLineNo">169</span> *<a name="line.169"></a>
<span class="sourceLineNo">170</span> * @return The name of the catalog which is active for this connection.<a name="line.170"></a>
<span class="sourceLineNo">171</span> * @throws OlapException<a name="line.171"></a>
<span class="sourceLineNo">172</span> * An exception will be thrown, if any of these conditions<a name="line.172"></a>
<span class="sourceLineNo">173</span> * are true:<a name="line.173"></a>
<span class="sourceLineNo">174</span> * <ul><a name="line.174"></a>
<span class="sourceLineNo">175</span> * <li>A server error occurs.</li><a name="line.175"></a>
<span class="sourceLineNo">176</span> * <li>No database name was specified and no databases exist<a name="line.176"></a>
<span class="sourceLineNo">177</span> * on the server.</li><a name="line.177"></a>
<span class="sourceLineNo">178</span> * <li>The user specified a database name which does not<a name="line.178"></a>
<span class="sourceLineNo">179</span> * exist on the server.</li><a name="line.179"></a>
<span class="sourceLineNo">180</span> * <li>No catalog names were specified and no catalogs<a name="line.180"></a>
<span class="sourceLineNo">181</span> * exist on the server.</li><a name="line.181"></a>
<span class="sourceLineNo">182</span> * <li>The user specified a catalog name which does not exist<a name="line.182"></a>
<span class="sourceLineNo">183</span> * on the server.</li><a name="line.183"></a>
<span class="sourceLineNo">184</span> * </ul><a name="line.184"></a>
<span class="sourceLineNo">185</span> */<a name="line.185"></a>
<span class="sourceLineNo">186</span> String getCatalog() throws OlapException;<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> /**<a name="line.188"></a>
<span class="sourceLineNo">189</span> * Sets the name of the catalog that will be used for this connection.<a name="line.189"></a>
<span class="sourceLineNo">190</span> * Overrides the value passed, if any, through the JDBC URL.<a name="line.190"></a>
<span class="sourceLineNo">191</span> *<a name="line.191"></a>
<span class="sourceLineNo">192</span> * @param catalogName<a name="line.192"></a>
<span class="sourceLineNo">193</span> * The name of the catalog to use for this connection.<a name="line.193"></a>
<span class="sourceLineNo">194</span> * @throws OlapException<a name="line.194"></a>
<span class="sourceLineNo">195</span> * An exception will be thrown, if any of these conditions<a name="line.195"></a>
<span class="sourceLineNo">196</span> * are true:<a name="line.196"></a>
<span class="sourceLineNo">197</span> * <ul><a name="line.197"></a>
<span class="sourceLineNo">198</span> * <li>A server error occurs.</li><a name="line.198"></a>
<span class="sourceLineNo">199</span> * <li>No database name was specified and no databases<a name="line.199"></a>
<span class="sourceLineNo">200</span> * exist on the server.</li><a name="line.200"></a>
<span class="sourceLineNo">201</span> * <li>The user specified a database name which does not<a name="line.201"></a>
<span class="sourceLineNo">202</span> * exist on the server.</li><a name="line.202"></a>
<span class="sourceLineNo">203</span> * <li>The user specified a catalog name which does not exist<a name="line.203"></a>
<span class="sourceLineNo">204</span> * on the server.</li><a name="line.204"></a>
<span class="sourceLineNo">205</span> * </ul><a name="line.205"></a>
<span class="sourceLineNo">206</span> */<a name="line.206"></a>
<span class="sourceLineNo">207</span> void setCatalog(String catalogName) throws OlapException;<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> /**<a name="line.209"></a>
<span class="sourceLineNo">210</span> * Returns the current active {@link org.olap4j.metadata.Catalog}<a name="line.210"></a>
<span class="sourceLineNo">211</span> * of this connection.<a name="line.211"></a>
<span class="sourceLineNo">212</span> *<a name="line.212"></a>
<span class="sourceLineNo">213</span> * <p>If the user has not selected a Database and Catalog to use for<a name="line.213"></a>
<span class="sourceLineNo">214</span> * this connection, the driver will auto-select the first<a name="line.214"></a>
<span class="sourceLineNo">215</span> * Database and Catalog available on the server.<a name="line.215"></a>
<span class="sourceLineNo">216</span> *<a name="line.216"></a>
<span class="sourceLineNo">217</span> * <p>Any auto-discovery performed by implementations must take into<a name="line.217"></a>
<span class="sourceLineNo">218</span> * account the specified database name and catalog name, if any.<a name="line.218"></a>
<span class="sourceLineNo">219</span> *<a name="line.219"></a>
<span class="sourceLineNo">220</span> * @return The currently active catalog, or null of none are<a name="line.220"></a>
<span class="sourceLineNo">221</span> * currently selected.<a name="line.221"></a>
<span class="sourceLineNo">222</span> * @throws OlapException<a name="line.222"></a>
<span class="sourceLineNo">223</span> * An exception will be thrown, if any of these conditions<a name="line.223"></a>
<span class="sourceLineNo">224</span> * are true:<a name="line.224"></a>
<span class="sourceLineNo">225</span> * <ul><a name="line.225"></a>
<span class="sourceLineNo">226</span> * <li>A server error occurs.</li><a name="line.226"></a>
<span class="sourceLineNo">227</span> * <li>No database name was specified and no databases<a name="line.227"></a>
<span class="sourceLineNo">228</span> * exist on the server.</li><a name="line.228"></a>
<span class="sourceLineNo">229</span> * <li>The user specified a database name which does not<a name="line.229"></a>
<span class="sourceLineNo">230</span> * exist on the server.</li><a name="line.230"></a>
<span class="sourceLineNo">231</span> * <li>No catalog name was specified and no catalogs<a name="line.231"></a>
<span class="sourceLineNo">232</span> * exist on the server.</li><a name="line.232"></a>
<span class="sourceLineNo">233</span> * <li>The user specified a catalog name which does not exist<a name="line.233"></a>
<span class="sourceLineNo">234</span> * on the server.</li><a name="line.234"></a>
<span class="sourceLineNo">235</span> * </ul><a name="line.235"></a>
<span class="sourceLineNo">236</span> */<a name="line.236"></a>
<span class="sourceLineNo">237</span> Catalog getOlapCatalog() throws OlapException;<a name="line.237"></a>
<span class="sourceLineNo">238</span><a name="line.238"></a>
<span class="sourceLineNo">239</span> /**<a name="line.239"></a>
<span class="sourceLineNo">240</span> * Returns a list of {@link org.olap4j.metadata.Catalog} objects which<a name="line.240"></a>
<span class="sourceLineNo">241</span> * belong to this connection's OLAP server.<a name="line.241"></a>
<span class="sourceLineNo">242</span> *<a name="line.242"></a>
<span class="sourceLineNo">243</span> * <p>If the user has not selected a Database to use for<a name="line.243"></a>
<span class="sourceLineNo">244</span> * this connection, the implementation auto-selects<a name="line.244"></a>
<span class="sourceLineNo">245</span> * the first Database available. Any auto-discovery performed<a name="line.245"></a>
<span class="sourceLineNo">246</span> * by implementations must take into account the connection<a name="line.246"></a>
<span class="sourceLineNo">247</span> * Database parameter.<a name="line.247"></a>
<span class="sourceLineNo">248</span> *<a name="line.248"></a>
<span class="sourceLineNo">249</span> * <p>The caller should assume that the list is immutable;<a name="line.249"></a>
<span class="sourceLineNo">250</span> * if the caller modifies the list, behavior is undefined.<a name="line.250"></a>
<span class="sourceLineNo">251</span> *<a name="line.251"></a>
<span class="sourceLineNo">252</span> * @return List of Catalogs in this connection's OLAP server<a name="line.252"></a>
<span class="sourceLineNo">253</span> * @throws OlapException<a name="line.253"></a>
<span class="sourceLineNo">254</span> * An exception will be thrown, if any of these conditions<a name="line.254"></a>
<span class="sourceLineNo">255</span> * are true:<a name="line.255"></a>
<span class="sourceLineNo">256</span> * <ul><a name="line.256"></a>
<span class="sourceLineNo">257</span> * <li>A server error occurs.</li><a name="line.257"></a>
<span class="sourceLineNo">258</span> * <li>No database name was specified and no databases<a name="line.258"></a>
<span class="sourceLineNo">259</span> * exist on the server.</li><a name="line.259"></a>
<span class="sourceLineNo">260</span> * <li>The user specified a database name which does not<a name="line.260"></a>
<span class="sourceLineNo">261</span> * exist on the server.</li><a name="line.261"></a>
<span class="sourceLineNo">262</span> * </ul><a name="line.262"></a>
<span class="sourceLineNo">263</span> */<a name="line.263"></a>
<span class="sourceLineNo">264</span> NamedList<Catalog> getOlapCatalogs() throws OlapException;<a name="line.264"></a>
<span class="sourceLineNo">265</span><a name="line.265"></a>
<span class="sourceLineNo">266</span> /**<a name="line.266"></a>
<span class="sourceLineNo">267</span> * Returns the {@link Schema} name that was selected for this connection,<a name="line.267"></a>
<span class="sourceLineNo">268</span> * either through the JDBC URL or via<a name="line.268"></a>
<span class="sourceLineNo">269</span> * {@link #setSchema(String)}.<a name="line.269"></a>
<span class="sourceLineNo">270</span> *<a name="line.270"></a>
<span class="sourceLineNo">271</span> * <p>If the user has not selected a Database, Catalog and Schema to use<a name="line.271"></a>
<span class="sourceLineNo">272</span> * for this connection, the driver will auto-select the first Database,<a name="line.272"></a>
<span class="sourceLineNo">273</span> * Catalog and Schema available.<a name="line.273"></a>
<span class="sourceLineNo">274</span> *<a name="line.274"></a>
<span class="sourceLineNo">275</span> * <p>Any auto-discovery performed by implementations must take into<a name="line.275"></a>
<span class="sourceLineNo">276</span> * account the specified Database, Catalog and Schema names, if any.<a name="line.276"></a>
<span class="sourceLineNo">277</span> *<a name="line.277"></a>
<span class="sourceLineNo">278</span> * @return The name of the schema currently selected for this connection.<a name="line.278"></a>
<span class="sourceLineNo">279</span> * @throws OlapException<a name="line.279"></a>
<span class="sourceLineNo">280</span> * An exception will be thrown, if any of these conditions<a name="line.280"></a>
<span class="sourceLineNo">281</span> * are true:<a name="line.281"></a>
<span class="sourceLineNo">282</span> * <ul><a name="line.282"></a>
<span class="sourceLineNo">283</span> * <li>A server error occurs.</li><a name="line.283"></a>
<span class="sourceLineNo">284</span> * <li>No database name was specified and no databases<a name="line.284"></a>
<span class="sourceLineNo">285</span> * exist on the server.</li><a name="line.285"></a>
<span class="sourceLineNo">286</span> * <li>The user specified a database name which does not<a name="line.286"></a>
<span class="sourceLineNo">287</span> * exist on the server.</li><a name="line.287"></a>
<span class="sourceLineNo">288</span> * <li>No catalog name was specified and no catalogs<a name="line.288"></a>
<span class="sourceLineNo">289</span> * exist on the server.</li><a name="line.289"></a>
<span class="sourceLineNo">290</span> * <li>The user specified a catalog name which does not exist<a name="line.290"></a>
<span class="sourceLineNo">291</span> * on the server.</li><a name="line.291"></a>
<span class="sourceLineNo">292</span> * <li>No schema name was specified and no schema<a name="line.292"></a>
<span class="sourceLineNo">293</span> * exist on the server.</li><a name="line.293"></a>
<span class="sourceLineNo">294</span> * <li>The user specified a schema name which does not exist<a name="line.294"></a>
<span class="sourceLineNo">295</span> * on the server.</li><a name="line.295"></a>
<span class="sourceLineNo">296</span> * </ul><a name="line.296"></a>
<span class="sourceLineNo">297</span> */<a name="line.297"></a>
<span class="sourceLineNo">298</span> String getSchema() throws OlapException;<a name="line.298"></a>
<span class="sourceLineNo">299</span><a name="line.299"></a>
<span class="sourceLineNo">300</span> /**<a name="line.300"></a>
<span class="sourceLineNo">301</span> * Sets the name of the active schema for this connection.<a name="line.301"></a>
<span class="sourceLineNo">302</span> * Overrides the value passed, if any, through the JDBC URL.<a name="line.302"></a>
<span class="sourceLineNo">303</span> *<a name="line.303"></a>
<span class="sourceLineNo">304</span> * @param schemaName The name of the schema to use for this connection.<a name="line.304"></a>
<span class="sourceLineNo">305</span> * @throws OlapException<a name="line.305"></a>
<span class="sourceLineNo">306</span> * An exception will be thrown, if any of these conditions<a name="line.306"></a>
<span class="sourceLineNo">307</span> * are true:<a name="line.307"></a>
<span class="sourceLineNo">308</span> * <ul><a name="line.308"></a>
<span class="sourceLineNo">309</span> * <li>A server error occurs.</li><a name="line.309"></a>
<span class="sourceLineNo">310</span> * <li>No database name was specified and no databases<a name="line.310"></a>
<span class="sourceLineNo">311</span> * exist on the server.</li><a name="line.311"></a>
<span class="sourceLineNo">312</span> * <li>The user specified a database name which does not<a name="line.312"></a>
<span class="sourceLineNo">313</span> * exist on the server.</li><a name="line.313"></a>
<span class="sourceLineNo">314</span> * <li>No catalog name was specified and no catalogs<a name="line.314"></a>
<span class="sourceLineNo">315</span> * exist on the server.</li><a name="line.315"></a>
<span class="sourceLineNo">316</span> * <li>The user specified a catalog name which does not exist<a name="line.316"></a>
<span class="sourceLineNo">317</span> * on the server.</li><a name="line.317"></a>
<span class="sourceLineNo">318</span> * <li>No schema name was specified and no schema<a name="line.318"></a>
<span class="sourceLineNo">319</span> * exist on the server.</li><a name="line.319"></a>
<span class="sourceLineNo">320</span> * <li>The user specified a schema name which does not exist<a name="line.320"></a>
<span class="sourceLineNo">321</span> * on the server.</li><a name="line.321"></a>
<span class="sourceLineNo">322</span> * </ul><a name="line.322"></a>
<span class="sourceLineNo">323</span> */<a name="line.323"></a>
<span class="sourceLineNo">324</span> void setSchema(String schemaName) throws OlapException;<a name="line.324"></a>
<span class="sourceLineNo">325</span><a name="line.325"></a>
<span class="sourceLineNo">326</span> /**<a name="line.326"></a>
<span class="sourceLineNo">327</span> * Returns the current active {@link org.olap4j.metadata.Schema}<a name="line.327"></a>
<span class="sourceLineNo">328</span> * of this connection.<a name="line.328"></a>
<span class="sourceLineNo">329</span> *<a name="line.329"></a>
<span class="sourceLineNo">330</span> * <p>If the user has not selected a Database, Catalog and Schema to use<a name="line.330"></a>
<span class="sourceLineNo">331</span> * for this connection, the driver will auto-select the first Database,<a name="line.331"></a>
<span class="sourceLineNo">332</span> * Catalog and Schema available.<a name="line.332"></a>
<span class="sourceLineNo">333</span> *<a name="line.333"></a>
<span class="sourceLineNo">334</span> * <p>Any auto-discovery performed by implementations must take into<a name="line.334"></a>
<span class="sourceLineNo">335</span> * account the specified Database, Catalog and Schema names, if any.<a name="line.335"></a>
<span class="sourceLineNo">336</span> *<a name="line.336"></a>
<span class="sourceLineNo">337</span> * @return The currently active schema<a name="line.337"></a>
<span class="sourceLineNo">338</span> * @throws OlapException<a name="line.338"></a>
<span class="sourceLineNo">339</span> * An exception will be thrown, if any of these conditions<a name="line.339"></a>
<span class="sourceLineNo">340</span> * are true:<a name="line.340"></a>
<span class="sourceLineNo">341</span> * <ul><a name="line.341"></a>
<span class="sourceLineNo">342</span> * <li>A server error occurs.</li><a name="line.342"></a>
<span class="sourceLineNo">343</span> * <li>No database name was specified and no databases<a name="line.343"></a>
<span class="sourceLineNo">344</span> * exist on the server.</li><a name="line.344"></a>
<span class="sourceLineNo">345</span> * <li>The user specified a database name which does not<a name="line.345"></a>
<span class="sourceLineNo">346</span> * exist on the server.</li><a name="line.346"></a>
<span class="sourceLineNo">347</span> * <li>No catalog name was specified and no catalogs<a name="line.347"></a>
<span class="sourceLineNo">348</span> * exist on the server.</li><a name="line.348"></a>
<span class="sourceLineNo">349</span> * <li>The user specified a catalog name which does not exist<a name="line.349"></a>
<span class="sourceLineNo">350</span> * on the server.</li><a name="line.350"></a>
<span class="sourceLineNo">351</span> * <li>No schema name was specified and no schema<a name="line.351"></a>
<span class="sourceLineNo">352</span> * exist on the server.</li><a name="line.352"></a>
<span class="sourceLineNo">353</span> * <li>The user specified a schema name which does not exist<a name="line.353"></a>
<span class="sourceLineNo">354</span> * on the server.</li><a name="line.354"></a>
<span class="sourceLineNo">355</span> * </ul><a name="line.355"></a>
<span class="sourceLineNo">356</span> */<a name="line.356"></a>
<span class="sourceLineNo">357</span> Schema getOlapSchema() throws OlapException;<a name="line.357"></a>
<span class="sourceLineNo">358</span><a name="line.358"></a>
<span class="sourceLineNo">359</span> /**<a name="line.359"></a>
<span class="sourceLineNo">360</span> * Returns a list of {@link org.olap4j.metadata.Schema} objects which<a name="line.360"></a>
<span class="sourceLineNo">361</span> * belong to this connection's OLAP server.<a name="line.361"></a>
<span class="sourceLineNo">362</span> *<a name="line.362"></a>
<span class="sourceLineNo">363</span> * <p>If the user has not selected a Database, Catalog and Schema to use<a name="line.363"></a>
<span class="sourceLineNo">364</span> * for this connection, the driver will auto-select the first Database and<a name="line.364"></a>
<span class="sourceLineNo">365</span> * Catalog available.<a name="line.365"></a>
<span class="sourceLineNo">366</span> *<a name="line.366"></a>
<span class="sourceLineNo">367</span> * <p>Any auto-discovery performed by implementations must take into<a name="line.367"></a>
<span class="sourceLineNo">368</span> * account the specified Database, Catalog and Schema names, if any.<a name="line.368"></a>
<span class="sourceLineNo">369</span> *<a name="line.369"></a>
<span class="sourceLineNo">370</span> * <p>The caller should assume that the list is immutable;<a name="line.370"></a>
<span class="sourceLineNo">371</span> * if the caller modifies the list, behavior is undefined.<a name="line.371"></a>
<span class="sourceLineNo">372</span> *<a name="line.372"></a>
<span class="sourceLineNo">373</span> * @return List of Catalogs in this connection's OLAP server<a name="line.373"></a>
<span class="sourceLineNo">374</span> * @throws OlapException<a name="line.374"></a>
<span class="sourceLineNo">375</span> * An exception will be thrown, if any of these conditions<a name="line.375"></a>
<span class="sourceLineNo">376</span> * are true:<a name="line.376"></a>
<span class="sourceLineNo">377</span> * <ul><a name="line.377"></a>
<span class="sourceLineNo">378</span> * <li>A server error occurs.</li><a name="line.378"></a>
<span class="sourceLineNo">379</span> * <li>No database name was specified and no databases<a name="line.379"></a>
<span class="sourceLineNo">380</span> * exist on the server.</li><a name="line.380"></a>
<span class="sourceLineNo">381</span> * <li>The user specified a database name which does not<a name="line.381"></a>
<span class="sourceLineNo">382</span> * exist on the server.</li><a name="line.382"></a>
<span class="sourceLineNo">383</span> * <li>No catalog name was specified and no catalogs<a name="line.383"></a>
<span class="sourceLineNo">384</span> * exist on the server.</li><a name="line.384"></a>
<span class="sourceLineNo">385</span> * <li>The user specified a catalog name which does not exist<a name="line.385"></a>
<span class="sourceLineNo">386</span> * on the server.</li><a name="line.386"></a>
<span class="sourceLineNo">387</span> * <li>No schema name was specified and no schema<a name="line.387"></a>
<span class="sourceLineNo">388</span> * exist on the server.</li><a name="line.388"></a>
<span class="sourceLineNo">389</span> * <li>The user specified a schema name which does not exist<a name="line.389"></a>
<span class="sourceLineNo">390</span> * on the server.</li><a name="line.390"></a>
<span class="sourceLineNo">391</span> * </ul><a name="line.391"></a>
<span class="sourceLineNo">392</span> */<a name="line.392"></a>
<span class="sourceLineNo">393</span> NamedList<Schema> getOlapSchemas() throws OlapException;<a name="line.393"></a>
<span class="sourceLineNo">394</span><a name="line.394"></a>
<span class="sourceLineNo">395</span> /**<a name="line.395"></a>
<span class="sourceLineNo">396</span> * Sets the current locale of this connection. The value must not be null.<a name="line.396"></a>
<span class="sourceLineNo">397</span> *<a name="line.397"></a>
<span class="sourceLineNo">398</span> * <p>If the locale is not set, the JDK's current locale is used (see<a name="line.398"></a>
<span class="sourceLineNo">399</span> * {@link java.util.Locale#getDefault()}).<a name="line.399"></a>
<span class="sourceLineNo">400</span> *<a name="line.400"></a>
<span class="sourceLineNo">401</span> * <p>Most drivers support a <code>Locale</code> connect-string property.<a name="line.401"></a>
<span class="sourceLineNo">402</span> *<a name="line.402"></a>
<span class="sourceLineNo">403</span> * @param locale Locale<a name="line.403"></a>
<span class="sourceLineNo">404</span> *<a name="line.404"></a>
<span class="sourceLineNo">405</span> * @see #getLocale()<a name="line.405"></a>
<span class="sourceLineNo">406</span> */<a name="line.406"></a>
<span class="sourceLineNo">407</span> void setLocale(Locale locale);<a name="line.407"></a>
<span class="sourceLineNo">408</span><a name="line.408"></a>
<span class="sourceLineNo">409</span> /**<a name="line.409"></a>
<span class="sourceLineNo">410</span> * Returns this connection's locale. The value is never null.<a name="line.410"></a>
<span class="sourceLineNo">411</span> *<a name="line.411"></a>
<span class="sourceLineNo">412</span> * @return locale of this connection<a name="line.412"></a>
<span class="sourceLineNo">413</span> *<a name="line.413"></a>
<span class="sourceLineNo">414</span> * @see #setLocale(java.util.Locale)<a name="line.414"></a>
<span class="sourceLineNo">415</span> * @see org.olap4j.metadata.MetadataElement#getCaption()<a name="line.415"></a>
<span class="sourceLineNo">416</span> * @see org.olap4j.metadata.MetadataElement#getDescription()<a name="line.416"></a>
<span class="sourceLineNo">417</span> */<a name="line.417"></a>
<span class="sourceLineNo">418</span> Locale getLocale();<a name="line.418"></a>
<span class="sourceLineNo">419</span><a name="line.419"></a>
<span class="sourceLineNo">420</span> /**<a name="line.420"></a>
<span class="sourceLineNo">421</span> * Sets the name of the role in which this connection executes queries. If<a name="line.421"></a>
<span class="sourceLineNo">422</span> * the name of the role is null, the connection reverts to the default<a name="line.422"></a>
<span class="sourceLineNo">423</span> * access control context.<a name="line.423"></a>
<span class="sourceLineNo">424</span> *<a name="line.424"></a>
<span class="sourceLineNo">425</span> * @param roleName Name of role<a name="line.425"></a>
<span class="sourceLineNo">426</span> * @throws OlapException if role name is invalid<a name="line.426"></a>
<span class="sourceLineNo">427</span> */<a name="line.427"></a>
<span class="sourceLineNo">428</span> void setRoleName(String roleName) throws OlapException;<a name="line.428"></a>
<span class="sourceLineNo">429</span><a name="line.429"></a>
<span class="sourceLineNo">430</span> /**<a name="line.430"></a>
<span class="sourceLineNo">431</span> * Returns the name of the role in which this connection executes queries.<a name="line.431"></a>
<span class="sourceLineNo">432</span> *<a name="line.432"></a>
<span class="sourceLineNo">433</span> * @return name of the role in which this connection executes queries<a name="line.433"></a>
<span class="sourceLineNo">434</span> */<a name="line.434"></a>
<span class="sourceLineNo">435</span> String getRoleName();<a name="line.435"></a>
<span class="sourceLineNo">436</span><a name="line.436"></a>
<span class="sourceLineNo">437</span> /**<a name="line.437"></a>
<span class="sourceLineNo">438</span> * Returns a list of the names of roles that are available for this user to<a name="line.438"></a>
<span class="sourceLineNo">439</span> * execute queries.<a name="line.439"></a>
<span class="sourceLineNo">440</span> *<a name="line.440"></a>
<span class="sourceLineNo">441</span> * @return a list of role names, or null if the available roles are not<a name="line.441"></a>
<span class="sourceLineNo">442</span> * known<a name="line.442"></a>
<span class="sourceLineNo">443</span> *<a name="line.443"></a>
<span class="sourceLineNo">444</span> * @throws OlapException if database error occurs<a name="line.444"></a>
<span class="sourceLineNo">445</span> */<a name="line.445"></a>
<span class="sourceLineNo">446</span> List<String> getAvailableRoleNames() throws OlapException;<a name="line.446"></a>
<span class="sourceLineNo">447</span><a name="line.447"></a>
<span class="sourceLineNo">448</span> /**<a name="line.448"></a>
<span class="sourceLineNo">449</span> * Creates a Scenario.<a name="line.449"></a>
<span class="sourceLineNo">450</span> *<a name="line.450"></a>
<span class="sourceLineNo">451</span> * <p>It does not become the active scenario for the current connection.<a name="line.451"></a>
<span class="sourceLineNo">452</span> * To do this, call {@link #setScenario(Scenario)}.<a name="line.452"></a>
<span class="sourceLineNo">453</span> *<a name="line.453"></a>
<span class="sourceLineNo">454</span> * @see #setScenario<a name="line.454"></a>
<span class="sourceLineNo">455</span> *<a name="line.455"></a>
<span class="sourceLineNo">456</span> * @return a new Scenario<a name="line.456"></a>
<span class="sourceLineNo">457</span> *<a name="line.457"></a>
<span class="sourceLineNo">458</span> * @throws OlapException if database error occurs<a name="line.458"></a>
<span class="sourceLineNo">459</span> */<a name="line.459"></a>
<span class="sourceLineNo">460</span> Scenario createScenario() throws OlapException;<a name="line.460"></a>
<span class="sourceLineNo">461</span><a name="line.461"></a>
<span class="sourceLineNo">462</span> /**<a name="line.462"></a>
<span class="sourceLineNo">463</span> * Sets the active Scenario of this connection.<a name="line.463"></a>
<span class="sourceLineNo">464</span> *<a name="line.464"></a>
<span class="sourceLineNo">465</span> * <p>After setting a scenario, the client may call<a name="line.465"></a>
<span class="sourceLineNo">466</span> * {@link Cell#setValue} to change the value of cells returned<a name="line.466"></a>
<span class="sourceLineNo">467</span> * from queries. The value of those cells is changed. This operation is<a name="line.467"></a>
<span class="sourceLineNo">468</span> * referred to as 'writeback', and is used to perform 'what if' analysis,<a name="line.468"></a>
<span class="sourceLineNo">469</span> * such as budgeting. See {@link Scenario} for more details.<a name="line.469"></a>
<span class="sourceLineNo">470</span> *<a name="line.470"></a>
<span class="sourceLineNo">471</span> * <p>If {@code scenario} is null, the connection will have no active<a name="line.471"></a>
<span class="sourceLineNo">472</span> * scenario, and writeback is not allowed.<a name="line.472"></a>
<span class="sourceLineNo">473</span> *<a name="line.473"></a>
<span class="sourceLineNo">474</span> * <p>Scenarios are created using {@link #createScenario()}.<a name="line.474"></a>
<span class="sourceLineNo">475</span> *<a name="line.475"></a>
<span class="sourceLineNo">476</span> * @param scenario Scenario<a name="line.476"></a>
<span class="sourceLineNo">477</span> *<a name="line.477"></a>
<span class="sourceLineNo">478</span> * @throws OlapException if database error occurs<a name="line.478"></a>
<span class="sourceLineNo">479</span> */<a name="line.479"></a>
<span class="sourceLineNo">480</span> void setScenario(Scenario scenario) throws OlapException;<a name="line.480"></a>
<span class="sourceLineNo">481</span><a name="line.481"></a>
<span class="sourceLineNo">482</span> /**<a name="line.482"></a>
<span class="sourceLineNo">483</span> * Returns this connection's active Scenario, or null if there is no<a name="line.483"></a>
<span class="sourceLineNo">484</span> * active Scenario.<a name="line.484"></a>
<span class="sourceLineNo">485</span> *<a name="line.485"></a>
<span class="sourceLineNo">486</span> * @return Active scenario, or null<a name="line.486"></a>
<span class="sourceLineNo">487</span> *<a name="line.487"></a>
<span class="sourceLineNo">488</span> * @throws OlapException if database error occurs<a name="line.488"></a>
<span class="sourceLineNo">489</span> */<a name="line.489"></a>
<span class="sourceLineNo">490</span> Scenario getScenario() throws OlapException;<a name="line.490"></a>
<span class="sourceLineNo">491</span>}<a name="line.491"></a>
<span class="sourceLineNo">492</span><a name="line.492"></a>
<span class="sourceLineNo">493</span>// End OlapConnection.java<a name="line.493"></a>
</pre>
</div>
</body>
</html>
|