/usr/share/doc/libolap4j-java/api/src-html/org/olap4j/type/TypeUtil.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 | <!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: TypeUtil.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.type;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.olap4j.OlapException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.olap4j.metadata.Hierarchy;<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> * Utility methods relating to types.<a name="line.26"></a>
<span class="sourceLineNo">027</span> *<a name="line.27"></a>
<span class="sourceLineNo">028</span> * <p>NOTE: This class is experimental. Not part of the public olap4j API.<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * @author jhyde<a name="line.30"></a>
<span class="sourceLineNo">031</span> * @since Feb 17, 2005<a name="line.31"></a>
<span class="sourceLineNo">032</span> * @version $Id: TypeUtil.java 482 2012-01-05 23:27:27Z jhyde $<a name="line.32"></a>
<span class="sourceLineNo">033</span> */<a name="line.33"></a>
<span class="sourceLineNo">034</span>public class TypeUtil {<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span> /**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Given a set type, returns the element type. Or its element type, if it<a name="line.37"></a>
<span class="sourceLineNo">038</span> * is a set type. And so on.<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span> private static Type stripSetType(Type type) {<a name="line.40"></a>
<span class="sourceLineNo">041</span> while (type instanceof SetType) {<a name="line.41"></a>
<span class="sourceLineNo">042</span> type = ((SetType) type).getElementType();<a name="line.42"></a>
<span class="sourceLineNo">043</span> }<a name="line.43"></a>
<span class="sourceLineNo">044</span> return type;<a name="line.44"></a>
<span class="sourceLineNo">045</span> }<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Converts a type to a member or tuple type.<a name="line.48"></a>
<span class="sourceLineNo">049</span> * If it cannot, returns null.<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span> private static Type toMemberOrTupleType(Type type) throws OlapException {<a name="line.51"></a>
<span class="sourceLineNo">052</span> type = stripSetType(type);<a name="line.52"></a>
<span class="sourceLineNo">053</span> if (type instanceof TupleType) {<a name="line.53"></a>
<span class="sourceLineNo">054</span> return (TupleType) type;<a name="line.54"></a>
<span class="sourceLineNo">055</span> } else {<a name="line.55"></a>
<span class="sourceLineNo">056</span> return toMemberType(type);<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> /**<a name="line.60"></a>
<span class="sourceLineNo">061</span> * Converts a type to a member type.<a name="line.61"></a>
<span class="sourceLineNo">062</span> * If it is a set, strips the set.<a name="line.62"></a>
<span class="sourceLineNo">063</span> * If it is a member type, returns the type unchanged.<a name="line.63"></a>
<span class="sourceLineNo">064</span> * If it is a dimension, hierarchy or level type, converts it to<a name="line.64"></a>
<span class="sourceLineNo">065</span> * a member type.<a name="line.65"></a>
<span class="sourceLineNo">066</span> * If it is a tuple, number, string, or boolean, returns null.<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> static MemberType toMemberType(Type type) throws OlapException {<a name="line.68"></a>
<span class="sourceLineNo">069</span> type = stripSetType(type);<a name="line.69"></a>
<span class="sourceLineNo">070</span> if (type instanceof MemberType) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> return (MemberType) type;<a name="line.71"></a>
<span class="sourceLineNo">072</span> } else if (type instanceof DimensionType<a name="line.72"></a>
<span class="sourceLineNo">073</span> || type instanceof HierarchyType<a name="line.73"></a>
<span class="sourceLineNo">074</span> || type instanceof LevelType)<a name="line.74"></a>
<span class="sourceLineNo">075</span> {<a name="line.75"></a>
<span class="sourceLineNo">076</span> return MemberType.forType(type);<a name="line.76"></a>
<span class="sourceLineNo">077</span> } else {<a name="line.77"></a>
<span class="sourceLineNo">078</span> return null;<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<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> /**<a name="line.82"></a>
<span class="sourceLineNo">083</span> * Returns whether this type is union-compatible with another.<a name="line.83"></a>
<span class="sourceLineNo">084</span> * In general, to be union-compatible, types must have the same<a name="line.84"></a>
<span class="sourceLineNo">085</span> * dimensionality.<a name="line.85"></a>
<span class="sourceLineNo">086</span> *<a name="line.86"></a>
<span class="sourceLineNo">087</span> * @param type1 First type<a name="line.87"></a>
<span class="sourceLineNo">088</span> * @param type2 Second type<a name="line.88"></a>
<span class="sourceLineNo">089</span> * @return Whether types are union-compatible<a name="line.89"></a>
<span class="sourceLineNo">090</span> * @throws OlapException on error<a name="line.90"></a>
<span class="sourceLineNo">091</span> */<a name="line.91"></a>
<span class="sourceLineNo">092</span> static boolean isUnionCompatible(<a name="line.92"></a>
<span class="sourceLineNo">093</span> Type type1,<a name="line.93"></a>
<span class="sourceLineNo">094</span> Type type2)<a name="line.94"></a>
<span class="sourceLineNo">095</span> throws OlapException<a name="line.95"></a>
<span class="sourceLineNo">096</span> {<a name="line.96"></a>
<span class="sourceLineNo">097</span> if (type1 instanceof TupleType) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> return type2 instanceof TupleType<a name="line.98"></a>
<span class="sourceLineNo">099</span> && ((TupleType) type1).isUnionCompatibleWith(<a name="line.99"></a>
<span class="sourceLineNo">100</span> (TupleType) type2);<a name="line.100"></a>
<span class="sourceLineNo">101</span> } else {<a name="line.101"></a>
<span class="sourceLineNo">102</span> final MemberType memberType1 = toMemberType(type1);<a name="line.102"></a>
<span class="sourceLineNo">103</span> if (memberType1 == null) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> return false;<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span> final MemberType memberType2 = toMemberType(type2);<a name="line.106"></a>
<span class="sourceLineNo">107</span> if (memberType2 == null) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> return false;<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span> final Hierarchy hierarchy1 = memberType1.getHierarchy();<a name="line.110"></a>
<span class="sourceLineNo">111</span> final Hierarchy hierarchy2 = memberType2.getHierarchy();<a name="line.111"></a>
<span class="sourceLineNo">112</span> return equal(hierarchy1, hierarchy2);<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> private static boolean equal(<a name="line.116"></a>
<span class="sourceLineNo">117</span> final Hierarchy hierarchy1, final Hierarchy hierarchy2)<a name="line.117"></a>
<span class="sourceLineNo">118</span> {<a name="line.118"></a>
<span class="sourceLineNo">119</span> if (hierarchy1 == null<a name="line.119"></a>
<span class="sourceLineNo">120</span> || hierarchy2 == null<a name="line.120"></a>
<span class="sourceLineNo">121</span> || hierarchy2.getUniqueName().equals(<a name="line.121"></a>
<span class="sourceLineNo">122</span> hierarchy1.getUniqueName()))<a name="line.122"></a>
<span class="sourceLineNo">123</span> {<a name="line.123"></a>
<span class="sourceLineNo">124</span> // They are compatible.<a name="line.124"></a>
<span class="sourceLineNo">125</span> return true;<a name="line.125"></a>
<span class="sourceLineNo">126</span> } else {<a name="line.126"></a>
<span class="sourceLineNo">127</span> return false;<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> /**<a name="line.131"></a>
<span class="sourceLineNo">132</span> * Returns whether a value of a given type can be evaluated to a scalar<a name="line.132"></a>
<span class="sourceLineNo">133</span> * value.<a name="line.133"></a>
<span class="sourceLineNo">134</span> *<a name="line.134"></a>
<span class="sourceLineNo">135</span> * <p>The rules are as follows:<ul><a name="line.135"></a>
<span class="sourceLineNo">136</span> * <li>Clearly boolean, numeric and string expressions can be evaluated.<a name="line.136"></a>
<span class="sourceLineNo">137</span> * <li>Member and tuple expressions can be interpreted as a scalar value.<a name="line.137"></a>
<span class="sourceLineNo">138</span> * The expression is evaluated to establish the context where a measure<a name="line.138"></a>
<span class="sourceLineNo">139</span> * can be evaluated.<a name="line.139"></a>
<span class="sourceLineNo">140</span> * <li>Hierarchy and dimension expressions are implicitly<a name="line.140"></a>
<span class="sourceLineNo">141</span> * converted into the current member, and evaluated as above.<a name="line.141"></a>
<span class="sourceLineNo">142</span> * <li>Level expressions cannot be evaluated<a name="line.142"></a>
<span class="sourceLineNo">143</span> * <li>Cube and Set (even sets with a single member) cannot be evaluated.<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> * @param type Type<a name="line.146"></a>
<span class="sourceLineNo">147</span> * @return Whether an expression of this type can be evaluated to yield a<a name="line.147"></a>
<span class="sourceLineNo">148</span> * scalar value.<a name="line.148"></a>
<span class="sourceLineNo">149</span> */<a name="line.149"></a>
<span class="sourceLineNo">150</span> public static boolean canEvaluate(Type type) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> return ! (type instanceof SetType<a name="line.151"></a>
<span class="sourceLineNo">152</span> || type instanceof CubeType<a name="line.152"></a>
<span class="sourceLineNo">153</span> || type instanceof LevelType);<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> /**<a name="line.156"></a>
<span class="sourceLineNo">157</span> * Returns whether a type is a set type.<a name="line.157"></a>
<span class="sourceLineNo">158</span> *<a name="line.158"></a>
<span class="sourceLineNo">159</span> * @param type Type<a name="line.159"></a>
<span class="sourceLineNo">160</span> * @return Whether a value of this type can be evaluated to yield a set.<a name="line.160"></a>
<span class="sourceLineNo">161</span> */<a name="line.161"></a>
<span class="sourceLineNo">162</span> public static boolean isSet(Type type) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> return type instanceof SetType;<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> private static boolean couldBeMember(Type type) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> return type instanceof MemberType<a name="line.167"></a>
<span class="sourceLineNo">168</span> || type instanceof HierarchyType<a name="line.168"></a>
<span class="sourceLineNo">169</span> || type instanceof DimensionType;<a name="line.169"></a>
<span class="sourceLineNo">170</span> }<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span> static boolean equal(Object o, Object p) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> return o == null ? p == null : p != null && o.equals(p);<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span>}<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span>// End TypeUtil.java<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
</pre>
</div>
</body>
</html>
|