com.epimorphics.jsonrdf

Interface EncoderPlugin

All Known Implementing Classes:

EncoderDefault

public interface EncoderPlugin

Signature for plugins which perform all the encoding decisions.

Version:

$Revision: $

Author:

Dave Reynolds

Method Summary

Methods

Modifier and Type	Method and Description
String	decodeResourceURI(String code, Context context) Decode a resource URI
com.hp.hpl.jena.rdf.model.RDFNode	decodeValue(Object jsonValue, Decoder decoder, String type) Decode an RDF value (object of a statement)
String	encodebNodeId(int id) Encode a reference to a bNode via a mapped identifier number
void	encodeLiteral(JSONWriterFacade jw, boolean isStructured, com.hp.hpl.jena.rdf.model.Literal lit, ReadContext c) Encode a literal as a JSON compatible object.
String	encodeResourceURI(String uri) Encode a resource URI
String	encodeResourceURI(String uri, ReadContext context, boolean shortNames) Encode a resource URI, use relative URIs if possible, use shortnames only if flag is set
void	endResults(JSONWriterFacade jw, boolean oneResult) end of results
void	finishNamedGraph(JSONWriterFacade jw) Finish a specific named graph
void	finishNamedGraphs(JSONWriterFacade jw) Finish the entire second of named graphs, assumes last graph has been closed
String	getGraphName(org.apache.jena.atlas.json.JsonObject graph, Context context) Return the name of a named graph
org.apache.jena.atlas.json.JsonArray	getNamedGraphs(org.apache.jena.atlas.json.JsonObject jobj) Return the array of encoded graphs from a top level JSON results set, or null if there is none
String	getPNResourceID() String used as the property name for identifying resources
org.apache.jena.atlas.json.JsonArray	getResults(org.apache.jena.atlas.json.JsonObject jobj) Extract the results part of a deserialized JSON object
void	startNamedGraph(JSONWriterFacade jw, String name) Start a specific named graph
void	startNamedGraphs(JSONWriterFacade jw) Start a sub-section for outputing named graphs
void	startResults(JSONWriterFacade jw, boolean oneResult) Write header for a results/model array object
void	writeHeader(JSONWriterFacade jw) Write the outer result wrapper.

Method Detail

getPNResourceID

String getPNResourceID()

String used as the property name for identifying resources

encodeResourceURI

String encodeResourceURI(String uri)

Encode a resource URI

encodeResourceURI

String encodeResourceURI(String uri,
                       ReadContext context,
                       boolean shortNames)

Encode a resource URI, use relative URIs if possible, use shortnames only if flag is set

encodebNodeId

String encodebNodeId(int id)

Encode a reference to a bNode via a mapped identifier number

encodeLiteral

void encodeLiteral(JSONWriterFacade jw,
                 boolean isStructured,
                 com.hp.hpl.jena.rdf.model.Literal lit,
                 ReadContext c)

Encode a literal as a JSON compatible object. If isStructured is true, then encode it as an object with _value, _lang, and/or _datatype properties. Use c to shorten type names.

writeHeader

void writeHeader(JSONWriterFacade jw)

Write the outer result wrapper.

startResults

void startResults(JSONWriterFacade jw,
                boolean oneResult)

Write header for a results/model array object

endResults

void endResults(JSONWriterFacade jw,
              boolean oneResult)

end of results

startNamedGraphs

void startNamedGraphs(JSONWriterFacade jw)

Start a sub-section for outputing named graphs

startNamedGraph

void startNamedGraph(JSONWriterFacade jw,
                   String name)

Start a specific named graph

finishNamedGraph

void finishNamedGraph(JSONWriterFacade jw)

Finish a specific named graph

finishNamedGraphs

void finishNamedGraphs(JSONWriterFacade jw)

Finish the entire second of named graphs, assumes last graph has been closed

getNamedGraphs

org.apache.jena.atlas.json.JsonArray getNamedGraphs(org.apache.jena.atlas.json.JsonObject jobj)
                                                    throws org.apache.jena.atlas.json.JsonException

Return the array of encoded graphs from a top level JSON results set, or null if there is none

Throws:

org.apache.jena.atlas.json.JsonException

getGraphName

String getGraphName(org.apache.jena.atlas.json.JsonObject graph,
                  Context context)
                    throws org.apache.jena.atlas.json.JsonException

Return the name of a named graph

Throws:

org.apache.jena.atlas.json.JsonException

getResults

org.apache.jena.atlas.json.JsonArray getResults(org.apache.jena.atlas.json.JsonObject jobj)
                                                throws org.apache.jena.atlas.json.JsonException

Extract the results part of a deserialized JSON object

Throws:

org.apache.jena.atlas.json.JsonException

decodeResourceURI

String decodeResourceURI(String code,
                       Context context)

Decode a resource URI

decodeValue

com.hp.hpl.jena.rdf.model.RDFNode decodeValue(Object jsonValue,
                                            Decoder decoder,
                                            String type)

Decode an RDF value (object of a statement)