edu.stanford.nlp.pipeline

Class AnnotationSerializer

java.lang.Object

edu.stanford.nlp.pipeline.AnnotationSerializer

Direct Known Subclasses:

CustomAnnotationSerializer, GenericAnnotationSerializer, ProtobufAnnotationSerializer

public abstract class AnnotationSerializer
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationSerializer.IntermediateEdge
static class	AnnotationSerializer.IntermediateNode
static class	AnnotationSerializer.IntermediateSemanticGraph

Constructor Summary

Constructors

Constructor and Description
AnnotationSerializer()

Method Summary

Modifier and Type	Method and Description
abstract Pair<Annotation,java.io.InputStream>	read(java.io.InputStream is) Read a single object from this stream.
Pair<CoreDocument,java.io.InputStream>	readCoreDocument(java.io.InputStream is) Read in a CoreDocument from this input stream.
abstract java.io.OutputStream	write(Annotation corpus, java.io.OutputStream os) Append a single object to this stream.
java.io.OutputStream	writeCoreDocument(CoreDocument document, java.io.OutputStream os) Append a CoreDocument to this output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationSerializer

public AnnotationSerializer()

Method Detail

write

public abstract java.io.OutputStream write(Annotation corpus,
                                           java.io.OutputStream os)
                                    throws java.io.IOException

Append a single object to this stream. Subsequent calls to append on the same stream must supply the returned output stream; furthermore, implementations of this function must be prepared to handle the same output stream being passed in as it returned on the previous write.

Parameters:

corpus - The document to serialize to the stream.

os - The output stream to serialize to.

Returns:

The output stream which should be closed when done writing, and which should be passed into subsequent calls to write() on this serializer.

Throws:

java.io.IOException - Thrown if the underlying output stream throws the exception.

read

public abstract Pair<Annotation,java.io.InputStream> read(java.io.InputStream is)
                                                   throws java.io.IOException,
                                                          java.lang.ClassNotFoundException,
                                                          java.lang.ClassCastException

Read a single object from this stream. Subsequent calls to read on the same input stream must supply the returned input stream; furthermore, implementations of this function must be prepared to handle the same input stream being passed to it as it returned on the previous read.

Parameters:

is - The input stream to read a document from.

Returns:

A pair of the read document, and the implementation-specific input stream which it was actually read from. This stream should be passed to subsequent calls to read on the same stream, and should be closed when reading completes.

Throws:

java.io.IOException - Thrown if the underlying stream throws the exception.

java.lang.ClassNotFoundException - Thrown if an object was read that does not exist in the classpath.

java.lang.ClassCastException - Thrown if the signature of a class changed in way that was incompatible with the serialized document.

writeCoreDocument

public java.io.OutputStream writeCoreDocument(CoreDocument document,
                                              java.io.OutputStream os)
                                       throws java.io.IOException

Append a CoreDocument to this output stream.

Parameters:

document - The CoreDocument to serialize (its internal annotation is serialized)

os - The output stream to serialize to

Returns:

The output stream which should be closed

Throws:

java.io.IOException

readCoreDocument

public Pair<CoreDocument,java.io.InputStream> readCoreDocument(java.io.InputStream is)
                                                        throws java.io.IOException,
                                                               java.lang.ClassNotFoundException,
                                                               java.lang.ClassCastException

Read in a CoreDocument from this input stream.

Parameters:

is - The input stream to read a CoreDocument's annotation from

Returns:

A pair with the CoreDocument and the input stream

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.ClassCastException