uk.ac.manchester.cs.owl.owlapi.mansyntaxrenderer

Class ManchesterOWLSyntaxFrameRenderer

java.lang.Object

uk.ac.manchester.cs.owl.owlapi.mansyntaxrenderer.AbstractRenderer

uk.ac.manchester.cs.owl.owlapi.mansyntaxrenderer.ManchesterOWLSyntaxObjectRenderer

uk.ac.manchester.cs.owl.owlapi.mansyntaxrenderer.ManchesterOWLSyntaxFrameRenderer

All Implemented Interfaces:

org.semanticweb.owlapi.model.OWLAnnotationAxiomVisitor, org.semanticweb.owlapi.model.OWLAnnotationObjectVisitor, org.semanticweb.owlapi.model.OWLAnnotationValueVisitor, org.semanticweb.owlapi.model.OWLAxiomVisitor, org.semanticweb.owlapi.model.OWLClassExpressionVisitor, org.semanticweb.owlapi.model.OWLDataRangeVisitor, org.semanticweb.owlapi.model.OWLDataVisitor, org.semanticweb.owlapi.model.OWLEntityVisitor, org.semanticweb.owlapi.model.OWLIndividualVisitor, org.semanticweb.owlapi.model.OWLNamedObjectVisitor, org.semanticweb.owlapi.model.OWLObjectVisitor, org.semanticweb.owlapi.model.OWLPropertyExpressionVisitor, org.semanticweb.owlapi.model.SWRLObjectVisitor

public class ManchesterOWLSyntaxFrameRenderer
extends ManchesterOWLSyntaxObjectRenderer
implements org.semanticweb.owlapi.model.OWLEntityVisitor

The Class ManchesterOWLSyntaxFrameRenderer.

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group, Date: 25-Apr-2007

Field Summary

Fields inherited from class uk.ac.manchester.cs.owl.owlapi.mansyntaxrenderer.ManchesterOWLSyntaxObjectRenderer

LINE_LENGTH

Constructor Summary

Constructors

Constructor and Description
ManchesterOWLSyntaxFrameRenderer(org.semanticweb.owlapi.model.OWLOntologyManager owlOntologyManager, org.semanticweb.owlapi.model.OWLOntology ontology, Writer writer, org.semanticweb.owlapi.util.ShortFormProvider entityShortFormProvider) Deprecated.
ManchesterOWLSyntaxFrameRenderer(org.semanticweb.owlapi.model.OWLOntologyManager owlOntologyManager, Set<org.semanticweb.owlapi.model.OWLOntology> ontologies, org.semanticweb.owlapi.model.OWLOntology defaultOntology, Writer writer, org.semanticweb.owlapi.util.ShortFormProvider entityShortFormProvider) Deprecated.
ManchesterOWLSyntaxFrameRenderer(org.semanticweb.owlapi.model.OWLOntology ontology, Writer writer, org.semanticweb.owlapi.util.ShortFormProvider entityShortFormProvider) Instantiates a new manchester owl syntax frame renderer.
ManchesterOWLSyntaxFrameRenderer(Set<org.semanticweb.owlapi.model.OWLOntology> ontologies, org.semanticweb.owlapi.model.OWLOntology defaultOntology, Writer writer, org.semanticweb.owlapi.util.ShortFormProvider entityShortFormProvider) Deprecated.
ManchesterOWLSyntaxFrameRenderer(Set<org.semanticweb.owlapi.model.OWLOntology> ontologies, Writer writer, org.semanticweb.owlapi.util.ShortFormProvider entityShortFormProvider) Instantiates a new manchester owl syntax frame renderer.

Method Summary

