org.semanticweb.owlapi.io

Interface OWLOntologyDocumentSource

All Known Implementing Classes:

FileDocumentSource, GZipFileDocumentSource, GZipStreamDocumentSource, IRIDocumentSource, OWLOntologyDocumentSourceBase, ReaderDocumentSource, StreamDocumentSource, StreamDocumentSourceBase, StringDocumentSource, XZFileDocumentSource, XZStreamDocumentSource

public interface OWLOntologyDocumentSource

A document source provides a point for loading an ontology. A document source may provide three ways of obtaining an ontology document:

1. From a Reader
2. From an InputStream
3. From an ontology document IRI

Consumers that use a document source will attempt to obtain a concrete representation of an ontology in the above order.
Note that while an ontology document source may appear similar to a SAX input source, an important difference is that the getReader and getInputStream methods return new instances each time the method is called. This allows multiple attempts at loading an ontology.

Since:

2.0.0

Author:

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

Method Summary

Modifier and Type	Method and Description
default Optional<String>	getAcceptHeaders()
IRI	getDocumentIRI() Gets the IRI of the ontology document.
OWLDocumentFormat	getFormat()
InputStream	getInputStream() If an input stream can be obtained from this document source then this method creates it.
String	getMIMEType()
Reader	getReader() Gets a reader which an ontology document can be read from.
boolean	isFormatKnown()
boolean	isInputStreamAvailable() Determines if an input stream is available which an ontology document can be parsed from.
boolean	isMIMETypeKnown()
boolean	isReaderAvailable() Determines if a reader is available which an ontology document can be parsed from.
default void	setAcceptHeaders(String headers)

Method Detail

isReaderAvailable

boolean isReaderAvailable()

Determines if a reader is available which an ontology document can be parsed from.

Returns:

true if a reader can be obtained from this document source, or false if a reader cannot be obtained from this document source.

getReader

@Nonnull
Reader getReader()

Gets a reader which an ontology document can be read from. This method may be called multiple times. Each invocation will return a new Reader. This method should not be called if the isReaderAvailable method returns false. A Runtime execption will be thrown if this happens.

Returns:

A new Reader which the ontology can be read from.

isInputStreamAvailable

boolean isInputStreamAvailable()

Determines if an input stream is available which an ontology document can be parsed from.

Returns:

true if an input stream can be obtained, false if an input stream cannot be obtained from this document source.

getInputStream

@Nonnull
InputStream getInputStream()

If an input stream can be obtained from this document source then this method creates it. This method may be called multiple times. Each invocation will return a new input stream. This method should not be called if the isInputStreamAvailable method returns false .

Returns:

A new input stream which the ontology can be read from.

getDocumentIRI

@Nonnull
IRI getDocumentIRI()

Gets the IRI of the ontology document.

Returns:

An IRI which represents the ontology document IRI

getFormat

@Nullable
OWLDocumentFormat getFormat()

Returns:

format for the ontology, if known, null otherwise

isFormatKnown

boolean isFormatKnown()

Returns:

true if the format is known

getMIMEType

String getMIMEType()

Returns:

MIME type for this source, if one is specified.

isMIMETypeKnown

boolean isMIMETypeKnown()

Returns:

true if the MIME type for this source is known

setAcceptHeaders

default void setAcceptHeaders(String headers)

Parameters:

headers - accept headers; if not set, the mime type will be used; if that is also missing, the available parsers will contribute the headers

getAcceptHeaders

default Optional<String> getAcceptHeaders()

Returns:

currently set accept headers