org.semanticweb.owlapi.io

Class XZStreamDocumentTarget

java.lang.Object

org.semanticweb.owlapi.io.XZStreamDocumentTarget

All Implemented Interfaces:

AutoCloseable, OWLOntologyDocumentTarget

public class XZStreamDocumentTarget
extends Object
implements OWLOntologyDocumentTarget, AutoCloseable

An ontology document target which can write to a XZ stream. Notice that this works best when the output stream is closed explicitly in the client code.

Since:

3.4.8

Author:

ignazio

Constructor Summary

Constructors

Constructor and Description
XZStreamDocumentTarget(OutputStream os, org.tukaani.xz.FilterOptions... filterOptions)
XZStreamDocumentTarget(OutputStream os, int presetLevel)

Method Summary

Modifier and Type	Method and Description
void	close()
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

XZStreamDocumentTarget

public XZStreamDocumentTarget(OutputStream os,
                              org.tukaani.xz.FilterOptions... filterOptions)

Parameters:

os - the actual output stream

filterOptions - XZ filter options to use. If no options are supplied use default LZMA2 Options.

XZStreamDocumentTarget

public XZStreamDocumentTarget(OutputStream os,
                              int presetLevel)
                       throws org.tukaani.xz.UnsupportedOptionsException

Parameters:

os - output stream to wrap

presetLevel - LZMA2 Preset Level to use

Throws:

org.tukaani.xz.UnsupportedOptionsException - if an unsupported preset level is supplied

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()

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

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

@Nonnull
public OutputStream getOutputStream()

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

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

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

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception