org.semanticweb.owlapi.io

Class GZipFileDocumentSource

java.lang.Object

org.semanticweb.owlapi.io.GZipFileDocumentSource

All Implemented Interfaces:

OWLOntologyDocumentSource

public class GZipFileDocumentSource
extends Object
implements OWLOntologyDocumentSource

An ontology document source which can read from a GZIP File.

Since:

3.4.8

Author:

ignazio

Constructor Summary

Constructors

Constructor and Description
GZipFileDocumentSource(File is) Constructs an input source which will read an ontology from a representation from the specified file.
GZipFileDocumentSource(File stream, IRI documentIRI) Constructs an input source which will read an ontology from a representation from the specified file.

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.
static IRI	getNextDocumentIRI()
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 java.lang.Object

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

Constructor Detail

GZipFileDocumentSource

public GZipFileDocumentSource(File is)

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

Parameters:

is - The file that the ontology representation will be read from.

GZipFileDocumentSource

public GZipFileDocumentSource(File stream,
                              IRI documentIRI)

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

Parameters:

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

documentIRI - The document IRI

Method Detail

getNextDocumentIRI

public static IRI getNextDocumentIRI()

Returns:

a fresh 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.

Specified by:

isInputStreamAvailable in interface OWLOntologyDocumentSource

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.

Specified by:

getInputStream in interface OWLOntologyDocumentSource

Returns:

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

getDocumentIRI

public IRI getDocumentIRI()

Description copied from interface: OWLOntologyDocumentSource

Gets the IRI of the ontology document.

Specified by:

getDocumentIRI in interface OWLOntologyDocumentSource

Returns:

An IRI which represents the ontology document IRI - this will never be null.

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.

Specified by:

getReader in interface OWLOntologyDocumentSource

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.

Specified by:

isReaderAvailable in interface OWLOntologyDocumentSource

Returns:

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