blob: 8deb7999aa9d0cc47d5540043717ef882e0055ec [file] [log] [blame]
<!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="../../../../../../javadoc.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a>
<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a>
<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a>
<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a>
<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a>
<span class="sourceLineNo">006</span>// * *<a name="line.6"></a>
<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a>
<span class="sourceLineNo">008</span>// * *<a name="line.8"></a>
<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a>
<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a>
<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a>
<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a>
<span class="sourceLineNo">013</span>package org.apache.juneau.jena.annotation;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import static java.lang.annotation.ElementType.*;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import static java.lang.annotation.RetentionPolicy.*;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>/**<a name="line.20"></a>
<span class="sourceLineNo">021</span> * Identifies the default RDF namespaces at the package level.<a name="line.21"></a>
<span class="sourceLineNo">022</span> *<a name="line.22"></a>
<span class="sourceLineNo">023</span> * &lt;ul class='seealso'&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;li class='link'&gt;{@doc jmr.RdfDetails}<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;li class='extlink'&gt;{@source}<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;/ul&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> */<a name="line.27"></a>
<span class="sourceLineNo">028</span>@Documented<a name="line.28"></a>
<span class="sourceLineNo">029</span>@Target(PACKAGE)<a name="line.29"></a>
<span class="sourceLineNo">030</span>@Retention(RUNTIME)<a name="line.30"></a>
<span class="sourceLineNo">031</span>@Inherited<a name="line.31"></a>
<span class="sourceLineNo">032</span>public @interface RdfSchema {<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span> /**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Sets the default RDF namespace URL for all classes in this and child packages.<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;p&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> * Must either be matched with a {@link #prefix()} annotation, or an {@link #rdfNs()} mapping with the same<a name="line.38"></a>
<span class="sourceLineNo">039</span> * {@link RdfNs#namespaceURI() @RdfNs(namespaceURI)} value.<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @return The annotation value.<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span> public String namespace() default "";<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> /**<a name="line.45"></a>
<span class="sourceLineNo">046</span> * Sets the default RDF prefix for all classes in this and child packages.<a name="line.46"></a>
<span class="sourceLineNo">047</span> *<a name="line.47"></a>
<span class="sourceLineNo">048</span> * &lt;p&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Must either be matched with a {@link #namespace()} annotation, or an {@link #rdfNs()} mapping with the same<a name="line.49"></a>
<span class="sourceLineNo">050</span> * {@link RdfNs#prefix} value.<a name="line.50"></a>
<span class="sourceLineNo">051</span> *<a name="line.51"></a>
<span class="sourceLineNo">052</span> * @return The annotation value.<a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span> public String prefix() default "";<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * Lists all namespace mappings to be used on all classes within this package.<a name="line.57"></a>
<span class="sourceLineNo">058</span> *<a name="line.58"></a>
<span class="sourceLineNo">059</span> * &lt;p&gt;<a name="line.59"></a>
<span class="sourceLineNo">060</span> * The purpose of this annotation is to allow namespace mappings to be defined in a single location and referred to<a name="line.60"></a>
<span class="sourceLineNo">061</span> * by name through just the {@link Rdf#prefix() @Rdf(prefix)} annotation.<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> * &lt;p&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Inherited by child packages.<a name="line.64"></a>
<span class="sourceLineNo">065</span> *<a name="line.65"></a>
<span class="sourceLineNo">066</span> * &lt;h5 class='section'&gt;Example:&lt;/h5&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> *<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Contents of &lt;c&gt;package-info.java&lt;/c&gt;...<a name="line.68"></a>
<span class="sourceLineNo">069</span> * &lt;p class='bjava'&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;jc&gt;// XML namespaces used within this package.&lt;/jc&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;ja&gt;@RdfSchema&lt;/ja&gt;(prefix=&lt;js&gt;"ab"&lt;/js&gt;,<a name="line.71"></a>
<span class="sourceLineNo">072</span> * namespaces={<a name="line.72"></a>
<span class="sourceLineNo">073</span> * &lt;ja&gt;@RdfNs&lt;/ja&gt;(prefix=&lt;js&gt;"ab"&lt;/js&gt;, namespaceURI=&lt;js&gt;"http://www.apache.org/addressBook/"&lt;/js&gt;),<a name="line.73"></a>
<span class="sourceLineNo">074</span> * &lt;ja&gt;@RdfNs&lt;/ja&gt;(prefix=&lt;js&gt;"per"&lt;/js&gt;, namespaceURI=&lt;js&gt;"http://www.apache.org/person/"&lt;/js&gt;),<a name="line.74"></a>
<span class="sourceLineNo">075</span> * &lt;ja&gt;@RdfNs&lt;/ja&gt;(prefix=&lt;js&gt;"addr"&lt;/js&gt;, namespaceURI=&lt;js&gt;"http://www.apache.org/address/"&lt;/js&gt;),<a name="line.75"></a>
<span class="sourceLineNo">076</span> * &lt;ja&gt;@RdfNs&lt;/ja&gt;(prefix=&lt;js&gt;"mail"&lt;/js&gt;, namespaceURI="&lt;js&gt;http://www.apache.org/mail/"&lt;/js&gt;)<a name="line.76"></a>
<span class="sourceLineNo">077</span> * }<a name="line.77"></a>
<span class="sourceLineNo">078</span> * )<a name="line.78"></a>
<span class="sourceLineNo">079</span> * &lt;jk&gt;package&lt;/jk&gt; org.apache.juneau.examples.addressbook;<a name="line.79"></a>
<span class="sourceLineNo">080</span> * &lt;jk&gt;import&lt;/jk&gt; org.apache.juneau.rdf.annotation.*;<a name="line.80"></a>
<span class="sourceLineNo">081</span> * &lt;/p&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span> *<a name="line.82"></a>
<span class="sourceLineNo">083</span> * &lt;p&gt;<a name="line.83"></a>
<span class="sourceLineNo">084</span> * Class in package using defined namespaces...<a name="line.84"></a>
<span class="sourceLineNo">085</span> * &lt;p class='bjava'&gt;<a name="line.85"></a>
<span class="sourceLineNo">086</span> * &lt;jk&gt;package&lt;/jk&gt; org.apache.juneau.examples.addressbook;<a name="line.86"></a>
<span class="sourceLineNo">087</span> *<a name="line.87"></a>
<span class="sourceLineNo">088</span> * &lt;jc&gt;// Bean class, override "ab" namespace on package.&lt;/jc&gt;<a name="line.88"></a>
<span class="sourceLineNo">089</span> * &lt;ja&gt;@Rdf&lt;/ja&gt;(prefix=&lt;js&gt;"addr"&lt;/js&gt;)<a name="line.89"></a>
<span class="sourceLineNo">090</span> * &lt;jk&gt;public class&lt;/jk&gt; Address {<a name="line.90"></a>
<span class="sourceLineNo">091</span> *<a name="line.91"></a>
<span class="sourceLineNo">092</span> * &lt;jc&gt;// Bean property, use "addr" namespace on class.&lt;/jc&gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span> * &lt;jk&gt;public int&lt;/jk&gt; &lt;jf&gt;id&lt;/jf&gt;;<a name="line.93"></a>
<span class="sourceLineNo">094</span> *<a name="line.94"></a>
<span class="sourceLineNo">095</span> * &lt;jc&gt;// Bean property, override with "mail" namespace.&lt;/jc&gt;<a name="line.95"></a>
<span class="sourceLineNo">096</span> * &lt;ja&gt;@Rdf&lt;/ja&gt;(prefix=&lt;js&gt;"mail"&lt;/js&gt;)<a name="line.96"></a>
<span class="sourceLineNo">097</span> * &lt;jk&gt;public&lt;/jk&gt; String &lt;jf&gt;street&lt;/jf&gt;, &lt;jf&gt;city&lt;/jf&gt;, &lt;jf&gt;state&lt;/jf&gt;;<a name="line.97"></a>
<span class="sourceLineNo">098</span> * }<a name="line.98"></a>
<span class="sourceLineNo">099</span> * &lt;/p&gt;<a name="line.99"></a>
<span class="sourceLineNo">100</span> *<a name="line.100"></a>
<span class="sourceLineNo">101</span> * @return The annotation value.<a name="line.101"></a>
<span class="sourceLineNo">102</span> */<a name="line.102"></a>
<span class="sourceLineNo">103</span> public RdfNs[] rdfNs() default {};<a name="line.103"></a>
<span class="sourceLineNo">104</span>}<a name="line.104"></a>
</pre>
</div>
</body>
</html>