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 and 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 and Description
Optional<InputStream>	getInputStream() If an input stream can be obtained from this document source then this method creates it.

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

getDocumentIRI, getFormat, getMIMEType, hasAlredyFailedOnIRIResolution, hasAlredyFailedOnStreams, setIRIResolutionFailed

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.semanticweb.owlapi.io.OWLOntologyDocumentSource

getReader

Constructor Detail

FileDocumentSource

public FileDocumentSource(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(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(File file,
                          @Nullable
                          OWLDocumentFormat format,
                          @Nullable
                          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

getInputStream

public Optional<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. If there is no input stream available, returns Optional.absent. .

Returns:

A new input stream which the ontology can be read from, wrapped in an Optional.