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 and Description
FileDocumentTarget(File file) Constructs the document target, with the target being the specified file.

Method Summary

Modifier and Type	Method and Description
IRI	getDocumentIRI() Gets an IRI that points to an ontology document.
OutputStream	getOutputStream() Gets an OutputStream that can be used to write an ontology to an ontology document.
Writer	getWriter() Gets a Writer that can be used to write an ontology to an ontology document.
boolean	isDocumentIRIAvailable() Determines if an IRI that points to an ontology document is available.
boolean	isOutputStreamAvailable() Determines if this document target can be pointed to by an OutputStream.
boolean	isWriterAvailable() Determines if this document target can be pointed to by a Writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDocumentTarget

public FileDocumentTarget(@Nonnull
                          File file)

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

Parameters:

file - The file that is the target.

Method Detail

isWriterAvailable

public boolean isWriterAvailable()

Description copied from interface: OWLOntologyDocumentTarget

Determines if this document target can be pointed to by a Writer.

Specified by:

isWriterAvailable in interface OWLOntologyDocumentTarget

Returns:

true if a Writer can be obtained from this document target.

getWriter

@Nonnull
public Writer getWriter()
                          throws IOException

Description copied from interface: OWLOntologyDocumentTarget

Gets a Writer that can be used to write an ontology to an ontology document.

Specified by:

getWriter in interface OWLOntologyDocumentTarget

Returns:

The writer

Throws:

IOException - if there was a problem obtaining the writer

isOutputStreamAvailable

public boolean isOutputStreamAvailable()

Description copied from interface: OWLOntologyDocumentTarget

Determines if this document target can be pointed to by an OutputStream.

Specified by:

isOutputStreamAvailable in interface OWLOntologyDocumentTarget

Returns:

true if an OutputStream can be obtained from this document target.

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Description copied from interface: OWLOntologyDocumentTarget

Gets an OutputStream that can be used to write an ontology to an ontology document.

Specified by:

getOutputStream in interface OWLOntologyDocumentTarget

Returns:

The output stream

Throws:

IOException - if there was a problem obtaining the output stream

isDocumentIRIAvailable

public boolean isDocumentIRIAvailable()

Description copied from interface: OWLOntologyDocumentTarget

Determines if an IRI that points to an ontology document is available. The IRI encodes the exact details of how an ontology should be saved to a document.

Specified by:

isDocumentIRIAvailable in interface OWLOntologyDocumentTarget

Returns:

true if an IRI is available, otherwise false.

getDocumentIRI

public IRI getDocumentIRI()

Description copied from interface: OWLOntologyDocumentTarget

Gets an IRI that points to an ontology document.

Specified by:

getDocumentIRI in interface OWLOntologyDocumentTarget

Returns:

The IRI