org.coode.owlapi.rdf.renderer

Class RDFRendererBase

java.lang.Object

org.coode.owlapi.rdf.renderer.RDFRendererBase

Direct Known Subclasses:

RDFXMLRenderer, TurtleRenderer

public abstract class RDFRendererBase
extends Object

Author: Matthew Horridge
The University Of Manchester
Bio-Health Informatics Group
Date: 26-Jan-2008

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RDFRendererBase.TripleComparator

Field Summary

Fields

Modifier and Type	Field and Description
static String	GENERAL_AXIOMS_BANNER_TEXT
protected OWLOntologyManager	manager
protected OWLOntology	ontology
protected Set<IRI>	prettyPrintedTypes
static String	RULES_BANNER_TEXT
static RDFRendererBase.TripleComparator	tripleComparator

Constructor Summary

Constructors

Modifier	Constructor and Description
	RDFRendererBase(OWLOntology ontology, OWLOntologyManager manager)
protected	RDFRendererBase(OWLOntology ontology, OWLOntologyManager manager, OWLOntologyFormat format)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	beginDocument() Called before the ontology document is rendered.
protected void	beginObject() Called before an OWLObject such as an entity, anonymous individual, rule etc.
protected void	createGraph(Set<? extends OWLObject> objects)
protected abstract void	endDocument() Called after the ontology document has been rendered.
protected void	endObject() Called after an OWLObject such as an entity, anonymous individual, rule etc.
RDFGraph	getGraph()
OWLOntology	getOntology()
protected boolean	isObjectList(RDFResourceNode node)
void	render()
abstract void	render(RDFResourceNode node) Renders the triples in the current graph into a concrete format.
void	renderAnonRoots()
protected boolean	shouldInsertDeclarations()
protected void	toJavaList(RDFNode n, List<RDFNode> list)
protected abstract void	writeAnnotationPropertyComment(OWLAnnotationProperty prop) Called before an annotation property is rendered to give subclasses the chance to prefix the rendering with comments etc.
protected abstract void	writeBanner(String name)
protected abstract void	writeClassComment(OWLClass cls) Called before a class is rendered to give subclasses the chance to prefix the rendering with comments etc.
protected abstract void	writeDataPropertyComment(OWLDataProperty prop) Called before a data property is rendered to give subclasses the chance to prefix the rendering with comments etc.
protected abstract void	writeDatatypeComment(OWLDatatype datatype) Called before a datatype is rendered to give subclasses the chance to prefix the rendering with comments etc.
protected abstract void	writeIndividualComments(OWLNamedIndividual ind) Called before an individual is rendered to give subclasses the chance to prefix the rendering with comments etc.
protected abstract void	writeObjectPropertyComment(OWLObjectProperty prop) Called before an object property is rendered.

Methods inherited from class java.lang.Object

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

Field Detail

GENERAL_AXIOMS_BANNER_TEXT

public static final String GENERAL_AXIOMS_BANNER_TEXT

See Also:

Constant Field Values

RULES_BANNER_TEXT

public static final String RULES_BANNER_TEXT

See Also:

Constant Field Values

manager

protected OWLOntologyManager manager

ontology

protected OWLOntology ontology

prettyPrintedTypes

protected Set<IRI> prettyPrintedTypes

tripleComparator

public static final RDFRendererBase.TripleComparator tripleComparator

Constructor Detail

RDFRendererBase

public RDFRendererBase(OWLOntology ontology,
               OWLOntologyManager manager)

RDFRendererBase

protected RDFRendererBase(OWLOntology ontology,
               OWLOntologyManager manager,
               OWLOntologyFormat format)

Method Detail

getGraph

public RDFGraph getGraph()

getOntology

public OWLOntology getOntology()

beginDocument

protected abstract void beginDocument()
                               throws IOException

Called before the ontology document is rendered.

Throws:

IOException - if there was a problem writing to the output stream

endDocument

protected abstract void endDocument()
                             throws IOException

Called after the ontology document has been rendered.

Throws:

IOException - if there was a problem writing to the output stream

beginObject

protected void beginObject()
                    throws IOException

Called before an OWLObject such as an entity, anonymous individual, rule etc. is rendered.

Throws:

IOException - if there was a problem writing to the output stream

endObject

protected void endObject()
                  throws IOException

Called after an OWLObject such as an entity, anonymous individual, rule etc. has been rendered.

Throws:

IOException - if there was a problem writing to the output stream

writeAnnotationPropertyComment

protected abstract void writeAnnotationPropertyComment(OWLAnnotationProperty prop)
                                                throws IOException

Called before an annotation property is rendered to give subclasses the chance to prefix the rendering with comments etc.

Parameters:

prop - The property being rendered

Throws:

IOException - if there was a problem writing to the output stream

writeDataPropertyComment

protected abstract void writeDataPropertyComment(OWLDataProperty prop)
                                          throws IOException

Called before a data property is rendered to give subclasses the chance to prefix the rendering with comments etc.

Parameters:

prop - The property being rendered

Throws:

IOException - if there was a problem writing to the output stream

writeObjectPropertyComment

protected abstract void writeObjectPropertyComment(OWLObjectProperty prop)
                                            throws IOException

Called before an object property is rendered.

Parameters:

prop - The property being rendered

Throws:

IOException - if there was a problem writing to the output stream

writeClassComment

protected abstract void writeClassComment(OWLClass cls)
                                   throws IOException

Called before a class is rendered to give subclasses the chance to prefix the rendering with comments etc.

Parameters:

cls - The class being rendered

Throws:

IOException - if there was a problem writing to the output stream

writeDatatypeComment

protected abstract void writeDatatypeComment(OWLDatatype datatype)
                                      throws IOException

Called before a datatype is rendered to give subclasses the chance to prefix the rendering with comments etc.

Parameters:

datatype - The datatype being rendered

Throws:

IOException - if there was a problem writing to the output stream

writeIndividualComments

protected abstract void writeIndividualComments(OWLNamedIndividual ind)
                                         throws IOException

Called before an individual is rendered to give subclasses the chance to prefix the rendering with comments etc.

Parameters:

ind - The individual being rendered

Throws:

IOException - if there was a problem writing to the output stream

render

public void render()
            throws IOException

Throws:

IOException

shouldInsertDeclarations

protected boolean shouldInsertDeclarations()

createGraph

protected void createGraph(Set<? extends OWLObject> objects)

writeBanner

protected abstract void writeBanner(String name)
                             throws IOException

Throws:

IOException

renderAnonRoots

public void renderAnonRoots()
                     throws IOException

Throws:

IOException

render

public abstract void render(RDFResourceNode node)
                     throws IOException

Renders the triples in the current graph into a concrete format. Subclasses of this class decide upon how the triples get rendered.

Parameters:

node - The main node to be rendered

Throws:

IOException - If there was a problem rendering the triples.

isObjectList

protected boolean isObjectList(RDFResourceNode node)

toJavaList

protected void toJavaList(RDFNode n,
              List<RDFNode> list)