Package org.semanticweb.owlapi.io

Class FileDocumentTarget

java.lang.Object

org.semanticweb.owlapi.io.FileDocumentTarget

All Implemented Interfaces:

OWLOntologyDocumentTarget

public class FileDocumentTarget
extends Object
implements OWLOntologyDocumentTarget

An OWLOntologyDocumentTarget that supports writing out to a File.

Since:

3.2.0

Author:

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

Constructor Summary

Constructors

Constructor	Description
FileDocumentTarget(File file)	Constructs the document target, with the target being the specified file.

Method Summary

Modifier and Type	Method	Description
Optional<IRI>	getDocumentIRI()	Gets an IRI that points to an ontology document.
Optional<OutputStream>	getOutputStream()	Gets an OutputStream that can be used to write an ontology to an ontology document.
Optional<Writer>	getWriter()	Gets a Writer that can be used to write an ontology to an ontology document.

Methods inherited from class java.lang.Object

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

Constructor Details

FileDocumentTarget

public FileDocumentTarget(File file)

Constructs the document target, with the target being the specified file.

Parameters:

file - The file that is the target.

Method Details

getWriter

public Optional<Writer> getWriter()

Description copied from interface: OWLOntologyDocumentTarget

Gets a Writer that can be used to write an ontology to an ontology document. If none is available, return Optional.absent. Do not call multiple times for the same file: the output file will be opened for write multiple times.

Specified by:

getWriter in interface OWLOntologyDocumentTarget

Returns:

The writer

getOutputStream

public Optional<OutputStream> getOutputStream()

Description copied from interface: OWLOntologyDocumentTarget

Gets an OutputStream that can be used to write an ontology to an ontology document. If none is available, return Optional.absent. Do not call multiple times for the same file: the output file will be opened for write multiple times.

Specified by:

getOutputStream in interface OWLOntologyDocumentTarget

Returns:

The output stream

getDocumentIRI

public Optional<IRI> getDocumentIRI()

Description copied from interface: OWLOntologyDocumentTarget

Gets an IRI that points to an ontology document. If none is available, return Optional.absent.

Specified by:

getDocumentIRI in interface OWLOntologyDocumentTarget

Returns:

The IRI