org.semanticweb.owlapi.io

Class StreamDocumentSourceBase

java.lang.Object

org.semanticweb.owlapi.io.OWLOntologyDocumentSourceBase

org.semanticweb.owlapi.io.StreamDocumentSourceBase

All Implemented Interfaces:

OWLOntologyDocumentSource

Direct Known Subclasses:

ReaderDocumentSource, StreamDocumentSource

public abstract class StreamDocumentSourceBase
extends OWLOntologyDocumentSourceBase

Base class for common utilities among stream, reader and file input sources.

Since:

4.0.0 TODO both stream and reader sources copy the input in memory in case reloading is needed. This can be bad for memory. Remote loading will download the ontologies multiple times too, until parsing fails. Both issues could be addressed with a local file copy.

Constructor Summary

Constructors

Constructor and Description
StreamDocumentSourceBase(InputStream stream, IRI documentIRI, OWLDocumentFormat format, String mime) Constructs an input source which will read an ontology from a representation from the specified stream.
StreamDocumentSourceBase(Reader stream, IRI documentIRI, OWLDocumentFormat format, String mime) Constructs an input source which will read an ontology from a representation from the specified stream.

Method Summary

Modifier and Type	Method and Description
IRI	getDocumentIRI() Gets the IRI of the ontology document.
InputStream	getInputStream() If an input stream can be obtained from this document source then this method creates it.
Reader	getReader() Gets a reader which an ontology document can be read from.
boolean	isInputStreamAvailable() Determines if an input stream is available which an ontology document can be parsed from.
boolean	isReaderAvailable() Determines if a reader is available which an ontology document can be parsed from.

Methods inherited from class org.semanticweb.owlapi.io.OWLOntologyDocumentSourceBase

getAcceptHeaders, getFormat, getMIMEType, getNextDocumentIRI, isFormatKnown, isMIMETypeKnown, setAcceptHeaders, wrap

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamDocumentSourceBase

public StreamDocumentSourceBase(@Nonnull
                                InputStream stream,
                                @Nonnull
                                IRI documentIRI,
                                OWLDocumentFormat format,
                                String mime)

Constructs an input source which will read an ontology from a representation from the specified stream.

Parameters:

stream - The stream that the ontology representation will be read from.

documentIRI - The document IRI

format - ontology format

mime - mime type

StreamDocumentSourceBase

public StreamDocumentSourceBase(@Nonnull
                                Reader stream,
                                @Nonnull
                                IRI documentIRI,
                                OWLDocumentFormat format,
                                String mime)

Constructs an input source which will read an ontology from a representation from the specified stream.

Parameters:

stream - The stream that the ontology representation will be read from.

documentIRI - The document IRI

format - ontology format

mime - mime type

Method Detail

getDocumentIRI

public IRI getDocumentIRI()

Description copied from interface: OWLOntologyDocumentSource

Gets the IRI of the ontology document.

Returns:

An IRI which represents the ontology document IRI

isInputStreamAvailable

public boolean isInputStreamAvailable()

Description copied from interface: OWLOntologyDocumentSource

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

public InputStream getInputStream()

Description copied from interface: OWLOntologyDocumentSource

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.

getReader

public Reader getReader()

Description copied from interface: OWLOntologyDocumentSource

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.

isReaderAvailable

public boolean isReaderAvailable()

Description copied from interface: OWLOntologyDocumentSource

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.