org.semanticweb.owlapi.manchestersyntax.renderer

Class ManchesterOWLSyntaxFrameRenderer

java.lang.Object

org.semanticweb.owlapi.manchestersyntax.renderer.AbstractRenderer

org.semanticweb.owlapi.manchestersyntax.renderer.ManchesterOWLSyntaxObjectRenderer

org.semanticweb.owlapi.manchestersyntax.renderer.ManchesterOWLSyntaxFrameRenderer

All Implemented Interfaces:

OWLAnnotationAxiomVisitor, OWLAnnotationObjectVisitor, OWLAnnotationValueVisitor, OWLAxiomVisitor, OWLClassExpressionVisitor, OWLDataRangeVisitor, OWLDataVisitor, OWLEntityVisitor, OWLIndividualVisitor, OWLLogicalAxiomVisitor, OWLNamedObjectVisitor, OWLObjectVisitor, OWLPropertyExpressionVisitor, SWRLObjectVisitor

public class ManchesterOWLSyntaxFrameRenderer
extends ManchesterOWLSyntaxObjectRenderer
implements OWLEntityVisitor

The Class ManchesterOWLSyntaxFrameRenderer.

Since:

2.0.0

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group

Constructor Summary

Constructors

Constructor and Description
ManchesterOWLSyntaxFrameRenderer(OWLOntology ontology, Writer writer, ShortFormProvider entityShortFormProvider) Instantiates a new manchester owl syntax frame renderer.
ManchesterOWLSyntaxFrameRenderer(Set<OWLOntology> ontologies, Writer writer, ShortFormProvider entityShortFormProvider) Instantiates a new manchester owl syntax frame renderer.

Method Summary

Modifier and Type	Method and Description
void	addFilteredAxiomType(AxiomType<?> axiomType) Adds the filtered axiom type.
void	addRendererListener(RendererListener listener) Adds the renderer listener.
void	clearFilteredAxiomTypes() Clear filtered axiom types.
boolean	isDisplayed(OWLAxiom axiom) Checks if is displayed.
boolean	isFiltered(AxiomType<?> axiomType) Checks if is filtered.
void	removeRendererListener(RendererListener listener) Removes the renderer listener.
void	setAxiomFilter(OWLAxiomFilter axiomFilter) Sets the axiom filter.
void	setOntologyIRIShortFormProvider(OntologyIRIShortFormProvider shortFormProvider)
void	setRenderExtensions(boolean renderExtensions) Sets the render extensions.
void	setRenderingDirector(RenderingDirector renderingDirector) Sets the rendering director.
Collection<OWLAxiom>	write(OWLAnnotationProperty property)
Collection<OWLAxiom>	write(OWLClass cls)
Collection<OWLAxiom>	write(OWLDataProperty property)
Collection<OWLAxiom>	write(OWLDatatype datatype)
Collection<OWLAxiom>	write(OWLIndividual individual)
Collection<OWLAxiom>	write(OWLObjectPropertyExpression property)
Collection<OWLAxiom>	write(SWRLRule rule)
Collection<OWLAnnotationAssertionAxiom>	writeAnnotations(OWLAnnotationSubject subject) Write annotations.
void	writeComment(String comment, boolean placeOnNewline) Write comment.
void	writeComment(String commentDelim, String comment, boolean placeOnNewline)
Collection<OWLAxiom>	writeFrame(OWLEntity entity) Write frame.
void	writeFullURI(String uri) Write full URI.
void	writeOntology() Write ontology.
void	writeOntologyHeader(OWLOntology ontology) Write ontology header.
void	writePrefixMap() Write prefix map.
void	writeSection(ManchesterOWLSyntax keyword) Write section.
void	writeSection(ManchesterOWLSyntax keyword, Collection<?> content, String delimiter, boolean newline, OWLOntology... ontologiesList) Write section.

Methods inherited from class org.semanticweb.owlapi.manchestersyntax.renderer.ManchesterOWLSyntaxObjectRenderer

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.semanticweb.owlapi.model.OWLEntityVisitor

visit, visit, visit, visit, visit, visit

Constructor Detail

ManchesterOWLSyntaxFrameRenderer

public ManchesterOWLSyntaxFrameRenderer(@Nonnull
                                        OWLOntology ontology,
                                        @Nonnull
                                        Writer writer,
                                        @Nonnull
                                        ShortFormProvider entityShortFormProvider)

Instantiates a new manchester owl syntax frame renderer.

Parameters:

ontology - the ontology

writer - the writer

entityShortFormProvider - the entity short form provider

ManchesterOWLSyntaxFrameRenderer

public ManchesterOWLSyntaxFrameRenderer(@Nonnull
                                        Set<OWLOntology> ontologies,
                                        Writer writer,
                                        @Nonnull
                                        ShortFormProvider entityShortFormProvider)

