/usr/share/doc/libolap4j-java/api/src-html/org/olap4j/PreparedOlapStatement.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 | <!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: PreparedOlapStatement.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.metadata.Cube;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.sql.PreparedStatement;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.sql.SQLException;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * An object that represents a precompiled OLAP statement.<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * <p>An OLAP statement is precompiled and stored in a<a name="line.30"></a>
<span class="sourceLineNo">031</span> * <code>PreparedOlapStatement</code> object. This object can then be used to<a name="line.31"></a>
<span class="sourceLineNo">032</span> * efficiently execute this statement multiple times.</p><a name="line.32"></a>
<span class="sourceLineNo">033</span> *<a name="line.33"></a>
<span class="sourceLineNo">034</span> * <p>A <code>PreparedOlapStatement</code> is generally created using<a name="line.34"></a>
<span class="sourceLineNo">035</span> * {@link OlapConnection#prepareOlapStatement(String)}.</p><a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> * <p><B>Note:</B> The setter methods (<code>setShort</code>,<a name="line.37"></a>
<span class="sourceLineNo">038</span> * <code>setString</code>, and so on) for setting IN parameter values<a name="line.38"></a>
<span class="sourceLineNo">039</span> * must specify types that are compatible with the defined type of<a name="line.39"></a>
<span class="sourceLineNo">040</span> * the input parameter. For instance, if the IN parameter has type<a name="line.40"></a>
<span class="sourceLineNo">041</span> * <code>INTEGER</code>, then the method <code>setInt</code> should be used.</p><a name="line.41"></a>
<span class="sourceLineNo">042</span> *<a name="line.42"></a>
<span class="sourceLineNo">043</span> * <p>If a parameter has Member type, use the {@link #setObject(int, Object)}<a name="line.43"></a>
<span class="sourceLineNo">044</span> * method to set it. A {@link OlapException} will be thrown if the object is not<a name="line.44"></a>
<span class="sourceLineNo">045</span> * an instance of {@link org.olap4j.metadata.Member} or does not belong to the<a name="line.45"></a>
<span class="sourceLineNo">046</span> * correct {@link org.olap4j.metadata.Hierarchy}.</p><a name="line.46"></a>
<span class="sourceLineNo">047</span> *<a name="line.47"></a>
<span class="sourceLineNo">048</span> * <p>The method {@link #getParameterMetaData()} returns a description of the<a name="line.48"></a>
<span class="sourceLineNo">049</span> * parameters, as in JDBC. The result is an {@link OlapParameterMetaData}.<a name="line.49"></a>
<span class="sourceLineNo">050</span> *<a name="line.50"></a>
<span class="sourceLineNo">051</span> * <p>Unlike JDBC, it is not necessary to assign a value to every parameter.<a name="line.51"></a>
<span class="sourceLineNo">052</span> * This is because OLAP parameters have a default value. Parameters have their<a name="line.52"></a>
<span class="sourceLineNo">053</span> * default value until they are set, and then retain their new values for each<a name="line.53"></a>
<span class="sourceLineNo">054</span> * subsequent execution of this <code>PreparedOlapStatement</code>.<a name="line.54"></a>
<span class="sourceLineNo">055</span> *<a name="line.55"></a>
<span class="sourceLineNo">056</span> * @see OlapConnection#prepareOlapStatement(String)<a name="line.56"></a>
<span class="sourceLineNo">057</span> * @see CellSet<a name="line.57"></a>
<span class="sourceLineNo">058</span>*<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @author jhyde<a name="line.59"></a>
<span class="sourceLineNo">060</span> * @version $Id: PreparedOlapStatement.java 482 2012-01-05 23:27:27Z jhyde $<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @since Aug 22, 2006<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span>public interface PreparedOlapStatement<a name="line.63"></a>
<span class="sourceLineNo">064</span> extends PreparedStatement, OlapStatement<a name="line.64"></a>
<span class="sourceLineNo">065</span>{<a name="line.65"></a>
<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
<span class="sourceLineNo">067</span> * Executes the MDX query in this <code>PreparedOlapStatement</code> object<a name="line.67"></a>
<span class="sourceLineNo">068</span> * and returns the <code>CellSet</code> object generated by the query.<a name="line.68"></a>
<span class="sourceLineNo">069</span> *<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @return an <code>CellSet</code> object that contains the data produced<a name="line.70"></a>
<span class="sourceLineNo">071</span> * by the query; never <code>null</code><a name="line.71"></a>
<span class="sourceLineNo">072</span> * @exception OlapException if a database access error occurs<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> CellSet executeQuery() throws OlapException;<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
<span class="sourceLineNo">077</span> * Retrieves the number, types and properties of this<a name="line.77"></a>
<span class="sourceLineNo">078</span> * <code>PreparedOlapStatement</code> object's parameters.<a name="line.78"></a>
<span class="sourceLineNo">079</span> *<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @return an <code>OlapParameterMetaData</code> object that contains<a name="line.80"></a>
<span class="sourceLineNo">081</span> * information about the number, types and properties of this<a name="line.81"></a>
<span class="sourceLineNo">082</span> * <code>PreparedOlapStatement</code> object's parameters<a name="line.82"></a>
<span class="sourceLineNo">083</span> * @exception OlapException if a database access error occurs<a name="line.83"></a>
<span class="sourceLineNo">084</span> * @see OlapParameterMetaData<a name="line.84"></a>
<span class="sourceLineNo">085</span> */<a name="line.85"></a>
<span class="sourceLineNo">086</span> OlapParameterMetaData getParameterMetaData() throws OlapException;<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> /**<a name="line.88"></a>
<span class="sourceLineNo">089</span> * Retrieves a <code>CellSetMetaData</code> object that contains<a name="line.89"></a>
<span class="sourceLineNo">090</span> * information about the axes and cells of the <code>CellSet</code> object<a name="line.90"></a>
<span class="sourceLineNo">091</span> * that will be returned when this <code>PreparedOlapStatement</code> object<a name="line.91"></a>
<span class="sourceLineNo">092</span> * is executed.<a name="line.92"></a>
<span class="sourceLineNo">093</span> *<a name="line.93"></a>
<span class="sourceLineNo">094</span> * @return the description of this <code>CellSet</code>'s axes<a name="line.94"></a>
<span class="sourceLineNo">095</span> * and cells<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @exception OlapException if a database access error occurs<a name="line.96"></a>
<span class="sourceLineNo">097</span> */<a name="line.97"></a>
<span class="sourceLineNo">098</span> CellSetMetaData getMetaData() throws SQLException;<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> /**<a name="line.100"></a>
<span class="sourceLineNo">101</span> * Returns the cube (or virtual cube) which this statement is based upon.<a name="line.101"></a>
<span class="sourceLineNo">102</span> *<a name="line.102"></a>
<span class="sourceLineNo">103</span> * @return cube this statement is based upon<a name="line.103"></a>
<span class="sourceLineNo">104</span> */<a name="line.104"></a>
<span class="sourceLineNo">105</span> Cube getCube();<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> /**<a name="line.107"></a>
<span class="sourceLineNo">108</span> * Returns whether the value of the designated parameter is set.<a name="line.108"></a>
<span class="sourceLineNo">109</span> *<a name="line.109"></a>
<span class="sourceLineNo">110</span> * <p>Note that you cannot tell whether the parameter is set by looking to<a name="line.110"></a>
<span class="sourceLineNo">111</span> * see whether the value is {@code null}, because {@code null} is a valid<a name="line.111"></a>
<span class="sourceLineNo">112</span> * parameter value. When a parameter is not set, its value is derived by<a name="line.112"></a>
<span class="sourceLineNo">113</span> * evaluating its default expression.<a name="line.113"></a>
<span class="sourceLineNo">114</span> *<a name="line.114"></a>
<span class="sourceLineNo">115</span> * <p>To set the value call one of the {@link #setObject setXxx} methods. To<a name="line.115"></a>
<span class="sourceLineNo">116</span> * unset the value, call {@link #unset}.<a name="line.116"></a>
<span class="sourceLineNo">117</span> *<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @param parameterIndex the first parameter is 1, the second is 2, ...<a name="line.118"></a>
<span class="sourceLineNo">119</span> * @return whether the parameter's value has been set<a name="line.119"></a>
<span class="sourceLineNo">120</span> * @exception java.sql.SQLException if a database access error occurs<a name="line.120"></a>
<span class="sourceLineNo">121</span> */<a name="line.121"></a>
<span class="sourceLineNo">122</span> boolean isSet(int parameterIndex) throws SQLException;<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
<span class="sourceLineNo">125</span> * Unsets the value of the designated parameter.<a name="line.125"></a>
<span class="sourceLineNo">126</span> *<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @see #isSet(int)<a name="line.127"></a>
<span class="sourceLineNo">128</span> *<a name="line.128"></a>
<span class="sourceLineNo">129</span> * @param parameterIndex the first parameter is 1, the second is 2, ...<a name="line.129"></a>
<span class="sourceLineNo">130</span> * @exception java.sql.SQLException if a database access error occurs<a name="line.130"></a>
<span class="sourceLineNo">131</span> */<a name="line.131"></a>
<span class="sourceLineNo">132</span> void unset(int parameterIndex) throws SQLException;<a name="line.132"></a>
<span class="sourceLineNo">133</span>}<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span>// End PreparedOlapStatement.java<a name="line.135"></a>
</pre>
</div>
</body>
</html>
|