Package org.semanticweb.owlapi.model

Class OWLDocumentFormatImpl

java.lang.Object

org.semanticweb.owlapi.model.OWLDocumentFormatImpl

All Implemented Interfaces:

Serializable, OWLDocumentFormat

Direct Known Subclasses:

AbstractRDFNonPrefixDocumentFormat, DLSyntaxDocumentFormat, DLSyntaxHTMLDocumentFormat, KRSS2DocumentFormat, KRSSDocumentFormat, LabelFunctionalDocumentFormat, LatexAxiomsListDocumentFormat, LatexDocumentFormat, OBODocumentFormat, PrefixDocumentFormatImpl

public abstract class OWLDocumentFormatImpl
extends Object
implements OWLDocumentFormat

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
OWLDocumentFormatImpl()

Method Summary

Modifier and Type	Method	Description
static Collection<IRI>	determineIllegalPunnings(boolean add, Collection<OWLEntity> signature, Collection<IRI> punnedEntities)
boolean	equals(Object obj)
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)
int	hashCode()
boolean	isAddMissingTypes()	Determines if untyped entities should automatically be typed (declared) during rendering.
static boolean	isMissingType(OWLEntity entity, OWLOntology ontology)	Determines if a declaration axiom (type triple) needs to be added to the specified ontology for the given entity.
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)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

asPrefixOWLOntologyFormat, getKey, isPrefixOWLOntologyFormat

Constructor Detail

OWLDocumentFormatImpl

public OWLDocumentFormatImpl()

Method Detail

isAddMissingTypes

public boolean isAddMissingTypes()

Description copied from interface: OWLDocumentFormat

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).

Specified by:

isAddMissingTypes in interface OWLDocumentFormat

Returns:

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

isMissingType

public static boolean isMissingType(@Nonnull
                                    OWLEntity entity,
                                    OWLOntology ontology)

Determines if a declaration axiom (type triple) needs to be added to the specified ontology for the given entity.

Parameters:

entity - The entity

ontology - The ontology.

Returns:

false if the entity is built in. false if the ontology doesn't contain the entity in its signature. false if the entity is already declared in the imports closure of the ontology. false if the transitive imports does not contain the ontology but the entity is contained in the signature of one of the imported ontologies, true if none of the previous conditions are met.

determineIllegalPunnings

public static Collection<IRI> determineIllegalPunnings(boolean add,
                                                       Collection<OWLEntity> signature,
                                                       Collection<IRI> punnedEntities)

Parameters:

signature - signature for the ontology

punnedEntities - the set of entities that are known already to be punned

add - true if missing declarations should be added. If false, no declarations will be added.

Returns:

collection of IRIS used in illegal punnings

setAddMissingTypes

public void setAddMissingTypes(boolean addMissingTypes)

Description copied from interface: OWLDocumentFormat

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

Specified by:

setAddMissingTypes in interface OWLDocumentFormat

Parameters:

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

setParameter

public void setParameter(Serializable key,
                         Serializable value)

Specified by:

setParameter in interface OWLDocumentFormat

Parameters:

key - key for the new entry

value - value for the new entry

getParameter

public Serializable getParameter(Serializable key,
                                 Serializable defaultValue)

Specified by:

getParameter in interface OWLDocumentFormat

Parameters:

key - key for the new entry

defaultValue - value for the new entry

Returns:

the value

getOntologyLoaderMetaData

public OWLOntologyLoaderMetaData getOntologyLoaderMetaData()

Description copied from interface: OWLDocumentFormat

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.

Specified by:

getOntologyLoaderMetaData in interface OWLDocumentFormat

Returns:

An object containing the meta data about loading. .

setOntologyLoaderMetaData

public void setOntologyLoaderMetaData(OWLOntologyLoaderMetaData loaderMetaData)

Description copied from interface: OWLDocumentFormat

Sets the meta data for the ontology loader.

Specified by:

setOntologyLoaderMetaData in interface OWLDocumentFormat

Parameters:

loaderMetaData - The metadata.

isTextual

public boolean isTextual()

Description copied from interface: OWLDocumentFormat

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

Specified by:

isTextual in interface OWLDocumentFormat

Returns:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object