/usr/share/doc/libolap4j-java/api/src-html/org/olap4j/metadata/MetadataElement.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 | <!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: MetadataElement.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>/**<a name="line.22"></a>
<span class="sourceLineNo">023</span> * An element which describes the structure of an OLAP schema.<a name="line.23"></a>
<span class="sourceLineNo">024</span> *<a name="line.24"></a>
<span class="sourceLineNo">025</span> * @author jhyde<a name="line.25"></a>
<span class="sourceLineNo">026</span> * @version $Id: MetadataElement.java 482 2012-01-05 23:27:27Z jhyde $<a name="line.26"></a>
<span class="sourceLineNo">027</span> * @since Oct 13, 2006<a name="line.27"></a>
<span class="sourceLineNo">028</span> */<a name="line.28"></a>
<span class="sourceLineNo">029</span>public interface MetadataElement {<a name="line.29"></a>
<span class="sourceLineNo">030</span> /**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Returns the name of this element.<a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> * <p>Name is never null. Unlike {@link #getCaption() caption} and<a name="line.33"></a>
<span class="sourceLineNo">034</span> * {@link #getDescription() description}, an element's name is the same in<a name="line.34"></a>
<span class="sourceLineNo">035</span> * every {@link java.util.Locale}.<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> * @return name of this element<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span> String getName();<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Returns the unique name of this element within its schema.<a name="line.42"></a>
<span class="sourceLineNo">043</span> *<a name="line.43"></a>
<span class="sourceLineNo">044</span> * <p>The unique name is never null, and is unique among all elements in<a name="line.44"></a>
<span class="sourceLineNo">045</span> * this {@link Schema}.<a name="line.45"></a>
<span class="sourceLineNo">046</span> *<a name="line.46"></a>
<span class="sourceLineNo">047</span> * <p>Unlike {@link #getCaption() caption} and<a name="line.47"></a>
<span class="sourceLineNo">048</span> * {@link #getDescription() description}, an element's unique name is the<a name="line.48"></a>
<span class="sourceLineNo">049</span> * same in every {@link java.util.Locale}.<a name="line.49"></a>
<span class="sourceLineNo">050</span> *<a name="line.50"></a>
<span class="sourceLineNo">051</span> * <p>The structure of the unique name is provider-specific and subject to<a name="line.51"></a>
<span class="sourceLineNo">052</span> * change between provider versions. Applications should not attempt to<a name="line.52"></a>
<span class="sourceLineNo">053</span> * reverse-engineer the structure of the name.<a name="line.53"></a>
<span class="sourceLineNo">054</span> *<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @return unique name of this element<a name="line.55"></a>
<span class="sourceLineNo">056</span> */<a name="line.56"></a>
<span class="sourceLineNo">057</span> String getUniqueName();<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> * Returns the caption of this element in the current connection's<a name="line.60"></a>
<span class="sourceLineNo">061</span> * {@link java.util.Locale}.<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> * <p>This method may return the empty string, but never returns null.<a name="line.63"></a>
<span class="sourceLineNo">064</span> * The rules for deriving an element's caption are provider-specific,<a name="line.64"></a>
<span class="sourceLineNo">065</span> * but generally if no caption is defined for the element in a given locale,<a name="line.65"></a>
<span class="sourceLineNo">066</span> * returns the name of the element.</p><a name="line.66"></a>
<span class="sourceLineNo">067</span> *<a name="line.67"></a>
<span class="sourceLineNo">068</span> * @return caption of this element in the current locale; never null.<a name="line.68"></a>
<span class="sourceLineNo">069</span> *<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @see org.olap4j.OlapConnection#getLocale()<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span> String getCaption();<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> /**<a name="line.74"></a>
<span class="sourceLineNo">075</span> * Returns the description of this element in the current connection's<a name="line.75"></a>
<span class="sourceLineNo">076</span> * {@link java.util.Locale}.<a name="line.76"></a>
<span class="sourceLineNo">077</span> *<a name="line.77"></a>
<span class="sourceLineNo">078</span> * <p>This method may return the empty string, but never returns null.<a name="line.78"></a>
<span class="sourceLineNo">079</span> * The rules for deriving an element's description are provider-specific,<a name="line.79"></a>
<span class="sourceLineNo">080</span> * but generally if no description is defined<a name="line.80"></a>
<span class="sourceLineNo">081</span> * for the element in a given locale, returns the description in base<a name="line.81"></a>
<span class="sourceLineNo">082</span> * locale.</p><a name="line.82"></a>
<span class="sourceLineNo">083</span> *<a name="line.83"></a>
<span class="sourceLineNo">084</span> * @return description of this element in the current locale; never null.<a name="line.84"></a>
<span class="sourceLineNo">085</span> *<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @see org.olap4j.OlapConnection#getLocale()<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> String getDescription();<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> /**<a name="line.90"></a>
<span class="sourceLineNo">091</span> * Returns whether this element is visible to end-users.<a name="line.91"></a>
<span class="sourceLineNo">092</span> *<a name="line.92"></a>
<span class="sourceLineNo">093</span> * <p>Visibility is a hint for client applications. An element's visibility<a name="line.93"></a>
<span class="sourceLineNo">094</span> * does not affect how it is treated when MDX queries are evaluated.<a name="line.94"></a>
<span class="sourceLineNo">095</span> *<a name="line.95"></a>
<span class="sourceLineNo">096</span> * <p>If you wish to hide an MDX element at a deeper level, consider two<a name="line.96"></a>
<span class="sourceLineNo">097</span> * OLAP concepts that sound similar to visibility but have different<a name="line.97"></a>
<span class="sourceLineNo">098</span> * semantics:<a name="line.98"></a>
<span class="sourceLineNo">099</span> *<a name="line.99"></a>
<span class="sourceLineNo">100</span> * <ul><a name="line.100"></a>
<span class="sourceLineNo">101</span> * <li>{@link Member#isHidden Hidden members} in ragged hierarchies;</li><a name="line.101"></a>
<span class="sourceLineNo">102</span> * <li>{@link org.olap4j.OlapConnection#getRoleName Access control}</li><a name="line.102"></a>
<span class="sourceLineNo">103</span> * </ul><a name="line.103"></a>
<span class="sourceLineNo">104</span> *<a name="line.104"></a>
<span class="sourceLineNo">105</span> * @return Whether this element is visible<a name="line.105"></a>
<span class="sourceLineNo">106</span> */<a name="line.106"></a>
<span class="sourceLineNo">107</span> boolean isVisible();<a name="line.107"></a>
<span class="sourceLineNo">108</span>}<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span>// End MetadataElement.java<a name="line.110"></a>
</pre>
</div>
</body>
</html>
|