com.epimorphics.jsonrdf

Class Encoder

java.lang.Object

com.epimorphics.jsonrdf.Encoder

public class Encoder
extends Object

Driver for encoding a set of RDF resources into JSON. The serialization decisions are made (relative to a Context spec) by an EncoderPlugin for which there is a default implementation.

Version:

$Revision: $

Author:

Dave Reynolds

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadContext	context
protected static EncoderPlugin	defaultPlugin
protected boolean	oneResult
protected EncoderPlugin	rules

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.jena.atlas.json.JsonObject	encode(com.hp.hpl.jena.query.Dataset dataset) Write out a collection of named graphs plus a default graph
protected void	encode(com.hp.hpl.jena.query.Dataset dataset, JSONWriterFacade jw) Write out a collection of named graphs plus a default graph
void	encode(com.hp.hpl.jena.query.Dataset dataset, Writer writer) Write out a collection of named graphs plus a default graph
void	encode(com.hp.hpl.jena.query.Dataset dataset, Writer writer, boolean pretty) Write out a collection of named graphs plus a default graph
org.apache.jena.atlas.json.JsonObject	encode(com.hp.hpl.jena.rdf.model.Model model) Encode the whole of the given RDF model into the writer
org.apache.jena.atlas.json.JsonObject	encode(com.hp.hpl.jena.rdf.model.Model model, List<com.hp.hpl.jena.rdf.model.Resource> roots) Encode a list of resources from the given RDF model, only top level assertions and bNode closures connected to them will be output.
protected void	encode(com.hp.hpl.jena.rdf.model.Model model, List<com.hp.hpl.jena.rdf.model.Resource> roots, JSONWriterFacade jw)
void	encode(com.hp.hpl.jena.rdf.model.Model model, List<com.hp.hpl.jena.rdf.model.Resource> roots, Writer writer) Encode a list of resources from the given RDF model, only top level assertions and bNode closures connected to them will be output.
void	encode(com.hp.hpl.jena.rdf.model.Model model, List<com.hp.hpl.jena.rdf.model.Resource> roots, Writer writer, boolean pretty) Encode a list of resources from the given RDF model, only top level assertions and bNode closures connected to them will be output.
void	encode(com.hp.hpl.jena.rdf.model.Model model, Writer writer) Encode the whole of the given RDF model into the writer
void	encode(com.hp.hpl.jena.rdf.model.Model model, Writer writer, boolean pretty) Encode a list of resources from the given RDF model, only top level assertions and bNode closures connected to them will be output.
org.apache.jena.atlas.json.JsonObject	encodeRecursive(com.hp.hpl.jena.rdf.model.Model model, List<com.hp.hpl.jena.rdf.model.Resource> roots) Encode the given list of resources from the given model, plus any resources that those roots reference - whether bNodes or URIs.
protected void	encodeRecursive(com.hp.hpl.jena.rdf.model.Model model, List<com.hp.hpl.jena.rdf.model.Resource> roots, JSONWriterFacade jw)
void	encodeRecursive(com.hp.hpl.jena.rdf.model.Model model, List<com.hp.hpl.jena.rdf.model.Resource> roots, Writer writer) Encode the given list of resources from the given model, plus any resources that those roots reference - whether bNodes or URIs.
void	encodeRecursive(com.hp.hpl.jena.rdf.model.Model model, List<com.hp.hpl.jena.rdf.model.Resource> roots, Writer writer, boolean pretty) Encode the given list of resources from the given model, plus any resources that those roots reference - whether bNodes or URIs.
static Encoder	get(EncoderPlugin rules) Return an encoder using the specified rules and no Context, any Context information will be generated on-the-fly.
static Encoder	get(EncoderPlugin rules, ReadContext fromOntology) Return an encoder using the specified rules and the specified base ontology.
static Encoder	get(ReadContext context) Return an encoder using the default rules and no Context, any Context information will be generated on-the-fly.
static Encoder	getForOneResult()
static Encoder	getForOneResult(ReadContext c)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultPlugin

protected static EncoderPlugin defaultPlugin

rules

protected final EncoderPlugin rules

context

protected final ReadContext context

oneResult

protected final boolean oneResult

Method Detail

getForOneResult

public static Encoder getForOneResult(ReadContext c)

getForOneResult

public static Encoder getForOneResult()

get

public static Encoder get(ReadContext context)

Return an encoder using the default rules and no Context, any Context information will be generated on-the-fly.

get

public static Encoder get(EncoderPlugin rules)

Return an encoder using the specified rules and no Context, any Context information will be generated on-the-fly.

get

public static Encoder get(EncoderPlugin rules,
          ReadContext fromOntology)

Return an encoder using the specified rules and the specified base ontology.

encode

public void encode(com.hp.hpl.jena.rdf.model.Model model,
          Writer writer)
            throws IOException

Encode the whole of the given RDF model into the writer

Parameters:

model - The RDF to be encoded

writer - The output writer, ideally platform neutral charset like UTF-8

