/usr/share/doc/libolap4j-java/api/src-html/org/olap4j/mdx/parser/MdxParser.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 | <!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: MdxParser.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.mdx.parser;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.olap4j.mdx.ParseTreeNode;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.olap4j.mdx.SelectNode;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Parser for the MDX query language.<a name="line.26"></a>
<span class="sourceLineNo">027</span> *<a name="line.27"></a>
<span class="sourceLineNo">028</span> * <p>A parser is reusable but not reentrant: you can call {@link #parseSelect}<a name="line.28"></a>
<span class="sourceLineNo">029</span> * and {@link #parseExpression} several times, but not at the same time<a name="line.29"></a>
<span class="sourceLineNo">030</span> * from different threads.<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * @see MdxParserFactory<a name="line.32"></a>
<span class="sourceLineNo">033</span> *<a name="line.33"></a>
<span class="sourceLineNo">034</span> * @author jhyde<a name="line.34"></a>
<span class="sourceLineNo">035</span> * @version $Id: MdxParser.java 482 2012-01-05 23:27:27Z jhyde $<a name="line.35"></a>
<span class="sourceLineNo">036</span> * @since Aug 22, 2006<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span>public interface MdxParser {<a name="line.38"></a>
<span class="sourceLineNo">039</span> /**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * Parses an MDX Select statement and returns the {@link SelectNode} at the<a name="line.40"></a>
<span class="sourceLineNo">041</span> * root of the parse tree.<a name="line.41"></a>
<span class="sourceLineNo">042</span> *<a name="line.42"></a>
<span class="sourceLineNo">043</span> * <p>In order to be parsed successfully, the expression must be<a name="line.43"></a>
<span class="sourceLineNo">044</span> * syntactically correct but does not need to be valid. (Syntactic<a name="line.44"></a>
<span class="sourceLineNo">045</span> * correctness and validity are described further in the description of<a name="line.45"></a>
<span class="sourceLineNo">046</span> * {@link #parseExpression(String)}.)<a name="line.46"></a>
<span class="sourceLineNo">047</span> *<a name="line.47"></a>
<span class="sourceLineNo">048</span> * @param mdx MDX query string<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @return Parse tree<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span> SelectNode parseSelect(String mdx);<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> /**<a name="line.53"></a>
<span class="sourceLineNo">054</span> * Parses an MDX expression and returns a parse tree.<a name="line.54"></a>
<span class="sourceLineNo">055</span> *<a name="line.55"></a>
<span class="sourceLineNo">056</span> * <p>An expression is a combination of operators and operands, which can<a name="line.56"></a>
<span class="sourceLineNo">057</span> * occur in many places inside an MDX query, such as the definition of a<a name="line.57"></a>
<span class="sourceLineNo">058</span> * calculated member or an axis.<a name="line.58"></a>
<span class="sourceLineNo">059</span> *<a name="line.59"></a>
<span class="sourceLineNo">060</span> * <p>In order to be parsed successfully, the expression must be<a name="line.60"></a>
<span class="sourceLineNo">061</span> * syntactically correct but does not need to be valid.<a name="line.61"></a>
<span class="sourceLineNo">062</span> * For example,<a name="line.62"></a>
<span class="sourceLineNo">063</span> *<a name="line.63"></a>
<span class="sourceLineNo">064</span> * <blockquote><code>(1 + (2 + 3)</code></blockquote><a name="line.64"></a>
<span class="sourceLineNo">065</span> *<a name="line.65"></a>
<span class="sourceLineNo">066</span> * is syntactically incorrect,<a name="line.66"></a>
<span class="sourceLineNo">067</span> * because there are more open parentheses "(" than close parentheses ")",<a name="line.67"></a>
<span class="sourceLineNo">068</span> * and the parser will give an error. Conversely,<a name="line.68"></a>
<span class="sourceLineNo">069</span> *<a name="line.69"></a>
<span class="sourceLineNo">070</span> * <blockquote><code>(1 + [Measures].[Bad Measure])</code></blockquote><a name="line.70"></a>
<span class="sourceLineNo">071</span> *<a name="line.71"></a>
<span class="sourceLineNo">072</span> * is syntactically correct, and the parser<a name="line.72"></a>
<span class="sourceLineNo">073</span> * will successfully create a parse tree, even if<a name="line.73"></a>
<span class="sourceLineNo">074</span> * <code>[Measures].[Bad Measure]</code> does not exist.<a name="line.74"></a>
<span class="sourceLineNo">075</span> *<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @param mdx MDX expression<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @return Parse tree<a name="line.77"></a>
<span class="sourceLineNo">078</span> */<a name="line.78"></a>
<span class="sourceLineNo">079</span> ParseTreeNode parseExpression(String mdx);<a name="line.79"></a>
<span class="sourceLineNo">080</span>}<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span>// End MdxParser.java<a name="line.82"></a>
</pre>
</div>
</body>
</html>
|