Modifier and Type	Method and Description
void	addFilteredAxiomType(org.semanticweb.owlapi.model.AxiomType<?> axiomType) Adds the filtered axiom type.
void	addRendererListener(RendererListener listener) Adds the renderer listener.
void	clearFilteredAxiomTypes() Clear filtered axiom types.
Set<org.semanticweb.owlapi.model.OWLOntology>	getOntologies() Gets the ontologies.
boolean	isDisplayed(org.semanticweb.owlapi.model.OWLAxiom axiom) Checks if is displayed.
boolean	isFiltered(org.semanticweb.owlapi.model.AxiomType<?> axiomType) Checks if is filtered.
void	removeRendererListener(RendererListener listener) Removes the renderer listener.
void	setAxiomFilter(org.semanticweb.owlapi.util.OWLAxiomFilter axiomFilter) Sets the axiom filter.
void	setOntologyIRIShortFormProvider(org.semanticweb.owlapi.util.OntologyIRIShortFormProvider shortFormProvider)
void	setRenderExtensions(boolean renderExtensions) Sets the render extensions.
void	setRenderingDirector(RenderingDirector renderingDirector) Sets the rendering director.
void	setRenderOntologyLists(boolean renderOntologyList) Specifies whether or not ontology lists should be rendered after frame section keywords.
Set<org.semanticweb.owlapi.model.OWLAxiom>	write(org.semanticweb.owlapi.model.OWLAnnotationProperty property)
Set<org.semanticweb.owlapi.model.OWLAxiom>	write(org.semanticweb.owlapi.model.OWLClass cls) Writes out a class frame for the specified class.
Set<org.semanticweb.owlapi.model.OWLAxiom>	write(org.semanticweb.owlapi.model.OWLDataProperty property)
Set<org.semanticweb.owlapi.model.OWLAxiom>	write(org.semanticweb.owlapi.model.OWLDatatype datatype)
Set<org.semanticweb.owlapi.model.OWLAxiom>	write(org.semanticweb.owlapi.model.OWLIndividual individual)
Set<org.semanticweb.owlapi.model.OWLAxiom>	write(org.semanticweb.owlapi.model.OWLObjectPropertyExpression property)
Set<org.semanticweb.owlapi.model.OWLAxiom>	write(org.semanticweb.owlapi.model.SWRLRule rule)
Set<org.semanticweb.owlapi.model.OWLAnnotationAssertionAxiom>	writeAnnotations(org.semanticweb.owlapi.model.OWLAnnotationSubject subject) Write annotations.
void	writeComment(String comment, boolean placeOnNewline) Write comment.
void	writeComment(String commentDelim, String comment, boolean placeOnNewline)
void	writeEntityNaryAxioms(org.semanticweb.owlapi.model.OWLEntity entity) Writes out the Nary axiom frames that contain the specified entity as an operand.
protected void	writeEntitySectionEnd(String type) Write entity section end.
Set<org.semanticweb.owlapi.model.OWLAxiom>	writeFrame(org.semanticweb.owlapi.model.OWLEntity entity) Write frame.
void	writeFullURI(String uri) Write full uri.
void	writeOntology() Write ontology.
void	writeOntologyHeader(org.semanticweb.owlapi.model.OWLOntology ontology) Write ontology header.
void	writePrefixMap() Write prefix map.
void	writeRules(Set<org.semanticweb.owlapi.model.SWRLRule> rules, org.semanticweb.owlapi.model.OWLOntology... ontologiesToWrite) Writes out the specified rules.
void	writeRulesContainingPredicate(org.semanticweb.owlapi.model.OWLObject predicate)
void	writeSection(ManchesterOWLSyntax keyword) Write section.
void	writeSection(ManchesterOWLSyntax keyword, Collection<?> content, String delimeter, boolean newline, org.semanticweb.owlapi.model.OWLOntology... ontologiesList) Write section.
void	writeSection(ManchesterOWLSyntax keyword, SectionMap content, String delimeter, boolean newline, org.semanticweb.owlapi.model.OWLOntology... ontologiesList) Write section.

Methods inherited from class uk.ac.manchester.cs.owl.owlapi.mansyntaxrenderer.ManchesterOWLSyntaxObjectRenderer

sort, 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, write, write, writeAnnotations, writeCommaSeparatedList

Methods inherited from class uk.ac.manchester.cs.owl.owlapi.mansyntaxrenderer.AbstractRenderer

flush, getIndent, getShortFormProvider, incrementTab, isUseTabbing, isUseWrapping, popTab, pushTab, setUseTabbing, setUseWrapping, write, write, write, write, write, writeFrameKeyword, writeNewLine, writeSectionKeyword, writeSpace, writeTab

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

@Deprecated
public ManchesterOWLSyntaxFrameRenderer(org.semanticweb.owlapi.model.OWLOntologyManager owlOntologyManager,
                                                    org.semanticweb.owlapi.model.OWLOntology ontology,
                                                    Writer writer,
                                                    org.semanticweb.owlapi.util.ShortFormProvider entityShortFormProvider)

