Package org.semanticweb.owlapi.io

Class XZFileDocumentTarget

java.lang.Object

org.semanticweb.owlapi.io.XZFileDocumentTarget

All Implemented Interfaces:

AutoCloseable, OWLOntologyDocumentTarget

public class XZFileDocumentTarget
extends Object
implements OWLOntologyDocumentTarget, AutoCloseable

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

Since:

4.0.2

Author:

ses

Constructor Summary

Constructors

Constructor	Description
XZFileDocumentTarget(File file)	Construct an XZ document target
XZFileDocumentTarget(File os, int presetLevel)	Construct an XZ document target using the selected compression preset
XZFileDocumentTarget(File os, org.tukaani.xz.FilterOptions... filterOptions)

Method Summary

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

Methods inherited from class java.lang.Object

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

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

getWriter

Constructor Details

XZFileDocumentTarget

public XZFileDocumentTarget(File os,
 org.tukaani.xz.FilterOptions... filterOptions)

Parameters:

os - the actual file

filterOptions - Settings for XZ compression

XZFileDocumentTarget

public XZFileDocumentTarget(File os,
 int presetLevel)
                     throws org.tukaani.xz.UnsupportedOptionsException

Construct an XZ document target using the selected compression preset

Parameters:

os - target File

presetLevel - LZMA2 Compression preset level

Throws:

org.tukaani.xz.UnsupportedOptionsException - if the options selected are not acceptable

XZFileDocumentTarget

public XZFileDocumentTarget(File file)

Construct an XZ document target

Parameters:

file - target File

Method Details

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

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception