You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by an...@apache.org on 2017/03/08 11:30:26 UTC

jena git commit: Document in comments the sequence for model.write and calling RDF/XML.

Repository: jena
Updated Branches:
  refs/heads/master 42a3da72f -> c5c15bb25


Document in comments the sequence for model.write and calling RDF/XML.


Project: http://git-wip-us.apache.org/repos/asf/jena/repo
Commit: http://git-wip-us.apache.org/repos/asf/jena/commit/c5c15bb2
Tree: http://git-wip-us.apache.org/repos/asf/jena/tree/c5c15bb2
Diff: http://git-wip-us.apache.org/repos/asf/jena/diff/c5c15bb2

Branch: refs/heads/master
Commit: c5c15bb2517092430396980bc20d2b2801f9d081
Parents: 42a3da7
Author: Andy Seaborne <an...@apache.org>
Authored: Wed Mar 8 11:30:15 2017 +0000
Committer: Andy Seaborne <an...@apache.org>
Committed: Wed Mar 8 11:30:15 2017 +0000

----------------------------------------------------------------------
 .../org/apache/jena/riot/RDFWriterRegistry.java | 42 ++++++++++++--------
 .../main/java/org/apache/jena/riot/SysRIOT.java | 12 +++++-
 .../jena/riot/adapters/AdapterRDFWriter.java    | 12 +++++-
 .../jena/riot/adapters/RDFWriterRIOT.java       | 12 +++++-
 4 files changed, 56 insertions(+), 22 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/jena/blob/c5c15bb2/jena-arq/src/main/java/org/apache/jena/riot/RDFWriterRegistry.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/riot/RDFWriterRegistry.java b/jena-arq/src/main/java/org/apache/jena/riot/RDFWriterRegistry.java
index 6c3ce82..d331c1d 100644
--- a/jena-arq/src/main/java/org/apache/jena/riot/RDFWriterRegistry.java
+++ b/jena-arq/src/main/java/org/apache/jena/riot/RDFWriterRegistry.java
@@ -21,7 +21,6 @@ package org.apache.jena.riot;
 import java.util.* ;
 
 import org.apache.jena.atlas.lib.CharSpace ;
-import org.apache.jena.n3.N3JenaWriter ;
 import org.apache.jena.riot.system.RiotLib ;
 import org.apache.jena.riot.thrift.WriterDatasetThrift ;
 import org.apache.jena.riot.thrift.WriterGraphThrift ;
@@ -242,22 +241,31 @@ public class RDFWriterRegistry
          return mapJenaNameToFormat.keySet();
      }
 
-     private static void setup() {
-         setFormatForJenaWriter("RDF/XML",                           RDFFormat.RDFXML_PLAIN) ;
-         setFormatForJenaWriter("RDF/XML-ABBREV",                    RDFFormat.RDFXML_ABBREV) ;
-         setFormatForJenaWriter("N-TRIPLE",                          RDFFormat.NTRIPLES) ;
-         setFormatForJenaWriter("NT",                                RDFFormat.NTRIPLES) ;
-         setFormatForJenaWriter("N-TRIPLES",                         RDFFormat.NTRIPLES) ;
-         setFormatForJenaWriter("N-Triples",                         RDFFormat.NTRIPLES) ;
-         setFormatForJenaWriter("N3",                                RDFFormat.TURTLE) ;
-         setFormatForJenaWriter(N3JenaWriter.n3WriterPrettyPrinter,  RDFFormat.TURTLE_PRETTY) ;
-         setFormatForJenaWriter(N3JenaWriter.n3WriterPlain,          RDFFormat.TURTLE_BLOCKS) ;
-         setFormatForJenaWriter(N3JenaWriter.n3WriterTriples,        RDFFormat.TURTLE_FLAT) ;
-         setFormatForJenaWriter(N3JenaWriter.n3WriterTriplesAlt,     RDFFormat.TURTLE_FLAT) ;
-         setFormatForJenaWriter(N3JenaWriter.turtleWriter,           RDFFormat.TURTLE) ;
-         setFormatForJenaWriter(N3JenaWriter.turtleWriterAlt1,       RDFFormat.TURTLE) ;
-         setFormatForJenaWriter(N3JenaWriter.turtleWriterAlt2,       RDFFormat.TURTLE) ;
-     }
+     // Unused; not called from init$()
+     // These settings are used by RDFWriterRIOT to override RDFWriterRegistrations.
+     
+     // The only difference is "RDF/XML" being plain here but pretty
+     // as registered.
+     // 2017-03:
+     // The number of user questions on format of RDF/XML not being pretty
+     // has dropped off since Jena2.  
+     
+//     private static void setupJenaNames() {
+//         setFormatForJenaWriter("RDF/XML",                           RDFFormat.RDFXML_PLAIN) ;
+//         setFormatForJenaWriter("RDF/XML-ABBREV",                    RDFFormat.RDFXML_ABBREV) ;
+//         setFormatForJenaWriter("N-TRIPLE",                          RDFFormat.NTRIPLES) ;
+//         setFormatForJenaWriter("NT",                                RDFFormat.NTRIPLES) ;
+//         setFormatForJenaWriter("N-TRIPLES",                         RDFFormat.NTRIPLES) ;
+//         setFormatForJenaWriter("N-Triples",                         RDFFormat.NTRIPLES) ;
+//         setFormatForJenaWriter("N3",                                RDFFormat.TURTLE) ;
+//         setFormatForJenaWriter(N3JenaWriter.n3WriterPrettyPrinter,  RDFFormat.TURTLE_PRETTY) ;
+//         setFormatForJenaWriter(N3JenaWriter.n3WriterPlain,          RDFFormat.TURTLE_BLOCKS) ;
+//         setFormatForJenaWriter(N3JenaWriter.n3WriterTriples,        RDFFormat.TURTLE_FLAT) ;
+//         setFormatForJenaWriter(N3JenaWriter.n3WriterTriplesAlt,     RDFFormat.TURTLE_FLAT) ;
+//         setFormatForJenaWriter(N3JenaWriter.turtleWriter,           RDFFormat.TURTLE) ;
+//         setFormatForJenaWriter(N3JenaWriter.turtleWriterAlt1,       RDFFormat.TURTLE) ;
+//         setFormatForJenaWriter(N3JenaWriter.turtleWriterAlt2,       RDFFormat.TURTLE) ;
+//     }
 
      
     /** Register the serialization for graphs and it's associated factory

http://git-wip-us.apache.org/repos/asf/jena/blob/c5c15bb2/jena-arq/src/main/java/org/apache/jena/riot/SysRIOT.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/riot/SysRIOT.java b/jena-arq/src/main/java/org/apache/jena/riot/SysRIOT.java
index e0d8924..831e8b5 100644
--- a/jena-arq/src/main/java/org/apache/jena/riot/SysRIOT.java
+++ b/jena-arq/src/main/java/org/apache/jena/riot/SysRIOT.java
@@ -19,7 +19,9 @@
 package org.apache.jena.riot;
 
 import org.apache.jena.atlas.lib.IRILib ;
+import org.apache.jena.rdf.model.RDFWriter;
 import org.apache.jena.riot.system.IRIResolver ;
+import org.apache.jena.sparql.util.Context;
 import org.apache.jena.sparql.util.Symbol ;
 import org.apache.jena.util.FileUtils ;
 import org.slf4j.Logger ;
@@ -30,7 +32,7 @@ public class SysRIOT
     public static final String riotLoggerName = "org.apache.jena.riot" ;
     private static Logger riotLogger = LoggerFactory.getLogger(riotLoggerName) ;
     
-    /** @deprecated Do not use - lexicial forms are always strict. */
+    /** @deprecated Do not use - lexical forms are always strict. */
     @Deprecated
     public static boolean StrictXSDLexicialForms      = false ;
     
@@ -45,7 +47,13 @@ public class SysRIOT
     public static final boolean AbsURINoNormalization   = false ;
     public static final String BNodeGenIdPrefix         = "genid" ;
     