Deprecated.

Instantiates a new manchester owl syntax frame renderer.

Parameters:

owlOntologyManager - the owl ontology manager

ontology - the ontology

writer - the writer

entityShortFormProvider - the entity short form provider

ManchesterOWLSyntaxFrameRenderer

public ManchesterOWLSyntaxFrameRenderer(Set<org.semanticweb.owlapi.model.OWLOntology> ontologies,
                                        Writer writer,
                                        org.semanticweb.owlapi.util.ShortFormProvider entityShortFormProvider)

Instantiates a new manchester owl syntax frame renderer.

Parameters:

ontologies - the ontologies

writer - the writer

entityShortFormProvider - the entity short form provider

ManchesterOWLSyntaxFrameRenderer

public ManchesterOWLSyntaxFrameRenderer(org.semanticweb.owlapi.model.OWLOntology ontology,
                                        Writer writer,
                                        org.semanticweb.owlapi.util.ShortFormProvider entityShortFormProvider)

Instantiates a new manchester owl syntax frame renderer.

Parameters:

ontology - the ontology

writer - the writer

entityShortFormProvider - the entity short form provider

ManchesterOWLSyntaxFrameRenderer

@Deprecated
public ManchesterOWLSyntaxFrameRenderer(org.semanticweb.owlapi.model.OWLOntologyManager owlOntologyManager,
                                                    Set<org.semanticweb.owlapi.model.OWLOntology> ontologies,
                                                    org.semanticweb.owlapi.model.OWLOntology defaultOntology,
                                                    Writer writer,
                                                    org.semanticweb.owlapi.util.ShortFormProvider entityShortFormProvider)

Deprecated.

Instantiates a new manchester owl syntax frame renderer.

Parameters:

owlOntologyManager - the owl ontology manager

ontologies - the ontologies

defaultOntology - the default ontology

writer - the writer

entityShortFormProvider - the entity short form provider

ManchesterOWLSyntaxFrameRenderer

@Deprecated
public ManchesterOWLSyntaxFrameRenderer(Set<org.semanticweb.owlapi.model.OWLOntology> ontologies,
                                                    org.semanticweb.owlapi.model.OWLOntology defaultOntology,
                                                    Writer writer,
                                                    org.semanticweb.owlapi.util.ShortFormProvider entityShortFormProvider)

Deprecated.

Instantiates a new manchester owl syntax frame renderer.

Parameters:

ontologies - the ontologies

