public interface OWLDocumentFormat extends Serializable
Modifier and Type | Method and Description |
---|---|
default PrefixDocumentFormat |
asPrefixOWLDocumentFormat()
If this format is an instance of
PrefixDocumentFormat
then this method will obtain it as a
PrefixDocumentFormat . |
static Collection<IRI> |
computeIllegals(com.google.common.collect.Multimap<IRI,EntityType<?>> punnings) |
static Collection<IRI> |
determineIllegalPunnings(boolean add,
Stream<OWLEntity> signature,
Collection<IRI> punnedEntities) |
String |
getKey() |
Optional<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.
|
<T> T |
getParameter(Serializable key,
T defaultValue) |
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.
|
default boolean |
isPrefixOWLDocumentFormat()
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) |
default boolean |
supportsRelativeIRIs()
Some formats support relative IRIs in output (all parsers must create axioms with absolute
IRIs, but some formats allow relative IRIs, with the understanding that in parsing the base
IRI will be used to convert them to absolute IRIs).
|
static boolean isMissingType(OWLEntity entity, OWLOntology ontology)
entity
- The entityontology
- The ontology.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.static Collection<IRI> determineIllegalPunnings(boolean add, Stream<OWLEntity> signature, Collection<IRI> punnedEntities)
signature
- signature for the ontologypunnedEntities
- the set of entities that are known already to be punnedadd
- true if missing declarations should be added. If false, no declarations will be
added.static Collection<IRI> computeIllegals(com.google.common.collect.Multimap<IRI,EntityType<?>> punnings)
punnings
- input punningsboolean isAddMissingTypes()
true
if untyped entities should automatically be typed during rendering,
otherwise false
.void setAddMissingTypes(boolean addMissingTypes)
addMissingTypes
- true
if untyped entities should automatically be typed during
rendering, otherwise false
.void setParameter(Serializable key, Serializable value)
key
- key for the new entryvalue
- value for the new entry<T> T getParameter(Serializable key, T defaultValue)
T
- typekey
- key for the new entrydefaultValue
- value for the new entrydefault boolean isPrefixOWLDocumentFormat()
true
if this format is an instance of
PrefixDocumentFormat
other wise false
.default PrefixDocumentFormat asPrefixOWLDocumentFormat()
PrefixDocumentFormat
then this method will obtain it as a
PrefixDocumentFormat
.PrefixDocumentFormat
.ClassCastException
- if this format is not an instance of
PrefixDocumentFormat
Optional<OWLOntologyLoaderMetaData> getOntologyLoaderMetaData()
OWLDocumentFormat
will provide accessors etc. to details pertaining to the meta
data about loading.void setOntologyLoaderMetaData(OWLOntologyLoaderMetaData loaderMetaData)
loaderMetaData
- The metadata.NullPointerException
- if the argument is null
.String getKey()
boolean isTextual()
default boolean supportsRelativeIRIs()
Copyright © 2020 The University of Manchester. All rights reserved.