com.epimorphics.jsonrdf.impl

Class EncoderDefault

java.lang.Object

com.epimorphics.jsonrdf.impl.EncoderDefault

All Implemented Interfaces:

EncoderPlugin

public class EncoderDefault
extends Object
implements EncoderPlugin

Implements the default encoding rules for converting RDF resources to JSON.

Version:

$Revision: $

Author:

Dave Reynolds

Field Summary

Fields

Modifier and Type	Field and Description
static String	Format name of format
static String	PNbase property name for the base entry in mapping table
static String	PNContent property name for the content/results property
static String	PNFormat property name for the format name property
static String	PNgraphs property name for the named graphs property
static String	PNMapping property name for the name/URI mapping table within the context
static String	PNOneResult property name for the single-valued content/results property
static String	PNrange property name for the range value in the mapping table
static String	PNuri property name for the uri entry in mapping table
static String	PNVersion property name for the format version property
static String	Version version number of format

Constructor Summary

Constructors

Constructor and Description
EncoderDefault()

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 shorten) Encode a resource URI, shortening it if possible
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) Writer header for a results/model array object
static String	unescapeString(String s) Decode a string to reverse escapement of meta characters
void	writeHeader(JSONWriterFacade jw) Write the outer result wrapper.

Methods inherited from class java.lang.Object

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

Field Detail

Format

public static final String Format

name of format

See Also:

Constant Field Values

Version

public static final String Version

version number of format

See Also:

Constant Field Values

PNFormat

public static final String PNFormat

property name for the format name property

See Also:

Constant Field Values

PNVersion

public static final String PNVersion

property name for the format version property

See Also:

Constant Field Values

PNMapping

public static final String PNMapping

property name for the name/URI mapping table within the context

See Also:

Constant Field Values

PNbase

public static final String PNbase

property name for the base entry in mapping table

See Also:

Constant Field Values

PNuri

public static final String PNuri

property name for the uri entry in mapping table

See Also:

Constant Field Values

PNrange

public static final String PNrange

property name for the range value in the mapping table

See Also:

Constant Field Values

PNContent

public static final String PNContent

property name for the content/results property

See Also:

Constant Field Values

PNOneResult

public static final String PNOneResult

property name for the single-valued content/results property

See Also:

Constant Field Values

PNgraphs

public static final String PNgraphs

property name for the named graphs property

See Also:

Constant Field Values

Constructor Detail

EncoderDefault

public EncoderDefault()

Method Detail

getPNResourceID

public String getPNResourceID()

String used as the property name for identifying resources

Specified by:

getPNResourceID in interface EncoderPlugin

encodeResourceURI

public String encodeResourceURI(String uri)

Encode a resource URI

Specified by:

encodeResourceURI in interface EncoderPlugin

encodeResourceURI

public String encodeResourceURI(String uri,
                       ReadContext context,
                       boolean shorten)

Encode a resource URI, shortening it if possible

Specified by:

encodeResourceURI in interface EncoderPlugin

decodeResourceURI

public String decodeResourceURI(String code,
                       Context context)

Decode a resource URI

Specified by:

decodeResourceURI in interface EncoderPlugin

encodebNodeId

public String encodebNodeId(int id)

Encode a reference to a bNode via a mapped identifier number

Specified by:

encodebNodeId in interface EncoderPlugin

encodeLiteral

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

Encode a literal as a JSON compatible object

Specified by:

encodeLiteral in interface EncoderPlugin

unescapeString

public static String unescapeString(String s)

Decode a string to reverse escapement of meta characters

writeHeader

public void writeHeader(JSONWriterFacade jw)

Write the outer result wrapper.

Specified by:

writeHeader in interface EncoderPlugin

startResults

public void startResults(JSONWriterFacade jw,
                boolean oneResult)

Writer header for a results/model array object

Specified by:

startResults in interface EncoderPlugin

endResults

public void endResults(JSONWriterFacade jw,
              boolean oneResult)

Description copied from interface: EncoderPlugin

end of results

Specified by:

endResults in interface EncoderPlugin

startNamedGraphs

public void startNamedGraphs(JSONWriterFacade jw)

Start a sub-section for outputing named graphs

Specified by:

startNamedGraphs in interface EncoderPlugin

startNamedGraph

public void startNamedGraph(JSONWriterFacade jw,
                   String name)

Start a specific named graph

Specified by:

startNamedGraph in interface EncoderPlugin

finishNamedGraph

public void finishNamedGraph(JSONWriterFacade jw)

Finish a specific named graph

Specified by:

finishNamedGraph in interface EncoderPlugin

finishNamedGraphs

public void finishNamedGraphs(JSONWriterFacade jw)

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

Specified by:

finishNamedGraphs in interface EncoderPlugin

getNamedGraphs

public 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

Specified by:

getNamedGraphs in interface EncoderPlugin

Throws:

org.apache.jena.atlas.json.JsonException

getGraphName

public 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

Specified by:

getGraphName in interface EncoderPlugin

Throws:

org.apache.jena.atlas.json.JsonException

getResults

public 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

Specified by:

getResults in interface EncoderPlugin

Throws:

org.apache.jena.atlas.json.JsonException

decodeValue

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

Decode an RDF value (object of a statement)

Specified by:

decodeValue in interface EncoderPlugin