You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commonsrdf.apache.org by st...@apache.org on 2016/06/20 11:29:40 UTC
[4/5] incubator-commonsrdf git commit: javadoc on rdf4j implementation
javadoc on rdf4j implementation
Project: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/commit/8ef35e6c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/tree/8ef35e6c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/diff/8ef35e6c
Branch: refs/heads/rdf4j
Commit: 8ef35e6c0bec86207de97707701ae5add7bd09ce
Parents: 01ae8d9
Author: Stian Soiland-Reyes <st...@apache.org>
Authored: Mon Jun 20 12:28:42 2016 +0100
Committer: Stian Soiland-Reyes <st...@apache.org>
Committed: Mon Jun 20 12:29:08 2016 +0100
----------------------------------------------------------------------
.../apache/commons/rdf/rdf4j/package-info.java | 31 ++++++++++++++++++--
1 file changed, 29 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/8ef35e6c/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/package-info.java
----------------------------------------------------------------------
diff --git a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/package-info.java b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/package-info.java
index b8ad947..844da5a 100644
--- a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/package-info.java
+++ b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/package-info.java
@@ -18,9 +18,36 @@
/**
* Commons RDF integration with <a href="http://rdf4j.org/">RDF4J</a>.
* <p>
+ * Use the {@link org.apache.commons.rdf.rdf4j.RDF4JTermFactory} to convert
+ * between Commons RDF and RDF4J types, for instance
+ * {@link org.apache.commons.rdf.rdf4j.RDF4JTermFactory#asQuad(org.eclipse.rdf4j.model.Statement)}
+ * converts a RDF4J {@link org.eclipse.rdf4j.model.Statement} to a
+ * {@link org.apache.commons.rdf.api.Quad}. Converted RDF terms implement the
+ * {@link org.apache.commons.rdf.rdf4j.RDF4JTerm} interface, and converted
+ * statements the {@link org.apache.commons.rdf.rdf4j.RDF4JTripleLike}
+ * interface, which provide convenience access to the underlying RDF4J
+ * implementations.
+ * <p>
+ * RDF4J {@link org.eclipse.rdf4j.model.Model}s and
+ * {@link org.eclipse.rdf4j.repository.Repository} instances can be adapted to
+ * Commons RDF {@link org.apache.commons.rdf.api.Graph} and
+ * {@link org.apache.commons.rdf.api.Dataset}, e.g. using
+ * {@link org.apache.commons.rdf.rdf4j.RDF4JTermFactory#asRDFTermGraph(org.eclipse.rdf4j.model.Model)}
+ * or
+ * {@link org.apache.commons.rdf.rdf4j.RDF4JTermFactory#asRDFTermDataset(org.eclipse.rdf4j.repository.Repository)}.
+ * The returned adapted graph/dataset is directly mapped, so changes are
+ * propagated both ways. For convenience, the marker interface
+ * {@link org.apache.commons.rdf.rdf4j.RDF4JGraph} and
+ * {@link org.apache.commons.rdf.rdf4j.RDF4JDataset} provide access to the
+ * underlying RDF4J implementations.
+ * <p>
+ * The {@link org.apache.commons.rdf.rdf4j.RDF4JParserBuilder} can be used to
+ * parse RDF files using RDF4j. It should be most efficient if used with
+ * {@link org.apache.commons.rdf.rdf4j.RDF4JParserBuilder#target(org.apache.commons.rdf.api.Dataset)}
+ * and an adapted {@link org.apache.commons.rdf.rdf4j.RDF4JDataset}, or
+ * {@link org.apache.commons.rdf.rdf4j.RDF4JParserBuilder#target(org.apache.commons.rdf.api.Graph)}
+ * and a an adapted {@link org.apache.commons.rdf.rdf4j.RDF4JGraph}
*
*
*/
package org.apache.commons.rdf.rdf4j;
-
-