/usr/share/doc/libolap4j-java/api/src-html/org/olap4j/CellSetAxis.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 | <!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: CellSetAxis.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 java.util.List;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.ListIterator;<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> * Axis of a CellSet.<a name="line.26"></a>
<span class="sourceLineNo">027</span> *<a name="line.27"></a>
<span class="sourceLineNo">028</span> * <p>A cell set has the same number of axes as the MDX statement which was<a name="line.28"></a>
<span class="sourceLineNo">029</span> * executed to produce it. For example, a typical cell set, resulting from an<a name="line.29"></a>
<span class="sourceLineNo">030</span> * MDX query with COLUMNS and ROWS expressions is two-dimensional, and<a name="line.30"></a>
<span class="sourceLineNo">031</span> * therefore has two axes.</p><a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> * <p>Each axis is an ordered collection of members or tuples. Each member or<a name="line.33"></a>
<span class="sourceLineNo">034</span> * tuple on an axis is called a {@link Position}.</p><a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * <p>The positions on the cell set axis can be accessed sequentially or<a name="line.36"></a>
<span class="sourceLineNo">037</span> * random-access. Use the {@link #getPositions()} method to return a list for<a name="line.37"></a>
<span class="sourceLineNo">038</span> * random access, or the {@link #iterator()} method to obtain an iterator for<a name="line.38"></a>
<span class="sourceLineNo">039</span> * sequential access.<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @author jhyde<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @version $Id: CellSetAxis.java 482 2012-01-05 23:27:27Z jhyde $<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @since Aug 22, 2006<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span>public interface CellSetAxis extends Iterable<Position> {<a name="line.45"></a>
<span class="sourceLineNo">046</span> /**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Returns the axis ordinal of this <code>CellSetAxis</code>.<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> * <p>The first axis in a CellSet will return {@link Axis#COLUMNS},<a name="line.49"></a>
<span class="sourceLineNo">050</span> * the second {@link Axis#ROWS}, and so forth, as described by the<a name="line.50"></a>
<span class="sourceLineNo">051</span> * {@link Axis#axisOrdinal()} method of the {@link Axis} enumeration.</p><a name="line.51"></a>
<span class="sourceLineNo">052</span> *<a name="line.52"></a>
<span class="sourceLineNo">053</span> * @return the ordinal of this axis<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> Axis getAxisOrdinal();<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
<span class="sourceLineNo">058</span> * Returns the {@link CellSet} which this <code>CellSetAxis</code><a name="line.58"></a>
<span class="sourceLineNo">059</span> * belongs to.<a name="line.59"></a>
<span class="sourceLineNo">060</span> *<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @return the CellSet<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> CellSet getCellSet();<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> /**<a name="line.65"></a>
<span class="sourceLineNo">066</span> * Returns a description of the type (e.g. {@link Axis#ROWS}) of this<a name="line.66"></a>
<span class="sourceLineNo">067</span> * axis, and the hierarchies and properties which will be found on it.<a name="line.67"></a>
<span class="sourceLineNo">068</span> *<a name="line.68"></a>
<span class="sourceLineNo">069</span> * <p>The result is identical to evaluating<a name="line.69"></a>
<span class="sourceLineNo">070</span> * <blockquote><a name="line.70"></a>
<span class="sourceLineNo">071</span> * <code>getCellSet().getMetaData().getSlicerAxisMetaData()</code><a name="line.71"></a>
<span class="sourceLineNo">072</span> * </blockquote><a name="line.72"></a>
<span class="sourceLineNo">073</span> * for a filter axis, and<a name="line.73"></a>
<span class="sourceLineNo">074</span> * <blockquote><a name="line.74"></a>
<span class="sourceLineNo">075</span> * <code>getCellSet().getMetaData().getAxesMetaData().get(<a name="line.75"></a>
<span class="sourceLineNo">076</span> * getAxisOrdinal().axisOrdinal())</code><a name="line.76"></a>
<span class="sourceLineNo">077</span> * </blockquote><a name="line.77"></a>
<span class="sourceLineNo">078</span> * for other axes.<a name="line.78"></a>
<span class="sourceLineNo">079</span> *<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @return metadata describing this CellSetAxis<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> CellSetAxisMetaData getAxisMetaData();<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> /**<a name="line.84"></a>
<span class="sourceLineNo">085</span> * Returns a list of <code>Position</code> objects on this CellSetAxis.<a name="line.85"></a>
<span class="sourceLineNo">086</span> *<a name="line.86"></a>
<span class="sourceLineNo">087</span> * @return List of positions on this axis (never null)<a name="line.87"></a>
<span class="sourceLineNo">088</span> */<a name="line.88"></a>
<span class="sourceLineNo">089</span> List<Position> getPositions();<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
<span class="sourceLineNo">092</span> * Returns the number of positions on this CellSetAxis.<a name="line.92"></a>
<span class="sourceLineNo">093</span> *<a name="line.93"></a>
<span class="sourceLineNo">094</span> * <p>This method can be called at any time. In particular, it is not<a name="line.94"></a>
<span class="sourceLineNo">095</span> * necessary to complete an iteration through all positions before calling<a name="line.95"></a>
<span class="sourceLineNo">096</span> * this method.</p><a name="line.96"></a>
<span class="sourceLineNo">097</span> *<a name="line.97"></a>
<span class="sourceLineNo">098</span> * <p>The number of positions on an axis is important when computing the<a name="line.98"></a>
<span class="sourceLineNo">099</span> * ordinal of a cell.</p><a name="line.99"></a>
<span class="sourceLineNo">100</span> *<a name="line.100"></a>
<span class="sourceLineNo">101</span> * @return the number of positions<a name="line.101"></a>
<span class="sourceLineNo">102</span> */<a name="line.102"></a>
<span class="sourceLineNo">103</span> int getPositionCount();<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> /**<a name="line.105"></a>
<span class="sourceLineNo">106</span> * Opens an iterator over the positions on this CellSetAxis.<a name="line.106"></a>
<span class="sourceLineNo">107</span> *<a name="line.107"></a>
<span class="sourceLineNo">108</span> * <p>If this axis has very many positions, this method may be more<a name="line.108"></a>
<span class="sourceLineNo">109</span> * efficient than {@link #getPositions()}.<a name="line.109"></a>
<span class="sourceLineNo">110</span> *<a name="line.110"></a>
<span class="sourceLineNo">111</span> * <p>This method allows CellSetAxis to implement the {@link Iterable}<a name="line.111"></a>
<span class="sourceLineNo">112</span> * interface, so one might use it in a foreach construct, for example:<a name="line.112"></a>
<span class="sourceLineNo">113</span> *<a name="line.113"></a>
<span class="sourceLineNo">114</span> * <blockquote><a name="line.114"></a>
<span class="sourceLineNo">115</span> * <pre><a name="line.115"></a>
<span class="sourceLineNo">116</span> * CellSet cellSet;<a name="line.116"></a>
<span class="sourceLineNo">117</span> * for (Position rowPos : cellSet.getAxes().get(0)) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> * for (Position colPos : cellSet.getAxes().get(1)) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> * Cell cell = cellSet.getCell(colPos, rowPos);<a name="line.119"></a>
<span class="sourceLineNo">120</span> * ....<a name="line.120"></a>
<span class="sourceLineNo">121</span> * }<a name="line.121"></a>
<span class="sourceLineNo">122</span> * }</pre></blockquote><a name="line.122"></a>
<span class="sourceLineNo">123</span> *<a name="line.123"></a>
<span class="sourceLineNo">124</span> * @return iterator over the collection of positions<a name="line.124"></a>
<span class="sourceLineNo">125</span> */<a name="line.125"></a>
<span class="sourceLineNo">126</span> ListIterator<Position> iterator();<a name="line.126"></a>
<span class="sourceLineNo">127</span><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>// End CellSetAxis.java<a name="line.130"></a>
</pre>
</div>
</body>
</html>
|