Instantiates a new manchester owl syntax frame renderer.

Parameters:

ontologies - the ontologies

writer - the writer

entityShortFormProvider - the entity short form provider

Method Detail

setRenderingDirector

public void setRenderingDirector(RenderingDirector renderingDirector)

Sets the rendering director.

Parameters:

renderingDirector - the new rendering director

setOntologyIRIShortFormProvider

public void setOntologyIRIShortFormProvider(OntologyIRIShortFormProvider shortFormProvider)

Parameters:

shortFormProvider - short form provider to be used

addRendererListener

public void addRendererListener(RendererListener listener)

Adds the renderer listener.

Parameters:

listener - the listener

removeRendererListener

public void removeRendererListener(RendererListener listener)

Removes the renderer listener.

Parameters:

listener - the listener

setAxiomFilter

public void setAxiomFilter(OWLAxiomFilter axiomFilter)

Sets the axiom filter.

Parameters:

axiomFilter - the new axiom filter

clearFilteredAxiomTypes

public void clearFilteredAxiomTypes()

Clear filtered axiom types.

addFilteredAxiomType

public void addFilteredAxiomType(AxiomType<?> axiomType)

Adds the filtered axiom type.

Parameters:

axiomType - the axiom type

setRenderExtensions

public void setRenderExtensions(boolean renderExtensions)

Sets the render extensions.

Parameters:

renderExtensions - the new render extensions

writeOntology

public void writeOntology()
                   throws OWLRendererException

Write ontology.

Throws:

OWLRendererException - the OWL renderer exception

writeOntologyHeader

public void writeOntologyHeader(@Nonnull
                                OWLOntology ontology)

Write ontology header.

Parameters:

ontology - the ontology

writePrefixMap

public void writePrefixMap()

Write prefix map.

writeFullURI

public void writeFullURI(String uri)

Write full URI.

Parameters:

uri - the URI

isFiltered

public boolean isFiltered(AxiomType<?> axiomType)

Checks if is filtered.

Parameters:

axiomType - the axiom type

Returns:

true, if is filtered

isDisplayed

public boolean isDisplayed(@Nullable
                           OWLAxiom axiom)

Checks if is displayed.

Parameters:

axiom - the axiom

Returns:

true, if is displayed

writeFrame

public Collection<OWLAxiom> writeFrame(@Nonnull
                                       OWLEntity entity)

Write frame.

Parameters:

entity - the entity

Returns:

the sets the

write

@Nonnull
public Collection<OWLAxiom> write(@Nonnull
                                           OWLClass cls)

Parameters:

cls - the class

Returns:

the sets the

write

@Nonnull
public Collection<OWLAxiom> write(@Nonnull
                                           OWLObjectPropertyExpression property)

Parameters:

property - the property

Returns:

the sets the

write

@Nonnull
public Collection<OWLAxiom> write(@Nonnull
                                           OWLDataProperty property)

Parameters:

property - the property

Returns:

the sets the

write

@Nonnull
public Collection<OWLAxiom> write(@Nonnull
                                           OWLIndividual individual)

Parameters:

individual - the individual

Returns:

the sets the

write

@Nonnull
public Collection<OWLAxiom> write(@Nonnull
                                           OWLDatatype datatype)

Parameters:

datatype - the datatype

Returns:

the sets the

write

@Nonnull
public Collection<OWLAxiom> write(@Nonnull
                                           SWRLRule rule)

Parameters:

rule - the rule

Returns:

written axioms

write

@Nonnull
public Collection<OWLAxiom> write(@Nonnull
                                           OWLAnnotationProperty property)

Parameters:

property - the property

Returns:

written axioms

writeAnnotations

@Nonnull
public Collection<OWLAnnotationAssertionAxiom> writeAnnotations(@Nonnull
                                                                         OWLAnnotationSubject subject)

Write annotations.

Parameters:

subject - the subject

Returns:

written axioms

writeSection

public void writeSection(@Nonnull
                         ManchesterOWLSyntax keyword)

Write section.

Parameters:

keyword - the keyword

writeSection

public void writeSection(@Nonnull
                         ManchesterOWLSyntax keyword,
                         @Nonnull
                         Collection<?> content,
                         String delimiter,
                         boolean newline,
                         @Nonnull
                         OWLOntology... ontologiesList)

Write section.

Parameters:

keyword - the keyword

content - the content

delimiter - the delimiter

newline - the newline

ontologiesList - the ontologies list

writeComment

public void writeComment(String comment,
                         boolean placeOnNewline)

Write comment.

Parameters:

comment - the comment

placeOnNewline - the place on newline

writeComment

public void writeComment(String commentDelim,
                         String comment,
                         boolean placeOnNewline)

Parameters:

commentDelim - the comment delim

comment - the comment

placeOnNewline - the place on newline