Package org.semanticweb.owlapi.io

Class FileDocumentSource

java.lang.Object

org.semanticweb.owlapi.io.OWLOntologyDocumentSourceBase

org.semanticweb.owlapi.io.FileDocumentSource

All Implemented Interfaces:

OWLOntologyDocumentSource

public class FileDocumentSource
extends OWLOntologyDocumentSourceBase

A convenience class which will prepare an input source from a file.

Since:

2.2.0

Author:

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

Constructor Summary

Constructors

Constructor	Description
FileDocumentSource(File file)	Constructs an ontology input source using the specified file.
FileDocumentSource(File file, OWLDocumentFormat format)	Constructs an ontology input source using the specified file.
FileDocumentSource(File file, OWLDocumentFormat format, String mime)	Constructs an ontology input source using the specified file.

Method Summary

Modifier and Type	Method	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 java.lang.Object

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

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

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

Constructor Detail

FileDocumentSource

public FileDocumentSource(@Nonnull
                          File file)

Constructs an ontology input source using the specified file.

Parameters:

file - The file from which a concrete representation of an ontology will be obtained.

FileDocumentSource

public FileDocumentSource(@Nonnull
                          File file,
                          OWLDocumentFormat format)

Constructs an ontology input source using the specified file.

Parameters:

file - The file from which a concrete representation of an ontology will be obtained.

format - ontology format. Can be null.

FileDocumentSource

public FileDocumentSource(@Nonnull
                          File file,
                          OWLDocumentFormat format,
                          String mime)

Constructs an ontology input source using the specified file.

Parameters:

file - The file from which a concrete representation of an ontology will be obtained.

format - ontology format. Can be null.

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

@Nonnull
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.

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.

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.