org.semanticweb.owlapi.model

Interface OWLDocumentFormat

All Superinterfaces:

Serializable

All Known Subinterfaces:

PrefixDocumentFormat, RDFDocumentFormat

All Known Implementing Classes:

AbstractRDFNonPrefixDocumentFormat, AbstractRDFPrefixDocumentFormat, DLSyntaxDocumentFormat, DLSyntaxHTMLDocumentFormat, FunctionalSyntaxDocumentFormat, KRSS2DocumentFormat, KRSSDocumentFormat, LabelFunctionalDocumentFormat, LatexAxiomsListDocumentFormat, LatexDocumentFormat, ManchesterSyntaxDocumentFormat, OBODocumentFormat, OWLDocumentFormatImpl, OWLXMLDocumentFormat, PrefixDocumentFormatImpl, RDFXMLDocumentFormat, TurtleDocumentFormat

public interface OWLDocumentFormat
extends Serializable

Represents the concrete representation format of an ontology. The equality of an ontology format is defined by the equals and hashCode method (not its identity).

Since:

2.0.0

Author:

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

Method Summary

Modifier and Type	Method and Description
PrefixDocumentFormat	asPrefixOWLOntologyFormat() If this format is an instance of PrefixDocumentFormat then this method will obtain it as a PrefixDocumentFormat.
String	getKey()
OWLOntologyLoaderMetaData	getOntologyLoaderMetaData() If this format describes an ontology that was loaded from some ontology document (rather than created programmatically) there may be some meta data about the loading process.
Serializable	getParameter(Serializable key, Serializable defaultValue)
boolean	isAddMissingTypes() Determines if untyped entities should automatically be typed (declared) during rendering.
boolean	isPrefixOWLOntologyFormat() Determines if this format is an instance of a format that uses prefixes to shorted IRIs.
boolean	isTextual() Determines whether this format contains textual output, as opposed to binary output.
void	setAddMissingTypes(boolean addMissingTypes) Determines if untyped entities should automatically be typed during rendering.
void	setOntologyLoaderMetaData(OWLOntologyLoaderMetaData loaderMetaData) Sets the meta data for the ontology loader.
void	setParameter(Serializable key, Serializable value)

Method Detail

isAddMissingTypes

boolean isAddMissingTypes()

Determines if untyped entities should automatically be typed (declared) during rendering. (This is a hint to an RDF renderer - the reference implementation will respect this).

Returns:

true if untyped entities should automatically be typed during rendering, otherwise false.

setAddMissingTypes

void setAddMissingTypes(boolean addMissingTypes)

Determines if untyped entities should automatically be typed during rendering. By default this is true.

Parameters:

addMissingTypes - true if untyped entities should automatically be typed during rendering, otherwise false.

setParameter

void setParameter(Serializable key,
                  Serializable value)

Parameters:

key - key for the new entry

value - value for the new entry

getParameter

Serializable getParameter(Serializable key,
                          Serializable defaultValue)

Parameters:

key - key for the new entry

defaultValue - value for the new entry

Returns:

the value

isPrefixOWLOntologyFormat

boolean isPrefixOWLOntologyFormat()

Determines if this format is an instance of a format that uses prefixes to shorted IRIs.

Returns:

true if this format is an instance of PrefixDocumentFormat other wise false.

asPrefixOWLOntologyFormat

@Nonnull
PrefixDocumentFormat asPrefixOWLOntologyFormat()

If this format is an instance of PrefixDocumentFormat then this method will obtain it as a PrefixDocumentFormat.

Returns:

This format as a more specific PrefixDocumentFormat.

Throws:

ClassCastException - if this format is not an instance of PrefixDocumentFormat

getOntologyLoaderMetaData

@Nonnull
OWLOntologyLoaderMetaData getOntologyLoaderMetaData()

If this format describes an ontology that was loaded from some ontology document (rather than created programmatically) there may be some meta data about the loading process. Subclasses of OWLOntologyFormat will provide accessors etc. to details pertaining to the meta data about loading.

Returns:

An object containing the meta data about loading. .

setOntologyLoaderMetaData

void setOntologyLoaderMetaData(@Nonnull
                               OWLOntologyLoaderMetaData loaderMetaData)

Sets the meta data for the ontology loader.

Parameters:

loaderMetaData - The metadata.

Throws:

NullPointerException - if the loaderMetaData is null.

getKey

@Nonnull
String getKey()

Returns:

A unique key for this format.

isTextual

boolean isTextual()

Determines whether this format contains textual output, as opposed to binary output.

Returns:

True if this format represents a textual format, as opposed to a binary format. Defaults to true if not overridden.