-    /** Context key for old style RDFWriter properties */ 
+    /**
+     * Context key for old style RDFWriter properties. The value of this in a
+     * {@link Context} must be a {@code Map<String, Object>}. The entries of the
+     * map are used to set writer properties before the Jena legalacy
+     * {@link RDFWriter} is called. Only has any effect on RDF/XML and
+     * RDF/XML-ABBREV.
+     */
     public static final Symbol rdfWriterProperties      = Symbol.create("riot.rdfWriter_properties") ;
     
     public static void setStrictMode(boolean state) {

http://git-wip-us.apache.org/repos/asf/jena/blob/c5c15bb2/jena-arq/src/main/java/org/apache/jena/riot/adapters/AdapterRDFWriter.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/riot/adapters/AdapterRDFWriter.java b/jena-arq/src/main/java/org/apache/jena/riot/adapters/AdapterRDFWriter.java
index 4eae2e5..cd0ba69 100644
--- a/jena-arq/src/main/java/org/apache/jena/riot/adapters/AdapterRDFWriter.java
+++ b/jena-arq/src/main/java/org/apache/jena/riot/adapters/AdapterRDFWriter.java
@@ -28,12 +28,20 @@ import org.apache.jena.rdf.model.ModelFactory ;
 import org.apache.jena.rdf.model.RDFWriter ;
 import org.apache.jena.riot.Lang ;
 import org.apache.jena.riot.SysRIOT ;
+import org.apache.jena.riot.WriterGraphRIOT ;
 import org.apache.jena.riot.system.PrefixMap ;
 import org.apache.jena.riot.writer.WriterGraphRIOTBase ;
 import org.apache.jena.sparql.util.Context ;
 
-/** Wrapper for using old-style Jena RDFWriters in RIOT. */
-
+/**
+ * Adapter providing RIOT interface {@link WriterGraphRIOT} over an old-style
+ * Jena {@link RDFWriter}. Subclasses of this class are used for RDF/XML
+ * (basic and abbrevated) in RIOT.
+ * <p>
+ * See {@link RDFWriterRIOT} for the class plugged into RIOT that provides the
+ * {@link RDFWriter} interface to Jena core operations. It is {@link RDFWriter} over
+ * a {@link WriterGraphRIOT}.
+ */
 public abstract class AdapterRDFWriter extends WriterGraphRIOTBase
 {
     protected abstract RDFWriter create() ;

http://git-wip-us.apache.org/repos/asf/jena/blob/c5c15bb2/jena-arq/src/main/java/org/apache/jena/riot/adapters/RDFWriterRIOT.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/riot/adapters/RDFWriterRIOT.java b/jena-arq/src/main/java/org/apache/jena/riot/adapters/RDFWriterRIOT.java
index 59a4b71..23293a9 100644
--- a/jena-arq/src/main/java/org/apache/jena/riot/adapters/RDFWriterRIOT.java
+++ b/jena-arq/src/main/java/org/apache/jena/riot/adapters/RDFWriterRIOT.java
@@ -34,7 +34,16 @@ import org.apache.jena.riot.system.RiotLib ;
 import org.apache.jena.sparql.util.Context ;
 import org.apache.jena.sparql.util.Symbol ;
 
-/** Adapter from RIOT to old style Jena RDFWriter. */
+/**
+ * This class is used for indirecting all model.write calls to RIOT. It
+ * implements Jena core {@link RDFWriter} can calls {@link WriterGraphRIOT}.
+ * <p>
+ * For RDF/XML, that {@link WriterGraphRIOT} is a {@link AdapterRDFWriter} that
+ * calls the old style {@link RDFWriter} interface.
+ * <p>
+ * {@link AdapterRDFWriter} is a {@link WriterGraphRIOT} over a
+ * {@link RDFWriter}.
+ */
 public class RDFWriterRIOT implements RDFWriter 
 {
     // ---- Compatibility
@@ -88,6 +97,7 @@ public class RDFWriterRIOT implements RDFWriter
         Object oldObj = context.get(sym);
         context.set(sym, propValue);
         properties.put(propName, propValue) ;
+        // These are added to any Jena RDFWriter (old-style, e.g. RDF/XML) in  
         return oldObj;
     }