defaultOntology - the default ontology

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(org.semanticweb.owlapi.util.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(org.semanticweb.owlapi.util.OWLAxiomFilter axiomFilter)

Sets the axiom filter.

Parameters:

axiomFilter - the new axiom filter

clearFilteredAxiomTypes

public void clearFilteredAxiomTypes()

Clear filtered axiom types.

addFilteredAxiomType

public void addFilteredAxiomType(org.semanticweb.owlapi.model.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

setRenderOntologyLists

public void setRenderOntologyLists(boolean renderOntologyList)

Specifies whether or not ontology lists should be rendered after frame section keywords. Ontology lists are not part of the Manchester Syntax specification - they are an extension for use in editing tools and the like. The default behaviour is not to render the ontology list. An example of an ontology list is: Class: A SubClassOf [in X, Y, Z] B. Where X, Y and Z are ontologies. This indicates that A SubClassOf B occurs in ontologies X, Y and Z.
Note that, for backwards compatibility, setting setRenderExtensions(boolean) to true will also cause ontology lists to be rendered (along with other extensions).

Parameters:

renderOntologyList - Whether or not to render the ontology list for each section. true if the list should be rendered, otherwise false. The default behaviour is false.

writeOntology

public void writeOntology()
                   throws org.semanticweb.owlapi.io.OWLRendererException

Write ontology.

Throws:

org.semanticweb.owlapi.io.OWLRendererException - the oWL renderer exception

writeRules

public void writeRules(Set<org.semanticweb.owlapi.model.SWRLRule> rules,
                       org.semanticweb.owlapi.model.OWLOntology... ontologiesToWrite)

Writes out the specified rules.

Parameters:

rules - The rules to be written. Not null.

ontologiesToWrite - the ontologies

writeEntityNaryAxioms

public void writeEntityNaryAxioms(org.semanticweb.owlapi.model.OWLEntity entity)

Writes out the Nary axiom frames that contain the specified entity as an operand. These are either, DisjointClasses, EquivalentClasses, DisjointObjectProperties, DisjointDataProperties, EquivalentObjectProperties, EquivalentDataProperties, SameIndividual or DifferentIndividuals axioms that have more than two operands, one of which is the specified entity.

Parameters:

entity - The entity. Not null.

writeOntologyHeader

public void writeOntologyHeader(org.semanticweb.owlapi.model.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(org.semanticweb.owlapi.model.AxiomType<?> axiomType)

Checks if is filtered.

Parameters:

axiomType - the axiom type

Returns:

true, if is filtered

isDisplayed

public boolean isDisplayed(org.semanticweb.owlapi.model.OWLAxiom axiom)

Checks if is displayed.

Parameters:

axiom - the axiom

Returns:

true, if is displayed

writeFrame

public Set<org.semanticweb.owlapi.model.OWLAxiom> writeFrame(org.semanticweb.owlapi.model.OWLEntity entity)

Write frame.

Parameters:

entity - the entity

Returns:

the sets the

write

public Set<org.semanticweb.owlapi.model.OWLAxiom> write(org.semanticweb.owlapi.model.OWLClass cls)

Writes out a class frame for the specified class.

Parameters:

cls - The class. Not null.

Returns:

the sets axioms that were written out.

writeRulesContainingPredicate

public void writeRulesContainingPredicate(org.semanticweb.owlapi.model.OWLObject predicate)

Parameters:

predicate - predicate to write

writeEntitySectionEnd

protected void writeEntitySectionEnd(String type)

Write entity section end.

Parameters:

type - the type

write

public Set<org.semanticweb.owlapi.model.OWLAxiom> write(org.semanticweb.owlapi.model.OWLObjectPropertyExpression property)

Parameters:

property - the property

Returns:

the sets the

write

public Set<org.semanticweb.owlapi.model.OWLAxiom> write(org.semanticweb.owlapi.model.OWLDataProperty property)

Parameters:

property - the property

Returns:

the sets the

write

public Set<org.semanticweb.owlapi.model.OWLAxiom> write(org.semanticweb.owlapi.model.OWLIndividual individual)

Parameters:

individual - the individual

Returns:

the sets the

write

public Set<org.semanticweb.owlapi.model.OWLAxiom> write(org.semanticweb.owlapi.model.OWLDatatype datatype)

Parameters:

datatype - the datatype

Returns:

the sets the

write

public Set<org.semanticweb.owlapi.model.OWLAxiom> write(org.semanticweb.owlapi.model.SWRLRule rule)

Parameters:

rule - the rule

Returns:

the sets the

getOntologies

public Set<org.semanticweb.owlapi.model.OWLOntology> getOntologies()

Gets the ontologies.

Returns:

the ontologies

writeSection

public void writeSection(ManchesterOWLSyntax keyword,
                         Collection<?> content,
                         String delimeter,
                         boolean newline,
                         org.semanticweb.owlapi.model.OWLOntology... ontologiesList)

Write section.

Parameters:

keyword - the keyword

content - the content

delimeter - the delimeter

newline - the newline

ontologiesList - the ontologies list

writeSection

public void writeSection(ManchesterOWLSyntax keyword)

Write section.

Parameters:

keyword - the keyword

write

public Set<org.semanticweb.owlapi.model.OWLAxiom> write(org.semanticweb.owlapi.model.OWLAnnotationProperty property)

Parameters:

property - the property

Returns:

the sets the

writeAnnotations

public Set<org.semanticweb.owlapi.model.OWLAnnotationAssertionAxiom> writeAnnotations(org.semanticweb.owlapi.model.OWLAnnotationSubject subject)

Write annotations.

Parameters:

subject - the subject

Returns:

the sets the

writeSection

public void writeSection(ManchesterOWLSyntax keyword,
                         SectionMap content,
                         String delimeter,
                         boolean newline,
                         org.semanticweb.owlapi.model.OWLOntology... ontologiesList)

Write section.

Parameters:

keyword - the keyword

content - the content

delimeter - the delimeter

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