org.semanticweb.binaryowl

Class BinaryOWLOntologyDocumentSerializer

java.lang.Object

org.semanticweb.binaryowl.owlobject.serializer.SerializerBase

org.semanticweb.binaryowl.BinaryOWLOntologyDocumentSerializer

public class BinaryOWLOntologyDocumentSerializer
extends SerializerBase

Author: Matthew Horridge
Stanford University
Bio-Medical Informatics Research Group
Date: 30/04/2012

Field Summary

Fields

Modifier and Type	Field and Description
static byte	CHUNK_FOLLOWS_MARKER

Constructor Summary

Constructors

Constructor and Description
BinaryOWLOntologyDocumentSerializer()

Method Summary

Modifier and Type	Method and Description
void	appendOntologyChanges(BinaryOWLOutputStream dos, OntologyChangeDataList changeRecords)
void	appendOntologyChanges(File file, OntologyChangeDataList changeRecords)
<E extends Throwable> void	read(InputStream inputStream, BinaryOWLOntologyDocumentHandler<E> handler, org.semanticweb.owlapi.model.OWLDataFactory df) Reads an OWLOntologyDocument that is stored in binary OWL.
void	write(OWLOntologyDocument document, OutputStream dos) Writes out an OWLOntologyDocument in binary OWL.
void	write(OWLOntologyDocument document, OutputStream os, BinaryOWLMetadata documentMetadata) Writes out an OWLOntologyDocument in binary OWL.

Methods inherited from class java.lang.Object

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

Field Detail

CHUNK_FOLLOWS_MARKER

public static final byte CHUNK_FOLLOWS_MARKER

See Also:

Constant Field Values

Constructor Detail

BinaryOWLOntologyDocumentSerializer

public BinaryOWLOntologyDocumentSerializer()

Method Detail

read

public <E extends Throwable> void read(InputStream inputStream,
                                       BinaryOWLOntologyDocumentHandler<E> handler,
                                       org.semanticweb.owlapi.model.OWLDataFactory df)
                                throws IOException,
                                       BinaryOWLParseException,
                                       org.semanticweb.owlapi.model.UnloadableImportException,
                                       E extends Throwable

Reads an OWLOntologyDocument that is stored in binary OWL.

Type Parameters:

E - The type of exception thrown by the handler.

Parameters:

inputStream - The input stream to read the document from. Not null.

handler - The handler that handels document elements as they are read. Not null.

df - An OWLDataFactory that can be used to instantiate OWLObjects. Not null.

Throws:

IOException - If there was a problem reading from the input stream.

BinaryOWLParseException - If the binary OWL format was corrupt.

org.semanticweb.owlapi.model.UnloadableImportException - If an import could not be loaded.

E - A custom exception type.

E extends Throwable

write

public void write(OWLOntologyDocument document,
                  OutputStream dos)
           throws IOException

Writes out an OWLOntologyDocument in binary OWL.

Parameters:

document - The document to be written out. Not null.

dos - The output stream to write the document to. Not null.

Throws:

IOException - If there was a problem writing to the stream.

NullPointerException - if any parameters are null.

write

public void write(OWLOntologyDocument document,
                  OutputStream os,
                  BinaryOWLMetadata documentMetadata)
           throws IOException

Writes out an OWLOntologyDocument in binary OWL.

Parameters:

document - The document to be written out. Not null.

os - The output stream to write the document to. Not null.

documentMetadata - Document metadata. Not null.

Throws:

IOException - If there was a problem writing to the stream.

NullPointerException - if any parameters are null.

appendOntologyChanges

public void appendOntologyChanges(BinaryOWLOutputStream dos,
                                  OntologyChangeDataList changeRecords)
                           throws IOException

Throws:

IOException

appendOntologyChanges

public void appendOntologyChanges(File file,
                                  OntologyChangeDataList changeRecords)
                           throws IOException

Throws:

IOException