/usr/share/doc/libolap4j-java/api/src-html/org/olap4j/metadata/Catalog.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 | <!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: Catalog.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.metadata;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.olap4j.*;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>/**<a name="line.24"></a>
<span class="sourceLineNo">025</span> * <p>Catalogs are the second element of the hierarchy of metadata objects.<a name="line.25"></a>
<span class="sourceLineNo">026</span> * A Catalog contains one or more {@link Schema}s and has a parent<a name="line.26"></a>
<span class="sourceLineNo">027</span> * {@link Database}.</p><a name="line.27"></a>
<span class="sourceLineNo">028</span> *<a name="line.28"></a>
<span class="sourceLineNo">029</span> * <p>Some OLAP servers may only have one Catalog. Mondrian is one such<a name="line.29"></a>
<span class="sourceLineNo">030</span> * OLAP server; its sole catalog is called "LOCALDB".<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * <p>To obtain the collection of catalogs in the current server, call the<a name="line.32"></a>
<span class="sourceLineNo">033</span> * {@link OlapConnection#getOlapCatalogs()} method.<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * <p>The hierarchy of metadata objects, rooted at the connection from which<a name="line.35"></a>
<span class="sourceLineNo">036</span> * they are accessed, is as follows:<a name="line.36"></a>
<span class="sourceLineNo">037</span> * <blockquote><a name="line.37"></a>
<span class="sourceLineNo">038</span> * <ul><a name="line.38"></a>
<span class="sourceLineNo">039</span> * <li type="circle">{@link org.olap4j.OlapConnection}<ul><a name="line.39"></a>
<span class="sourceLineNo">040</span> * <li type="circle">{@link Database}<ul><a name="line.40"></a>
<span class="sourceLineNo">041</span> * <li type="circle">{@link Catalog}<ul><a name="line.41"></a>
<span class="sourceLineNo">042</span> * <li type="circle">{@link Schema}<ul><a name="line.42"></a>
<span class="sourceLineNo">043</span> * <li type="circle">{@link Cube}<ul><a name="line.43"></a>
<span class="sourceLineNo">044</span> * <li type="circle">{@link Dimension}<ul><a name="line.44"></a>
<span class="sourceLineNo">045</span> * <li type="circle">{@link Hierarchy}<ul><a name="line.45"></a>
<span class="sourceLineNo">046</span> * <li type="circle">{@link Level}<ul><a name="line.46"></a>
<span class="sourceLineNo">047</span> * <li type="circle">{@link Member}</li><a name="line.47"></a>
<span class="sourceLineNo">048</span> * <li type="circle">{@link Property}</li><a name="line.48"></a>
<span class="sourceLineNo">049</span> * </ul></li><a name="line.49"></a>
<span class="sourceLineNo">050</span> * </ul></li><a name="line.50"></a>
<span class="sourceLineNo">051</span> * </ul></li><a name="line.51"></a>
<span class="sourceLineNo">052</span> * <li type="circle">{@link NamedSet}</li><a name="line.52"></a>
<span class="sourceLineNo">053</span> * </ul></li><a name="line.53"></a>
<span class="sourceLineNo">054</span> * <li type="circle">{@link Dimension} (shared)</li><a name="line.54"></a>
<span class="sourceLineNo">055</span> * </ul></li><a name="line.55"></a>
<span class="sourceLineNo">056</span> * </ul></li><a name="line.56"></a>
<span class="sourceLineNo">057</span> * </ul></li><a name="line.57"></a>
<span class="sourceLineNo">058</span> * </ul><a name="line.58"></a>
<span class="sourceLineNo">059</span> * </blockquote><a name="line.59"></a>
<span class="sourceLineNo">060</span> * </p><a name="line.60"></a>
<span class="sourceLineNo">061</span> *<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @author jhyde<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @version $Id: Catalog.java 482 2012-01-05 23:27:27Z jhyde $<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @since Oct 24, 2006<a name="line.64"></a>
<span class="sourceLineNo">065</span> */<a name="line.65"></a>
<span class="sourceLineNo">066</span>public interface Catalog {<a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Returns a list of {@link Schema} objects which belong to<a name="line.68"></a>
<span class="sourceLineNo">069</span> * this <code>Catalog</code>.<a name="line.69"></a>
<span class="sourceLineNo">070</span> *<a name="line.70"></a>
<span class="sourceLineNo">071</span> * <p>The caller should assume that the list is immutable;<a name="line.71"></a>
<span class="sourceLineNo">072</span> * if the caller modifies the list, behavior is undefined.</p><a name="line.72"></a>
<span class="sourceLineNo">073</span> *<a name="line.73"></a>
<span class="sourceLineNo">074</span> * @see org.olap4j.OlapDatabaseMetaData#getSchemas<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @return List of Schema in this <code>Catalog</code><a name="line.75"></a>
<span class="sourceLineNo">076</span> * @throws OlapException if error occurs<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span> NamedList<Schema> getSchemas() throws OlapException;<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> * Returns the name of this Catalog.<a name="line.81"></a>
<span class="sourceLineNo">082</span> *<a name="line.82"></a>
<span class="sourceLineNo">083</span> * @return name of this Catalog<a name="line.83"></a>
<span class="sourceLineNo">084</span> */<a name="line.84"></a>
<span class="sourceLineNo">085</span> String getName();<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * Retrieves the metadata describing the OLAP server that this Catalog<a name="line.88"></a>
<span class="sourceLineNo">089</span> * belongs to.<a name="line.89"></a>
<span class="sourceLineNo">090</span> *<a name="line.90"></a>
<span class="sourceLineNo">091</span> * @return metadata describing the OLAP server<a name="line.91"></a>
<span class="sourceLineNo">092</span> */<a name="line.92"></a>
<span class="sourceLineNo">093</span> OlapDatabaseMetaData getMetaData();<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> /**<a name="line.95"></a>
<span class="sourceLineNo">096</span> * Returns the parent database of this catalog.<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @return A Database object to which this catalog belongs.<a name="line.97"></a>
<span class="sourceLineNo">098</span> */<a name="line.98"></a>
<span class="sourceLineNo">099</span> Database getDatabase();<a name="line.99"></a>
<span class="sourceLineNo">100</span>}<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span>// End Catalog.java<a name="line.102"></a>
</pre>
</div>
</body>
</html>
|