Added: websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/api/Literal.html ============================================================================== --- websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/api/Literal.html (added) +++ websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/api/Literal.html Thu Nov 17 14:45:34 2016 @@ -0,0 +1,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> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> +<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> +<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> +<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> +<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> +<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> +<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> +<span class="sourceLineNo">009</span> *<a name="line.9"></a> +<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> +<span class="sourceLineNo">011</span> *<a name="line.11"></a> +<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> +<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> +<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> +<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> +<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> +<span class="sourceLineNo">017</span> */<a name="line.17"></a> +<span class="sourceLineNo">018</span>package org.apache.commons.rdf.api;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.io.Serializable;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.util.Objects;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import java.util.Optional;<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> * A RDF-1.1 Literal, as defined by<a name="line.25"></a> +<span class="sourceLineNo">026</span> * <a href= "http://www.w3.org/TR/rdf11-concepts/#section-Graph-Literal";<a name="line.26"></a> +<span class="sourceLineNo">027</span> * >RDF-1.1 Concepts and Abstract Syntax</a>, a W3C Recommendation published on<a name="line.27"></a> +<span class="sourceLineNo">028</span> * 25 February 2014<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <a name="line.29"></a> +<span class="sourceLineNo">030</span> * @see RDF#createLiteral(String)<a name="line.30"></a> +<span class="sourceLineNo">031</span> * @see RDF#createLiteral(String, IRI)<a name="line.31"></a> +<span class="sourceLineNo">032</span> * @see RDF#createLiteral(String, String)<a name="line.32"></a> +<span class="sourceLineNo">033</span> */<a name="line.33"></a> +<span class="sourceLineNo">034</span>public interface Literal extends RDFTerm {<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> * The lexical form of this literal, represented by a<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <a href="http://www.unicode.org/versions/latest/">Unicode string</a>.<a name="line.38"></a> +<span class="sourceLineNo">039</span> *<a name="line.39"></a> +<span class="sourceLineNo">040</span> * @return The lexical form of this literal.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * @see <a href=<a name="line.41"></a> +<span class="sourceLineNo">042</span> * "http://www.w3.org/TR/rdf11-concepts/#dfn-lexical-form">RDF-1.1<a name="line.42"></a> +<span class="sourceLineNo">043</span> * Literal lexical form</a><a name="line.43"></a> +<span class="sourceLineNo">044</span> */<a name="line.44"></a> +<span class="sourceLineNo">045</span> String getLexicalForm();<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> * The IRI identifying the datatype that determines how the lexical form<a name="line.48"></a> +<span class="sourceLineNo">049</span> * maps to a literal value.<a name="line.49"></a> +<span class="sourceLineNo">050</span> *<a name="line.50"></a> +<span class="sourceLineNo">051</span> * If the datatype IRI is<a name="line.51"></a> +<span class="sourceLineNo">052</span> * <a href="http://www.w3.org/1999/02/22-rdf-syntax-ns#langString";<a name="line.52"></a> +<span class="sourceLineNo">053</span> * >http://www.w3.org/1999/02/22-rdf-syntax-ns#langString</a>,<a name="line.53"></a> +<span class="sourceLineNo">054</span> * {@link #getLanguageTag()} must not return {@link Optional#empty()}, and<a name="line.54"></a> +<span class="sourceLineNo">055</span> * it must return a valid<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <a href="http://tools.ietf.org/html/bcp47">BCP47</a> language tag.<a name="line.56"></a> +<span class="sourceLineNo">057</span> *<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @return The datatype IRI for this literal.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @see <a href=<a name="line.59"></a> +<span class="sourceLineNo">060</span> * "http://www.w3.org/TR/rdf11-concepts/#dfn-datatype-iri">RDF-1.1<a name="line.60"></a> +<span class="sourceLineNo">061</span> * Literal datatype IRI</a><a name="line.61"></a> +<span class="sourceLineNo">062</span> */<a name="line.62"></a> +<span class="sourceLineNo">063</span> IRI getDatatype();<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> * If and only if the datatype IRI is<a name="line.66"></a> +<span class="sourceLineNo">067</span> * <a href="http://www.w3.org/1999/02/22-rdf-syntax-ns#langString";<a name="line.67"></a> +<span class="sourceLineNo">068</span> * >http://www.w3.org/1999/02/22-rdf-syntax-ns#langString</a>, the language<a name="line.68"></a> +<span class="sourceLineNo">069</span> * tag for this Literal is a non-empty language tag as defined by<a name="line.69"></a> +<span class="sourceLineNo">070</span> * <a href="http://tools.ietf.org/html/bcp47">BCP47</a>.<br><a name="line.70"></a> +<span class="sourceLineNo">071</span> * If the datatype IRI is not<a name="line.71"></a> +<span class="sourceLineNo">072</span> * <a href="http://www.w3.org/1999/02/22-rdf-syntax-ns#langString";<a name="line.72"></a> +<span class="sourceLineNo">073</span> * >http://www.w3.org/1999/02/22-rdf-syntax-ns#langString</a>, this method<a name="line.73"></a> +<span class="sourceLineNo">074</span> * must return {@link Optional#empty()}.<a name="line.74"></a> +<span class="sourceLineNo">075</span> *<a name="line.75"></a> +<span class="sourceLineNo">076</span> * Implementation note: If your application requires {@link Serializable}<a name="line.76"></a> +<span class="sourceLineNo">077</span> * objects, it is best not to store an {@link Optional} in a field. It is<a name="line.77"></a> +<span class="sourceLineNo">078</span> * recommended to use {@link Optional#ofNullable(Object)} to create the<a name="line.78"></a> +<span class="sourceLineNo">079</span> * return value for this method.<a name="line.79"></a> +<span class="sourceLineNo">080</span> *<a name="line.80"></a> +<span class="sourceLineNo">081</span> * @return The {@link Optional} language tag for this literal. If<a name="line.81"></a> +<span class="sourceLineNo">082</span> * {@link Optional#isPresent()} returns true, the value returned by<a name="line.82"></a> +<span class="sourceLineNo">083</span> * {@link Optional#get()} must be a non-empty string conforming to<a name="line.83"></a> +<span class="sourceLineNo">084</span> * BCP47.<a name="line.84"></a> +<span class="sourceLineNo">085</span> * @see <a href=<a name="line.85"></a> +<span class="sourceLineNo">086</span> * "http://www.w3.org/TR/rdf11-concepts/#dfn-language-tag">RDF-1.1<a name="line.86"></a> +<span class="sourceLineNo">087</span> * Literal language tag</a><a name="line.87"></a> +<span class="sourceLineNo">088</span> */<a name="line.88"></a> +<span class="sourceLineNo">089</span> Optional<String> getLanguageTag();<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> * Check it this Literal is equal to another Literal. <blockquote><a name="line.92"></a> +<span class="sourceLineNo">093</span> * <a href="http://www.w3.org/TR/rdf11-concepts/#dfn-literal-term">Literal<a name="line.93"></a> +<span class="sourceLineNo">094</span> * term equality</a>: Two literals are term-equal (the same RDF literal) if<a name="line.94"></a> +<span class="sourceLineNo">095</span> * and only if the two lexical forms, the two datatype IRIs, and the two<a name="line.95"></a> +<span class="sourceLineNo">096</span> * language tags (if any) compare equal, character by character. Thus, two<a name="line.96"></a> +<span class="sourceLineNo">097</span> * literals can have the same value without being the same RDF term.<a name="line.97"></a> +<span class="sourceLineNo">098</span> * </blockquote><a name="line.98"></a> +<span class="sourceLineNo">099</span> *<a name="line.99"></a> +<span class="sourceLineNo">100</span> * Implementations MUST also override {@link #hashCode()} so that two equal<a name="line.100"></a> +<span class="sourceLineNo">101</span> * Literals produce the same hash code.<a name="line.101"></a> +<span class="sourceLineNo">102</span> *<a name="line.102"></a> +<span class="sourceLineNo">103</span> * @param other<a name="line.103"></a> +<span class="sourceLineNo">104</span> * Another object<a name="line.104"></a> +<span class="sourceLineNo">105</span> * @return true if other is a Literal and is equal to this<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @see Object#equals(Object)<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> @Override<a name="line.108"></a> +<span class="sourceLineNo">109</span> public boolean equals(Object other);<a name="line.109"></a> +<span class="sourceLineNo">110</span><a name="line.110"></a> +<span class="sourceLineNo">111</span> /**<a name="line.111"></a> +<span class="sourceLineNo">112</span> * Calculate a hash code for this Literal.<a name="line.112"></a> +<span class="sourceLineNo">113</span> * <p><a name="line.113"></a> +<span class="sourceLineNo">114</span> * The returned hash code MUST be equal to the result of<a name="line.114"></a> +<span class="sourceLineNo">115</span> * {@link Objects#hash(Object...)} with the arguments<a name="line.115"></a> +<span class="sourceLineNo">116</span> * {@link #getLexicalForm()}, {@link #getDatatype()},<a name="line.116"></a> +<span class="sourceLineNo">117</span> * {@link #getLanguageTag()}.<a name="line.117"></a> +<span class="sourceLineNo">118</span> * <p><a name="line.118"></a> +<span class="sourceLineNo">119</span> * This method MUST be implemented in conjunction with<a name="line.119"></a> +<span class="sourceLineNo">120</span> * {@link #equals(Object)} so that two equal Literals produce the same hash<a name="line.120"></a> +<span class="sourceLineNo">121</span> * code.<a name="line.121"></a> +<span class="sourceLineNo">122</span> *<a name="line.122"></a> +<span class="sourceLineNo">123</span> * @return a hash code value for this Literal.<a name="line.123"></a> +<span class="sourceLineNo">124</span> * @see Object#hashCode()<a name="line.124"></a> +<span class="sourceLineNo">125</span> * @see Objects#hash(Object...)<a name="line.125"></a> +<span class="sourceLineNo">126</span> */<a name="line.126"></a> +<span class="sourceLineNo">127</span> @Override<a name="line.127"></a> +<span class="sourceLineNo">128</span> public int hashCode();<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> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> \ No newline at end of file
Added: websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/api/Quad.html ============================================================================== --- websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/api/Quad.html (added) +++ websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/api/Quad.html Thu Nov 17 14:45:34 2016 @@ -0,0 +1,312 @@ +<!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> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> +<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> +<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> +<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> +<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> +<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> +<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> +<span class="sourceLineNo">009</span> *<a name="line.9"></a> +<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> +<span class="sourceLineNo">011</span> *<a name="line.11"></a> +<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> +<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> +<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> +<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> +<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> +<span class="sourceLineNo">017</span> */<a name="line.17"></a> +<span class="sourceLineNo">018</span>package org.apache.commons.rdf.api;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.util.Objects;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.util.Optional;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>/**<a name="line.23"></a> +<span class="sourceLineNo">024</span> * A Quad is a statement in a<a name="line.24"></a> +<span class="sourceLineNo">025</span> * <a href= "http://www.w3.org/TR/rdf11-concepts/#section-dataset"; >RDF-1.1<a name="line.25"></a> +<span class="sourceLineNo">026</span> * Dataset</a>, as defined by <a href=<a name="line.26"></a> +<span class="sourceLineNo">027</span> * "https://www.w3.org/TR/2014/NOTE-rdf11-datasets-20140225/#quad-semantics";<a name="line.27"></a> +<span class="sourceLineNo">028</span> * >RDF-1.1 Concepts and Abstract Syntax</a>, a W3C Working Group Note published<a name="line.28"></a> +<span class="sourceLineNo">029</span> * on 25 February 2014.<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <p><a name="line.30"></a> +<span class="sourceLineNo">031</span> * A <code>Quad</code> object in Commons RDF is considered<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <strong>immutable</strong>, that is, over its life time it will have<a name="line.32"></a> +<span class="sourceLineNo">033</span> * consistent behaviour for its {@link #equals(Object)}, and the instances<a name="line.33"></a> +<span class="sourceLineNo">034</span> * returned from {@link #getGraphName()}, {@link #getSubject()},<a name="line.34"></a> +<span class="sourceLineNo">035</span> * {@link #getPredicate()}, {@link #getObject()} and {@link #asTriple()} will<a name="line.35"></a> +<span class="sourceLineNo">036</span> * have consistent {@link Object#equals(Object)} behaviour.<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <p><a name="line.37"></a> +<span class="sourceLineNo">038</span> * Note that <code>Quad</code> methods are not required to return object<a name="line.38"></a> +<span class="sourceLineNo">039</span> * identical (<code>==</code>) instances as long as they are equivalent<a name="line.39"></a> +<span class="sourceLineNo">040</span> * according to {@link Object#equals(Object)}. Specialisations of<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <code>Quad</code> may provide additional methods that are documented to be<a name="line.41"></a> +<span class="sourceLineNo">042</span> * mutable.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <p><a name="line.43"></a> +<span class="sourceLineNo">044</span> * <code>Quad</code> methods are <strong>thread-safe</strong>, however<a name="line.44"></a> +<span class="sourceLineNo">045</span> * specialisations may provide additional methods that are documented to not be<a name="line.45"></a> +<span class="sourceLineNo">046</span> * thread-safe.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <p><a name="line.47"></a> +<span class="sourceLineNo">048</span> * <code>Quad</code>s can be safely used in hashing collections like<a name="line.48"></a> +<span class="sourceLineNo">049</span> * {@link java.util.HashSet} and {@link java.util.HashMap}.<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <p><a name="line.50"></a> +<span class="sourceLineNo">051</span> * Any <code>Quad</code> can be used interchangeably across Commons RDF<a name="line.51"></a> +<span class="sourceLineNo">052</span> * implementations.<a name="line.52"></a> +<span class="sourceLineNo">053</span> *<a name="line.53"></a> +<span class="sourceLineNo">054</span> * @since 0.3.0-incubating<a name="line.54"></a> +<span class="sourceLineNo">055</span> * @see Dataset<a name="line.55"></a> +<span class="sourceLineNo">056</span> * @see RDF#createQuad(BlankNodeOrIRI,BlankNodeOrIRI,IRI,RDFTerm)<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @see <a href="http://www.w3.org/TR/2014/NOTE-rdf11-datasets-20140225/">RDF<a name="line.57"></a> +<span class="sourceLineNo">058</span> * 1.1: On Semantics of RDF Datasets</a><a name="line.58"></a> +<span class="sourceLineNo">059</span> * @see <a href="http://www.w3.org/TR/rdf11-concepts/#section-dataset"> </a><a name="line.59"></a> +<span class="sourceLineNo">060</span> */<a name="line.60"></a> +<span class="sourceLineNo">061</span>public interface Quad extends QuadLike<BlankNodeOrIRI> {<a name="line.61"></a> +<span class="sourceLineNo">062</span><a name="line.62"></a> +<span class="sourceLineNo">063</span> /**<a name="line.63"></a> +<span class="sourceLineNo">064</span> * The graph name (graph label) of this quad, if present.<a name="line.64"></a> +<span class="sourceLineNo">065</span> *<a name="line.65"></a> +<span class="sourceLineNo">066</span> * If {@link Optional#isPresent()}, then the {@link Optional#get()} is<a name="line.66"></a> +<span class="sourceLineNo">067</span> * either a {@link BlankNode} or an {@link IRI}, indicating the<a name="line.67"></a> +<span class="sourceLineNo">068</span> * <a href="https://www.w3.org/TR/rdf11-concepts/#dfn-named-graph">graph<a name="line.68"></a> +<span class="sourceLineNo">069</span> * name</a> of this Quad. If the graph name is not present, e.g. the value<a name="line.69"></a> +<span class="sourceLineNo">070</span> * is {@link Optional#empty()}, it indicates that this Quad is in the<a name="line.70"></a> +<span class="sourceLineNo">071</span> * <a href="https://www.w3.org/TR/rdf11-concepts/#dfn-default-graph">default<a name="line.71"></a> +<span class="sourceLineNo">072</span> * graph</a>.<a name="line.72"></a> +<span class="sourceLineNo">073</span> *<a name="line.73"></a> +<span class="sourceLineNo">074</span> * @return If {@link Optional#isPresent()}, the graph name<a name="line.74"></a> +<span class="sourceLineNo">075</span> * {@link BlankNodeOrIRI} of this quad, otherwise<a name="line.75"></a> +<span class="sourceLineNo">076</span> * {@link Optional#empty()}, indicating the default graph.<a name="line.76"></a> +<span class="sourceLineNo">077</span> *<a name="line.77"></a> +<span class="sourceLineNo">078</span> * @see <a href="https://www.w3.org/TR/rdf11-concepts/#dfn-rdf-dataset">RDF-<a name="line.78"></a> +<span class="sourceLineNo">079</span> * 1.1 Dataset</a><a name="line.79"></a> +<span class="sourceLineNo">080</span> */<a name="line.80"></a> +<span class="sourceLineNo">081</span> @Override<a name="line.81"></a> +<span class="sourceLineNo">082</span> Optional<BlankNodeOrIRI> getGraphName();<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> * The subject of this quad, which may be either a {@link BlankNode} or an<a name="line.85"></a> +<span class="sourceLineNo">086</span> * {@link IRI}, which are represented in Commons RDF by the interface<a name="line.86"></a> +<span class="sourceLineNo">087</span> * {@link BlankNodeOrIRI}.<a name="line.87"></a> +<span class="sourceLineNo">088</span> *<a name="line.88"></a> +<span class="sourceLineNo">089</span> * @return The subject {@link BlankNodeOrIRI} of this quad.<a name="line.89"></a> +<span class="sourceLineNo">090</span> * @see <a href="http://www.w3.org/TR/rdf11-concepts/#dfn-subject">RDF-1.1<a name="line.90"></a> +<span class="sourceLineNo">091</span> * Triple subject</a><a name="line.91"></a> +<span class="sourceLineNo">092</span> */<a name="line.92"></a> +<span class="sourceLineNo">093</span> @Override<a name="line.93"></a> +<span class="sourceLineNo">094</span> BlankNodeOrIRI getSubject();<a name="line.94"></a> +<span class="sourceLineNo">095</span><a name="line.95"></a> +<span class="sourceLineNo">096</span> /**<a name="line.96"></a> +<span class="sourceLineNo">097</span> * The predicate {@link IRI} of this quad.<a name="line.97"></a> +<span class="sourceLineNo">098</span> *<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @return The predicate {@link IRI} of this quad.<a name="line.99"></a> +<span class="sourceLineNo">100</span> * @see <a href="http://www.w3.org/TR/rdf11-concepts/#dfn-predicate">RDF-1.1<a name="line.100"></a> +<span class="sourceLineNo">101</span> * Triple predicate</a><a name="line.101"></a> +<span class="sourceLineNo">102</span> */<a name="line.102"></a> +<span class="sourceLineNo">103</span> @Override<a name="line.103"></a> +<span class="sourceLineNo">104</span> IRI getPredicate();<a name="line.104"></a> +<span class="sourceLineNo">105</span><a name="line.105"></a> +<span class="sourceLineNo">106</span> /**<a name="line.106"></a> +<span class="sourceLineNo">107</span> * The object of this quad, which may be either a {@link BlankNode}, an<a name="line.107"></a> +<span class="sourceLineNo">108</span> * {@link IRI}, or a {@link Literal}, which are represented in Commons RDF<a name="line.108"></a> +<span class="sourceLineNo">109</span> * by the interface {@link RDFTerm}.<a name="line.109"></a> +<span class="sourceLineNo">110</span> *<a name="line.110"></a> +<span class="sourceLineNo">111</span> * @return The object {@link RDFTerm} of this quad.<a name="line.111"></a> +<span class="sourceLineNo">112</span> * @see <a href="http://www.w3.org/TR/rdf11-concepts/#dfn-object">RDF-1.1<a name="line.112"></a> +<span class="sourceLineNo">113</span> * Triple object</a><a name="line.113"></a> +<span class="sourceLineNo">114</span> */<a name="line.114"></a> +<span class="sourceLineNo">115</span> @Override<a name="line.115"></a> +<span class="sourceLineNo">116</span> RDFTerm getObject();<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> /**<a name="line.118"></a> +<span class="sourceLineNo">119</span> * Adapt this Quad to a Triple.<a name="line.119"></a> +<span class="sourceLineNo">120</span> * <p><a name="line.120"></a> +<span class="sourceLineNo">121</span> * The returned {@link Triple} will have equivalent values returned from the<a name="line.121"></a> +<span class="sourceLineNo">122</span> * methods {@link TripleLike#getSubject()},<a name="line.122"></a> +<span class="sourceLineNo">123</span> * {@link TripleLike#getPredicate()} and {@link TripleLike#getObject()}.<a name="line.123"></a> +<span class="sourceLineNo">124</span> * <p><a name="line.124"></a> +<span class="sourceLineNo">125</span> * The returned {@link Triple} MUST NOT be {@link #equals(Object)} to this<a name="line.125"></a> +<span class="sourceLineNo">126</span> * {@link Quad}, even if this quad has a default graph<a name="line.126"></a> +<span class="sourceLineNo">127</span> * {@link #getGraphName()} value of {@link Optional#empty()}, but MUST<a name="line.127"></a> +<span class="sourceLineNo">128</span> * follow the {@link Triple#equals(Object)} semantics. This means that the<a name="line.128"></a> +<span class="sourceLineNo">129</span> * following MUST be true:<a name="line.129"></a> +<span class="sourceLineNo">130</span> *<a name="line.130"></a> +<span class="sourceLineNo">131</span> * <pre><a name="line.131"></a> +<span class="sourceLineNo">132</span> * Quad q1, q2;<a name="line.132"></a> +<span class="sourceLineNo">133</span> * if (q1.equals(q2)) {<a name="line.133"></a> +<span class="sourceLineNo">134</span> * assert (q1.asTriple().equals(q2.asTriple()));<a name="line.134"></a> +<span class="sourceLineNo">135</span> * } else if (q1.asTriple().equals(q2.asTriple())) {<a name="line.135"></a> +<span class="sourceLineNo">136</span> * assert (q1.getSubject().equals(q2.getSubject()));<a name="line.136"></a> +<span class="sourceLineNo">137</span> * assert (q1.getPredicate().equals(q2.getPredicate()));<a name="line.137"></a> +<span class="sourceLineNo">138</span> * assert (q1.getObject().equals(q2.getObject()));<a name="line.138"></a> +<span class="sourceLineNo">139</span> * assert (!q1.getGraphName().equals(q2.getGraphName()));<a name="line.139"></a> +<span class="sourceLineNo">140</span> * }<a name="line.140"></a> +<span class="sourceLineNo">141</span> * </pre><a name="line.141"></a> +<span class="sourceLineNo">142</span> *<a name="line.142"></a> +<span class="sourceLineNo">143</span> * The <code>default</code> implementation of this method return a proxy<a name="line.143"></a> +<span class="sourceLineNo">144</span> * {@link Triple} instance that keeps a reference to this {@link Quad} to<a name="line.144"></a> +<span class="sourceLineNo">145</span> * call the underlying {@link TripleLike} methods, but supplies a<a name="line.145"></a> +<span class="sourceLineNo">146</span> * {@link Triple} compatible implementation of {@link Triple#equals(Object)}<a name="line.146"></a> +<span class="sourceLineNo">147</span> * and {@link Triple#hashCode()}. Implementations may override this method,<a name="line.147"></a> +<span class="sourceLineNo">148</span> * e.g. for a more efficient solution.<a name="line.148"></a> +<span class="sourceLineNo">149</span> *<a name="line.149"></a> +<span class="sourceLineNo">150</span> * @return A {@link Triple} that contains the same {@link TripleLike}<a name="line.150"></a> +<span class="sourceLineNo">151</span> * properties as this Quad.<a name="line.151"></a> +<span class="sourceLineNo">152</span> */<a name="line.152"></a> +<span class="sourceLineNo">153</span> default Triple asTriple() {<a name="line.153"></a> +<span class="sourceLineNo">154</span> return new Triple() {<a name="line.154"></a> +<span class="sourceLineNo">155</span> @Override<a name="line.155"></a> +<span class="sourceLineNo">156</span> public BlankNodeOrIRI getSubject() {<a name="line.156"></a> +<span class="sourceLineNo">157</span> return Quad.this.getSubject();<a name="line.157"></a> +<span class="sourceLineNo">158</span> }<a name="line.158"></a> +<span class="sourceLineNo">159</span><a name="line.159"></a> +<span class="sourceLineNo">160</span> @Override<a name="line.160"></a> +<span class="sourceLineNo">161</span> public IRI getPredicate() {<a name="line.161"></a> +<span class="sourceLineNo">162</span> return Quad.this.getPredicate();<a name="line.162"></a> +<span class="sourceLineNo">163</span> }<a name="line.163"></a> +<span class="sourceLineNo">164</span><a name="line.164"></a> +<span class="sourceLineNo">165</span> @Override<a name="line.165"></a> +<span class="sourceLineNo">166</span> public RDFTerm getObject() {<a name="line.166"></a> +<span class="sourceLineNo">167</span> return Quad.this.getObject();<a name="line.167"></a> +<span class="sourceLineNo">168</span> }<a name="line.168"></a> +<span class="sourceLineNo">169</span><a name="line.169"></a> +<span class="sourceLineNo">170</span> @Override<a name="line.170"></a> +<span class="sourceLineNo">171</span> public boolean equals(final Object obj) {<a name="line.171"></a> +<span class="sourceLineNo">172</span> if (obj == this) {<a name="line.172"></a> +<span class="sourceLineNo">173</span> return true;<a name="line.173"></a> +<span class="sourceLineNo">174</span> }<a name="line.174"></a> +<span class="sourceLineNo">175</span> if (!(obj instanceof Triple)) {<a name="line.175"></a> +<span class="sourceLineNo">176</span> return false;<a name="line.176"></a> +<span class="sourceLineNo">177</span> }<a name="line.177"></a> +<span class="sourceLineNo">178</span> final Triple other = (Triple) obj;<a name="line.178"></a> +<span class="sourceLineNo">179</span> return Objects.equals(getSubject(), other.getSubject())<a name="line.179"></a> +<span class="sourceLineNo">180</span> && Objects.equals(getPredicate(), other.getPredicate())<a name="line.180"></a> +<span class="sourceLineNo">181</span> && Objects.equals(getObject(), other.getObject());<a name="line.181"></a> +<span class="sourceLineNo">182</span> }<a name="line.182"></a> +<span class="sourceLineNo">183</span><a name="line.183"></a> +<span class="sourceLineNo">184</span> @Override<a name="line.184"></a> +<span class="sourceLineNo">185</span> public int hashCode() {<a name="line.185"></a> +<span class="sourceLineNo">186</span> return Objects.hash(getSubject(), getPredicate(), getObject());<a name="line.186"></a> +<span class="sourceLineNo">187</span> }<a name="line.187"></a> +<span class="sourceLineNo">188</span> };<a name="line.188"></a> +<span class="sourceLineNo">189</span> }<a name="line.189"></a> +<span class="sourceLineNo">190</span><a name="line.190"></a> +<span class="sourceLineNo">191</span> /**<a name="line.191"></a> +<span class="sourceLineNo">192</span> * Check it this Quad is equal to another Quad.<a name="line.192"></a> +<span class="sourceLineNo">193</span> * <p><a name="line.193"></a> +<span class="sourceLineNo">194</span> * Two Quads are equal if and only if their {@link #getGraphName()},<a name="line.194"></a> +<span class="sourceLineNo">195</span> * {@link #getSubject()}, {@link #getPredicate()} and {@link #getObject()}<a name="line.195"></a> +<span class="sourceLineNo">196</span> * are equal.<a name="line.196"></a> +<span class="sourceLineNo">197</span> * </p><a name="line.197"></a> +<span class="sourceLineNo">198</span> * <p><a name="line.198"></a> +<span class="sourceLineNo">199</span> * Implementations MUST also override {@link #hashCode()} so that two equal<a name="line.199"></a> +<span class="sourceLineNo">200</span> * Quads produce the same hash code.<a name="line.200"></a> +<span class="sourceLineNo">201</span> * </p><a name="line.201"></a> +<span class="sourceLineNo">202</span> * <p><a name="line.202"></a> +<span class="sourceLineNo">203</span> * Note that a {@link Quad} MUST NOT be equal to a {@link Triple}, even if<a name="line.203"></a> +<span class="sourceLineNo">204</span> * this Quad's {@link #getGraphName()} is {@link Optional#empty()}. To test<a name="line.204"></a> +<span class="sourceLineNo">205</span> * triple-like equivalence, callers can use:<a name="line.205"></a> +<span class="sourceLineNo">206</span> * </p><a name="line.206"></a> +<span class="sourceLineNo">207</span> *<a name="line.207"></a> +<span class="sourceLineNo">208</span> * <pre><a name="line.208"></a> +<span class="sourceLineNo">209</span> * Quad q1;<a name="line.209"></a> +<span class="sourceLineNo">210</span> * Triple t2;<a name="line.210"></a> +<span class="sourceLineNo">211</span> * q1.asTriple().equals(t2));<a name="line.211"></a> +<span class="sourceLineNo">212</span> * </pre><a name="line.212"></a> +<span class="sourceLineNo">213</span> *<a name="line.213"></a> +<span class="sourceLineNo">214</span> * @param other<a name="line.214"></a> +<span class="sourceLineNo">215</span> * Another object<a name="line.215"></a> +<span class="sourceLineNo">216</span> * @return true if other is a Quad and is equal to this<a name="line.216"></a> +<span class="sourceLineNo">217</span> * @see Object#equals(Object)<a name="line.217"></a> +<span class="sourceLineNo">218</span> */<a name="line.218"></a> +<span class="sourceLineNo">219</span> @Override<a name="line.219"></a> +<span class="sourceLineNo">220</span> public boolean equals(Object other);<a name="line.220"></a> +<span class="sourceLineNo">221</span><a name="line.221"></a> +<span class="sourceLineNo">222</span> /**<a name="line.222"></a> +<span class="sourceLineNo">223</span> * Calculate a hash code for this Quad.<a name="line.223"></a> +<span class="sourceLineNo">224</span> * <p><a name="line.224"></a> +<span class="sourceLineNo">225</span> * The returned hash code MUST be equal to the result of<a name="line.225"></a> +<span class="sourceLineNo">226</span> * {@link Objects#hash(Object...)} with the arguments {@link #getSubject()},<a name="line.226"></a> +<span class="sourceLineNo">227</span> * {@link #getPredicate()}, {@link #getObject()}, {@link #getGraphName()}.<a name="line.227"></a> +<span class="sourceLineNo">228</span> * <p><a name="line.228"></a> +<span class="sourceLineNo">229</span> * This method MUST be implemented in conjunction with<a name="line.229"></a> +<span class="sourceLineNo">230</span> * {@link #equals(Object)} so that two equal {@link Quad}s produce the same<a name="line.230"></a> +<span class="sourceLineNo">231</span> * hash code.<a name="line.231"></a> +<span class="sourceLineNo">232</span> *<a name="line.232"></a> +<span class="sourceLineNo">233</span> * @return a hash code value for this Quad.<a name="line.233"></a> +<span class="sourceLineNo">234</span> * @see Object#hashCode()<a name="line.234"></a> +<span class="sourceLineNo">235</span> * @see Objects#hash(Object...)<a name="line.235"></a> +<span class="sourceLineNo">236</span> */<a name="line.236"></a> +<span class="sourceLineNo">237</span> @Override<a name="line.237"></a> +<span class="sourceLineNo">238</span> public int hashCode();<a name="line.238"></a> +<span class="sourceLineNo">239</span><a name="line.239"></a> +<span class="sourceLineNo">240</span>}<a name="line.240"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> \ No newline at end of file Added: websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/api/QuadLike.html ============================================================================== --- websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/api/QuadLike.html (added) +++ websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/api/QuadLike.html Thu Nov 17 14:45:34 2016 @@ -0,0 +1,128 @@ +<!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> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> +<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> +<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> +<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> +<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> +<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> +<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> +<span class="sourceLineNo">009</span> *<a name="line.9"></a> +<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> +<span class="sourceLineNo">011</span> *<a name="line.11"></a> +<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> +<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> +<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> +<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> +<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> +<span class="sourceLineNo">017</span> */<a name="line.17"></a> +<span class="sourceLineNo">018</span>package org.apache.commons.rdf.api;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.util.Optional;<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> * A generalised "quad-like" interface, extended by {@link Quad}.<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> +<span class="sourceLineNo">025</span> * A QuadLike statement has at least a {@link #getSubject()},<a name="line.25"></a> +<span class="sourceLineNo">026</span> * {@link #getPredicate()}, {@link #getObject()} and {@link #getGraphName()},<a name="line.26"></a> +<span class="sourceLineNo">027</span> * but unlike a {@link Quad} does not have a formalised<a name="line.27"></a> +<span class="sourceLineNo">028</span> * {@link Quad#equals(Object)} or {@link Quad#hashCode()} semantics and is not<a name="line.28"></a> +<span class="sourceLineNo">029</span> * required to be <em>immutable</em> or <em>thread-safe</em>. This interface can<a name="line.29"></a> +<span class="sourceLineNo">030</span> * also be used for <em>generalised quads</em> (e.g. a {@link BlankNode} as<a name="line.30"></a> +<span class="sourceLineNo">031</span> * predicate).<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <p><a name="line.32"></a> +<span class="sourceLineNo">033</span> * Implementations should specialise which specific {@link RDFTerm} types they<a name="line.33"></a> +<span class="sourceLineNo">034</span> * return by overriding {@link #getSubject()}, {@link #getPredicate()},<a name="line.34"></a> +<span class="sourceLineNo">035</span> * {@link #getObject()} and {@link #getGraphName()}.<a name="line.35"></a> +<span class="sourceLineNo">036</span> *<a name="line.36"></a> +<span class="sourceLineNo">037</span> * @since 0.3.0-incubating<a name="line.37"></a> +<span class="sourceLineNo">038</span> * @see Quad<a name="line.38"></a> +<span class="sourceLineNo">039</span> */<a name="line.39"></a> +<span class="sourceLineNo">040</span>public interface QuadLike<G extends RDFTerm> extends TripleLike {<a name="line.40"></a> +<span class="sourceLineNo">041</span><a name="line.41"></a> +<span class="sourceLineNo">042</span> /**<a name="line.42"></a> +<span class="sourceLineNo">043</span> * The graph name (graph label) of this statement, if present.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <p><a name="line.44"></a> +<span class="sourceLineNo">045</span> * If {@link Optional#isPresent()}, then the {@link Optional#get()} indicate<a name="line.45"></a> +<span class="sourceLineNo">046</span> * the graph name of this statement. If the graph name is not present,e.g.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * the value is {@link Optional#empty()}, it indicates that this Quad is in<a name="line.47"></a> +<span class="sourceLineNo">048</span> * the default graph.<a name="line.48"></a> +<span class="sourceLineNo">049</span> *<a name="line.49"></a> +<span class="sourceLineNo">050</span> * @return If {@link Optional#isPresent()}, the graph name of this quad,<a name="line.50"></a> +<span class="sourceLineNo">051</span> * otherwise {@link Optional#empty()}, indicating the default graph.<a name="line.51"></a> +<span class="sourceLineNo">052</span> * The graph name is typically an {@link IRI} or {@link BlankNode}.<a name="line.52"></a> +<span class="sourceLineNo">053</span> */<a name="line.53"></a> +<span class="sourceLineNo">054</span> Optional<G> getGraphName();<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> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> \ No newline at end of file Added: websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/api/RDF.html ============================================================================== --- websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/api/RDF.html (added) +++ websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/api/RDF.html Thu Nov 17 14:45:34 2016 @@ -0,0 +1,330 @@ +<!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> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> +<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> +<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> +<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> +<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> +<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> +<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> +<span class="sourceLineNo">009</span> *<a name="line.9"></a> +<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> +<span class="sourceLineNo">011</span> *<a name="line.11"></a> +<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> +<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> +<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> +<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> +<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> +<span class="sourceLineNo">017</span> */<a name="line.17"></a> +<span class="sourceLineNo">018</span>package org.apache.commons.rdf.api;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.io.Serializable;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.util.Locale;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>/**<a name="line.23"></a> +<span class="sourceLineNo">024</span> * A RDF implementation.<a name="line.24"></a> +<span class="sourceLineNo">025</span> * <p><a name="line.25"></a> +<span class="sourceLineNo">026</span> * A <code>RDF</code> implementation can create instances of the {@link RDFTerm}<a name="line.26"></a> +<span class="sourceLineNo">027</span> * types {@link IRI}, {@link BlankNode} and {@link Literal}, as well as creating<a name="line.27"></a> +<span class="sourceLineNo">028</span> * instances of the types {@link Triple}, {@link Quad}, {@link Graph} or<a name="line.28"></a> +<span class="sourceLineNo">029</span> * {@link Dataset}.<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <p><a name="line.30"></a> +<span class="sourceLineNo">031</span> * A <em>partial RDF implementation</em> should be clearly documented as such,<a name="line.31"></a> +<span class="sourceLineNo">032</span> * and may throw {@link UnsupportedOperationException} where applicable, e.g. if<a name="line.32"></a> +<span class="sourceLineNo">033</span> * it does not support creating {@link Dataset}s or {@link Quad}s.<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <p><a name="line.34"></a> +<span class="sourceLineNo">035</span> * Instances of <code>RDF</code> work like a factory for creating Commons RDF<a name="line.35"></a> +<span class="sourceLineNo">036</span> * instances. spezializations of this interface may also provide methods for<a name="line.36"></a> +<span class="sourceLineNo">037</span> * conversions from/to their underlying RDF framework.<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <p><a name="line.38"></a> +<span class="sourceLineNo">039</span> * If a factory method of a particular implementation does not allow or support<a name="line.39"></a> +<span class="sourceLineNo">040</span> * a provided parameter, e.g. because an IRI is considered invalid, then it<a name="line.40"></a> +<span class="sourceLineNo">041</span> * SHOULD throw {@link IllegalArgumentException}.<a name="line.41"></a> +<span class="sourceLineNo">042</span> *<a name="line.42"></a> +<span class="sourceLineNo">043</span> * @since 0.3.0-incubating<a name="line.43"></a> +<span class="sourceLineNo">044</span> * @see RDFTerm<a name="line.44"></a> +<span class="sourceLineNo">045</span> * @see Graph<a name="line.45"></a> +<span class="sourceLineNo">046</span> * @see Quad<a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span>public interface RDF {<a name="line.48"></a> +<span class="sourceLineNo">049</span><a name="line.49"></a> +<span class="sourceLineNo">050</span> /**<a name="line.50"></a> +<span class="sourceLineNo">051</span> * Create a new blank node.<a name="line.51"></a> +<span class="sourceLineNo">052</span> * <p><a name="line.52"></a> +<span class="sourceLineNo">053</span> * The returned blank node MUST NOT be equal to any existing<a name="line.53"></a> +<span class="sourceLineNo">054</span> * {@link BlankNode} instances according to<a name="line.54"></a> +<span class="sourceLineNo">055</span> * {@link BlankNode#equals(Object)}.<a name="line.55"></a> +<span class="sourceLineNo">056</span> *<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @return A new, unique {@link BlankNode}<a name="line.57"></a> +<span class="sourceLineNo">058</span> */<a name="line.58"></a> +<span class="sourceLineNo">059</span> public BlankNode createBlankNode();<a name="line.59"></a> +<span class="sourceLineNo">060</span><a name="line.60"></a> +<span class="sourceLineNo">061</span> /**<a name="line.61"></a> +<span class="sourceLineNo">062</span> * Create a blank node based on the given name.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * <p><a name="line.63"></a> +<span class="sourceLineNo">064</span> * All {@link BlankNode}s created with the given <code>name</code> <em>on a<a name="line.64"></a> +<span class="sourceLineNo">065</span> * particular instance</em> of <code>RDF</code> MUST be equivalent according<a name="line.65"></a> +<span class="sourceLineNo">066</span> * to {@link BlankNode#equals(Object)},<a name="line.66"></a> +<span class="sourceLineNo">067</span> * <p><a name="line.67"></a> +<span class="sourceLineNo">068</span> * The returned BlankNode MUST NOT be equal to <code>BlankNode</code><a name="line.68"></a> +<span class="sourceLineNo">069</span> * instances returned for any other <code>name</code> or those returned from<a name="line.69"></a> +<span class="sourceLineNo">070</span> * {@link #createBlankNode()}.<a name="line.70"></a> +<span class="sourceLineNo">071</span> * <p><a name="line.71"></a> +<span class="sourceLineNo">072</span> * The returned BlankNode SHOULD NOT be equivalent to any BlankNodes created<a name="line.72"></a> +<span class="sourceLineNo">073</span> * on a <em>different</em> <code>RDF</code> instance, e.g. different<a name="line.73"></a> +<span class="sourceLineNo">074</span> * instances of <code>RDF</code> should produce different blank nodes for<a name="line.74"></a> +<span class="sourceLineNo">075</span> * the same <code>name</code> unless they purposely are intending to create<a name="line.75"></a> +<span class="sourceLineNo">076</span> * equivalent {@link BlankNode} instances (e.g. a reinstated<a name="line.76"></a> +<span class="sourceLineNo">077</span> * {@link Serializable} factory).<a name="line.77"></a> +<span class="sourceLineNo">078</span> *<a name="line.78"></a> +<span class="sourceLineNo">079</span> * @param name<a name="line.79"></a> +<span class="sourceLineNo">080</span> * A non-empty, non-null, String that is unique to this blank<a name="line.80"></a> +<span class="sourceLineNo">081</span> * node in the context of this {@link RDF}.<a name="line.81"></a> +<span class="sourceLineNo">082</span> * @return A BlankNode for the given name<a name="line.82"></a> +<span class="sourceLineNo">083</span> */<a name="line.83"></a> +<span class="sourceLineNo">084</span> public BlankNode createBlankNode(String name);<a name="line.84"></a> +<span class="sourceLineNo">085</span><a name="line.85"></a> +<span class="sourceLineNo">086</span> /**<a name="line.86"></a> +<span class="sourceLineNo">087</span> * Create a new graph.<a name="line.87"></a> +<span class="sourceLineNo">088</span> *<a name="line.88"></a> +<span class="sourceLineNo">089</span> * It is undefined if the graph will be persisted by any underlying storage<a name="line.89"></a> +<span class="sourceLineNo">090</span> * mechanism.<a name="line.90"></a> +<span class="sourceLineNo">091</span> *<a name="line.91"></a> +<span class="sourceLineNo">092</span> * @return A new Graph<a name="line.92"></a> +<span class="sourceLineNo">093</span> */<a name="line.93"></a> +<span class="sourceLineNo">094</span> public Graph createGraph();<a name="line.94"></a> +<span class="sourceLineNo">095</span><a name="line.95"></a> +<span class="sourceLineNo">096</span> /**<a name="line.96"></a> +<span class="sourceLineNo">097</span> * Create a new dataset.<a name="line.97"></a> +<span class="sourceLineNo">098</span> *<a name="line.98"></a> +<span class="sourceLineNo">099</span> * It is undefined if the dataset will be persisted by any underlying<a name="line.99"></a> +<span class="sourceLineNo">100</span> * storage mechanism.<a name="line.100"></a> +<span class="sourceLineNo">101</span> *<a name="line.101"></a> +<span class="sourceLineNo">102</span> * @return A new Dataset<a name="line.102"></a> +<span class="sourceLineNo">103</span> */<a name="line.103"></a> +<span class="sourceLineNo">104</span> public Dataset createDataset();<a name="line.104"></a> +<span class="sourceLineNo">105</span><a name="line.105"></a> +<span class="sourceLineNo">106</span> /**<a name="line.106"></a> +<span class="sourceLineNo">107</span> * Create an IRI from a (possibly escaped) String.<a name="line.107"></a> +<span class="sourceLineNo">108</span> *<a name="line.108"></a> +<span class="sourceLineNo">109</span> * The provided iri string MUST be valid according to the<a name="line.109"></a> +<span class="sourceLineNo">110</span> * <a href="http://www.w3.org/TR/rdf11-concepts/#dfn-iri">W3C RDF-1.1<a name="line.110"></a> +<span class="sourceLineNo">111</span> * IRI</a> definition.<a name="line.111"></a> +<span class="sourceLineNo">112</span> *<a name="line.112"></a> +<span class="sourceLineNo">113</span> * @param iri<a name="line.113"></a> +<span class="sourceLineNo">114</span> * Internationalized Resource Identifier<a name="line.114"></a> +<span class="sourceLineNo">115</span> * @return A new IRI<a name="line.115"></a> +<span class="sourceLineNo">116</span> * @throws IllegalArgumentException<a name="line.116"></a> +<span class="sourceLineNo">117</span> * If the provided string is not acceptable, e.g. does not<a name="line.117"></a> +<span class="sourceLineNo">118</span> * conform to the RFC3987 syntax.<a name="line.118"></a> +<span class="sourceLineNo">119</span> */<a name="line.119"></a> +<span class="sourceLineNo">120</span> public IRI createIRI(String iri) throws IllegalArgumentException;<a name="line.120"></a> +<span class="sourceLineNo">121</span><a name="line.121"></a> +<span class="sourceLineNo">122</span> /**<a name="line.122"></a> +<span class="sourceLineNo">123</span> * Create a simple literal.<a name="line.123"></a> +<span class="sourceLineNo">124</span> *<a name="line.124"></a> +<span class="sourceLineNo">125</span> * The provided lexical form should not be escaped in any sense, e.g. should<a name="line.125"></a> +<span class="sourceLineNo">126</span> * not include "quotes" unless those are part of the literal value.<a name="line.126"></a> +<span class="sourceLineNo">127</span> *<a name="line.127"></a> +<span class="sourceLineNo">128</span> * The returned Literal MUST have a {@link Literal#getLexicalForm()} that is<a name="line.128"></a> +<span class="sourceLineNo">129</span> * equal to the provided lexical form, MUST NOT have a<a name="line.129"></a> +<span class="sourceLineNo">130</span> * {@link Literal#getLanguageTag()} present, and SHOULD return a<a name="line.130"></a> +<span class="sourceLineNo">131</span> * {@link Literal#getDatatype()} that is equal to the IRI<a name="line.131"></a> +<span class="sourceLineNo">132</span> * <code>http://www.w3.org/2001/XMLSchema#string</code>.<a name="line.132"></a> +<span class="sourceLineNo">133</span> *<a name="line.133"></a> +<span class="sourceLineNo">134</span> * @param lexicalForm<a name="line.134"></a> +<span class="sourceLineNo">135</span> * The literal value in plain text<a name="line.135"></a> +<span class="sourceLineNo">136</span> * @return The created Literal<a name="line.136"></a> +<span class="sourceLineNo">137</span> * @throws IllegalArgumentException<a name="line.137"></a> +<span class="sourceLineNo">138</span> * If the provided lexicalForm is not acceptable, e.g. because<a name="line.138"></a> +<span class="sourceLineNo">139</span> * it is too large for an underlying storage.<a name="line.139"></a> +<span class="sourceLineNo">140</span> */<a name="line.140"></a> +<span class="sourceLineNo">141</span> public Literal createLiteral(String lexicalForm) throws IllegalArgumentException;<a name="line.141"></a> +<span class="sourceLineNo">142</span><a name="line.142"></a> +<span class="sourceLineNo">143</span> /**<a name="line.143"></a> +<span class="sourceLineNo">144</span> * Create a literal with the specified data type.<a name="line.144"></a> +<span class="sourceLineNo">145</span> *<a name="line.145"></a> +<span class="sourceLineNo">146</span> * The provided lexical form should not be escaped in any sense, e.g. should<a name="line.146"></a> +<span class="sourceLineNo">147</span> * not include "quotes" unless those are part of the literal value.<a name="line.147"></a> +<span class="sourceLineNo">148</span> *<a name="line.148"></a> +<span class="sourceLineNo">149</span> * It is RECOMMENDED that the provided dataType is one of the <a href=<a name="line.149"></a> +<span class="sourceLineNo">150</span> * "http://www.w3.org/TR/rdf11-concepts/#xsd-datatypes">RDF-compatible XSD<a name="line.150"></a> +<span class="sourceLineNo">151</span> * types</a>.<a name="line.151"></a> +<span class="sourceLineNo">152</span> *<a name="line.152"></a> +<span class="sourceLineNo">153</span> * The provided lexical form SHOULD be in the<a name="line.153"></a> +<span class="sourceLineNo">154</span> * <a href="http://www.w3.org/TR/rdf11-concepts/#dfn-lexical-space">lexical<a name="line.154"></a> +<span class="sourceLineNo">155</span> * space</a> of the provided dataType.<a name="line.155"></a> +<span class="sourceLineNo">156</span> *<a name="line.156"></a> +<span class="sourceLineNo">157</span> * The returned Literal SHOULD have a {@link Literal#getLexicalForm()} that<a name="line.157"></a> +<span class="sourceLineNo">158</span> * is equal to the provided lexicalForm, MUST NOT have a<a name="line.158"></a> +<span class="sourceLineNo">159</span> * {@link Literal#getLanguageTag()} present, and MUST return a<a name="line.159"></a> +<span class="sourceLineNo">160</span> * {@link Literal#getDatatype()} that is equivalent to the provided dataType<a name="line.160"></a> +<span class="sourceLineNo">161</span> * IRI.<a name="line.161"></a> +<span class="sourceLineNo">162</span> *<a name="line.162"></a> +<span class="sourceLineNo">163</span> * @param lexicalForm<a name="line.163"></a> +<span class="sourceLineNo">164</span> * The literal value<a name="line.164"></a> +<span class="sourceLineNo">165</span> * @param dataType<a name="line.165"></a> +<span class="sourceLineNo">166</span> * The data type IRI for the literal value, e.g.<a name="line.166"></a> +<span class="sourceLineNo">167</span> * <code>http://www.w3.org/2001/XMLSchema#integer</code><a name="line.167"></a> +<span class="sourceLineNo">168</span> * @return The created Literal<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @throws IllegalArgumentException<a name="line.169"></a> +<span class="sourceLineNo">170</span> * If any of the provided arguments are not acceptable, e.g.<a name="line.170"></a> +<span class="sourceLineNo">171</span> * because the provided dataType is not permitted.<a name="line.171"></a> +<span class="sourceLineNo">172</span> */<a name="line.172"></a> +<span class="sourceLineNo">173</span> public Literal createLiteral(String lexicalForm, IRI dataType) throws IllegalArgumentException;<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> * Create a language-tagged literal.<a name="line.176"></a> +<span class="sourceLineNo">177</span> *<a name="line.177"></a> +<span class="sourceLineNo">178</span> * The provided lexical form should not be escaped in any sense, e.g. should<a name="line.178"></a> +<span class="sourceLineNo">179</span> * not include "quotes" unless those are part of the literal value.<a name="line.179"></a> +<span class="sourceLineNo">180</span> *<a name="line.180"></a> +<span class="sourceLineNo">181</span> * The provided language tag MUST be valid according to<a name="line.181"></a> +<span class="sourceLineNo">182</span> * <a href="http://tools.ietf.org/html/bcp47">BCP47</a>, e.g.<a name="line.182"></a> +<span class="sourceLineNo">183</span> * <code>en</code>.<a name="line.183"></a> +<span class="sourceLineNo">184</span> *<a name="line.184"></a> +<span class="sourceLineNo">185</span> * The provided language tag<a name="line.185"></a> +<span class="sourceLineNo">186</span> * <a href="http://www.w3.org/TR/rdf11-concepts/#dfn-language-tagged-string";<a name="line.186"></a> +<span class="sourceLineNo">187</span> * >MAY be converted to lower case</a>.<a name="line.187"></a> +<span class="sourceLineNo">188</span> *<a name="line.188"></a> +<span class="sourceLineNo">189</span> * The returned Literal SHOULD have a {@link Literal#getLexicalForm()} which<a name="line.189"></a> +<span class="sourceLineNo">190</span> * is equal to the provided lexicalForm, MUST return a<a name="line.190"></a> +<span class="sourceLineNo">191</span> * {@link Literal#getDatatype()} that is equal to the IRI<a name="line.191"></a> +<span class="sourceLineNo">192</span> * <code>http://www.w3.org/1999/02/22-rdf-syntax-ns#langString</code>, and<a name="line.192"></a> +<span class="sourceLineNo">193</span> * MUST have a {@link Literal#getLanguageTag()} present which SHOULD be<a name="line.193"></a> +<span class="sourceLineNo">194</span> * equal to the provided language tag (compared as<a name="line.194"></a> +<span class="sourceLineNo">195</span> * {@link String#toLowerCase(Locale)} using {@link Locale#ENGLISH}).<a name="line.195"></a> +<span class="sourceLineNo">196</span> *<a name="line.196"></a> +<span class="sourceLineNo">197</span> * @param lexicalForm<a name="line.197"></a> +<span class="sourceLineNo">198</span> * The literal value<a name="line.198"></a> +<span class="sourceLineNo">199</span> * @param languageTag<a name="line.199"></a> +<span class="sourceLineNo">200</span> * The non-empty language tag as defined by<a name="line.200"></a> +<span class="sourceLineNo">201</span> * <a href="http://tools.ietf.org/html/bcp47">BCP47</a><a name="line.201"></a> +<span class="sourceLineNo">202</span> * @return The created Literal<a name="line.202"></a> +<span class="sourceLineNo">203</span> * @throws IllegalArgumentException<a name="line.203"></a> +<span class="sourceLineNo">204</span> * If the provided values are not acceptable, e.g. because the<a name="line.204"></a> +<span class="sourceLineNo">205</span> * languageTag was syntactically invalid.<a name="line.205"></a> +<span class="sourceLineNo">206</span> */<a name="line.206"></a> +<span class="sourceLineNo">207</span> public Literal createLiteral(String lexicalForm, String languageTag) throws IllegalArgumentException;<a name="line.207"></a> +<span class="sourceLineNo">208</span><a name="line.208"></a> +<span class="sourceLineNo">209</span> /**<a name="line.209"></a> +<span class="sourceLineNo">210</span> * Create a triple.<a name="line.210"></a> +<span class="sourceLineNo">211</span> *<a name="line.211"></a> +<span class="sourceLineNo">212</span> * The returned Triple SHOULD have a {@link Triple#getSubject()} that is<a name="line.212"></a> +<span class="sourceLineNo">213</span> * equal to the provided subject, a {@link Triple#getPredicate()} that is<a name="line.213"></a> +<span class="sourceLineNo">214</span> * equal to the provided predicate, and a {@link Triple#getObject()} that is<a name="line.214"></a> +<span class="sourceLineNo">215</span> * equal to the provided object.<a name="line.215"></a> +<span class="sourceLineNo">216</span> *<a name="line.216"></a> +<span class="sourceLineNo">217</span> * @param subject<a name="line.217"></a> +<span class="sourceLineNo">218</span> * The IRI or BlankNode that is the subject of the triple<a name="line.218"></a> +<span class="sourceLineNo">219</span> * @param predicate<a name="line.219"></a> +<span class="sourceLineNo">220</span> * The IRI that is the predicate of the triple<a name="line.220"></a> +<span class="sourceLineNo">221</span> * @param object<a name="line.221"></a> +<span class="sourceLineNo">222</span> * The IRI, BlankNode or Literal that is the object of the triple<a name="line.222"></a> +<span class="sourceLineNo">223</span> * @return The created Triple<a name="line.223"></a> +<span class="sourceLineNo">224</span> * @throws IllegalArgumentException<a name="line.224"></a> +<span class="sourceLineNo">225</span> * If any of the provided arguments are not acceptable, e.g.<a name="line.225"></a> +<span class="sourceLineNo">226</span> * because a Literal has a lexicalForm that is too large for an<a name="line.226"></a> +<span class="sourceLineNo">227</span> * underlying storage.<a name="line.227"></a> +<span class="sourceLineNo">228</span> */<a name="line.228"></a> +<span class="sourceLineNo">229</span> public Triple createTriple(BlankNodeOrIRI subject, IRI predicate, RDFTerm object) throws IllegalArgumentException;<a name="line.229"></a> +<span class="sourceLineNo">230</span><a name="line.230"></a> +<span class="sourceLineNo">231</span> /**<a name="line.231"></a> +<span class="sourceLineNo">232</span> * Create a quad.<a name="line.232"></a> +<span class="sourceLineNo">233</span> * <p><a name="line.233"></a> +<span class="sourceLineNo">234</span> * The returned Quad SHOULD have a {@link Quad#getGraphName()} that is equal<a name="line.234"></a> +<span class="sourceLineNo">235</span> * to the provided graphName, a {@link Quad#getSubject()} that is equal to<a name="line.235"></a> +<span class="sourceLineNo">236</span> * the provided subject, a {@link Quad#getPredicate()} that is equal to the<a name="line.236"></a> +<span class="sourceLineNo">237</span> * provided predicate, and a {@link Quad#getObject()} that is equal to the<a name="line.237"></a> +<span class="sourceLineNo">238</span> * provided object.<a name="line.238"></a> +<span class="sourceLineNo">239</span> *<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @param graphName<a name="line.240"></a> +<span class="sourceLineNo">241</span> * The IRI or BlankNode that this quad belongs to, or<a name="line.241"></a> +<span class="sourceLineNo">242</span> * <code>null</code> for the public graph<a name="line.242"></a> +<span class="sourceLineNo">243</span> * @param subject<a name="line.243"></a> +<span class="sourceLineNo">244</span> * The IRI or BlankNode that is the subject of the quad<a name="line.244"></a> +<span class="sourceLineNo">245</span> * @param predicate<a name="line.245"></a> +<span class="sourceLineNo">246</span> * The IRI that is the predicate of the quad<a name="line.246"></a> +<span class="sourceLineNo">247</span> * @param object<a name="line.247"></a> +<span class="sourceLineNo">248</span> * The IRI, BlankNode or Literal that is the object of the quad<a name="line.248"></a> +<span class="sourceLineNo">249</span> * @return The created Quad<a name="line.249"></a> +<span class="sourceLineNo">250</span> * @throws IllegalArgumentException<a name="line.250"></a> +<span class="sourceLineNo">251</span> * If any of the provided arguments are not acceptable, e.g.<a name="line.251"></a> +<span class="sourceLineNo">252</span> * because a Literal has a lexicalForm that is too large for an<a name="line.252"></a> +<span class="sourceLineNo">253</span> * underlying storage.<a name="line.253"></a> +<span class="sourceLineNo">254</span> */<a name="line.254"></a> +<span class="sourceLineNo">255</span> public Quad createQuad(BlankNodeOrIRI graphName, BlankNodeOrIRI subject, IRI predicate, RDFTerm object)<a name="line.255"></a> +<span class="sourceLineNo">256</span> throws IllegalArgumentException;<a name="line.256"></a> +<span class="sourceLineNo">257</span><a name="line.257"></a> +<span class="sourceLineNo">258</span>}<a name="line.258"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> \ No newline at end of file