Throws:

IOException

encode

public org.apache.jena.atlas.json.JsonObject encode(com.hp.hpl.jena.rdf.model.Model model)

Encode the whole of the given RDF model into the writer

Parameters:

model - The RDF to be encoded

Returns:

encoding as a JSON object

encode

public void encode(com.hp.hpl.jena.rdf.model.Model model,
          Writer writer,
          boolean pretty)
            throws IOException

Encode a list of resources from the given RDF model, only top level assertions and bNode closures connected to them will be output.

Parameters:

model - The RDF to be encoded

writer - The output writer, ideally platform neutral charset like UTF-8

pretty - set to true to pretty-print the json

Throws:

IOException

encode

public void encode(com.hp.hpl.jena.rdf.model.Model model,
          List<com.hp.hpl.jena.rdf.model.Resource> roots,
          Writer writer)
            throws IOException

Encode a list of resources from the given RDF model, only top level assertions and bNode closures connected to them will be output.

Parameters:

model - The RDF to be encoded

roots - the root resources to be encoded

writer - The output writer, ideally platform neutral charset like UTF-8

Throws:

IOException

encode

public org.apache.jena.atlas.json.JsonObject encode(com.hp.hpl.jena.rdf.model.Model model,
                                           List<com.hp.hpl.jena.rdf.model.Resource> roots)

Encode a list of resources from the given RDF model, only top level assertions and bNode closures connected to them will be output.

Parameters:

model - The RDF to be encoded

roots - the root resources to be encoded

Returns:

the JSONObject containing the encoding

encode

public void encode(com.hp.hpl.jena.rdf.model.Model model,
          List<com.hp.hpl.jena.rdf.model.Resource> roots,
          Writer writer,
          boolean pretty)

Encode a list of resources from the given RDF model, only top level assertions and bNode closures connected to them will be output.

Parameters:

model - The RDF to be encoded

roots - the root resources to be encoded

writer - The output writer, ideally platform neutral charset like UTF-8

pretty - set to true to pretty-print the json

Throws:

IOException

encode

protected void encode(com.hp.hpl.jena.rdf.model.Model model,
          List<com.hp.hpl.jena.rdf.model.Resource> roots,
          JSONWriterFacade jw)

encodeRecursive

public void encodeRecursive(com.hp.hpl.jena.rdf.model.Model model,
                   List<com.hp.hpl.jena.rdf.model.Resource> roots,
                   Writer writer,
                   boolean pretty)

Encode the given list of resources from the given model, plus any resources that those roots reference - whether bNodes or URIs.

Parameters:

model - The RDF to be encoded

roots - the root resources from which encoding should start

writer - The output writer, ideally platform neutral charset like UTF-8

pretty - set to true to pretty-print the json

encodeRecursive

public void encodeRecursive(com.hp.hpl.jena.rdf.model.Model model,
                   List<com.hp.hpl.jena.rdf.model.Resource> roots,
                   Writer writer)

Encode the given list of resources from the given model, plus any resources that those roots reference - whether bNodes or URIs.

Parameters:

model - The RDF to be encoded

roots - the root resources from which encoding should start

writer - The output writer, ideally platform neutral charset like UTF-8

Throws:

IOException

encodeRecursive

public org.apache.jena.atlas.json.JsonObject encodeRecursive(com.hp.hpl.jena.rdf.model.Model model,
                                                    List<com.hp.hpl.jena.rdf.model.Resource> roots)

Encode the given list of resources from the given model, plus any resources that those roots reference - whether bNodes or URIs.

Parameters:

model - The RDF to be encoded

roots - the root resources from which encoding should start

Returns:

JSONObject containing the encoding

Throws:

IOException

encodeRecursive

protected void encodeRecursive(com.hp.hpl.jena.rdf.model.Model model,
                   List<com.hp.hpl.jena.rdf.model.Resource> roots,
                   JSONWriterFacade jw)

encode

public void encode(com.hp.hpl.jena.query.Dataset dataset,
          Writer writer)
            throws IOException

Write out a collection of named graphs plus a default graph

Parameters:

dataset - the collection of models

writer - writer to output to

Throws:

IOException

encode

public org.apache.jena.atlas.json.JsonObject encode(com.hp.hpl.jena.query.Dataset dataset)

Write out a collection of named graphs plus a default graph

Parameters:

dataset - the collection of models

Returns:

ecoded dataset as a JSON object

encode

public void encode(com.hp.hpl.jena.query.Dataset dataset,
          Writer writer,
          boolean pretty)
            throws IOException

Write out a collection of named graphs plus a default graph

Parameters:

dataset - the collection of models

writer - writer to output to

pretty - set to true to pretty-print the json

Throws:

IOException

encode

protected void encode(com.hp.hpl.jena.query.Dataset dataset,
          JSONWriterFacade jw)
               throws IOException

Write out a collection of named graphs plus a default graph

Parameters:

dataset - the collection of models

jw - JSON writer to output to

Throws:

IOException