edu.illinois.cs.cogcomp.core.utilities

Class SerializationHelper

java.lang.Object

edu.illinois.cs.cogcomp.core.utilities.SerializationHelper

public class SerializationHelper
extends Object

This class is useful for serializing TextAnnotation objects to byte arrays.

Constructor Summary

Constructors

Constructor and Description
SerializationHelper()

Method Summary

Modifier and Type	Method and Description
static TextAnnotation	deserializeFromJson(String jsonString) Read a text annotation from a json string.
static TextAnnotation	deserializeFromProtobuf(String fileName) Read a text annotation from a Protocol Buffer encoding of Text Annotation.
static TextAnnotation	deserializeTextAnnotationFromBytes(byte[] obj) Read a text annotation from a byte array.
static TextAnnotation	deserializeTextAnnotationFromFile(String fileName) Read serialized record from file and deserialize it.
static TextAnnotation	deserializeTextAnnotationFromFile(String fileName, boolean isJson) Read serialized record from file and deserialize it.
static byte[]	serializeTextAnnotationToBytes(TextAnnotation ta) Serialize a text annotation into a byte array.
static void	serializeTextAnnotationToFile(TextAnnotation ta, String fileName, boolean forceOverwrite) Serialize a TextAnnotation and then write to file.
static void	serializeTextAnnotationToFile(TextAnnotation ta, String fileName, boolean forceOverwrite, boolean useJson) Serialize a TextAnnotation and then write to file.
static void	serializeTextAnnotationToProtobuf(TextAnnotation ta, String fileName, boolean forceOverwrite) Serialize a text annotation into a protocol buffer encoded output file.
static String	serializeToJson(TextAnnotation ta) Serialize a text annotation into a json string.
static String	serializeToJson(TextAnnotation ta, boolean writeTokenCharacterOffsets) Serialize a text annotation into a json string, with option for explicit offsets for tokens.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializationHelper

public SerializationHelper()

Method Detail

serializeTextAnnotationToFile

public static void serializeTextAnnotationToFile(TextAnnotation ta,
                                                 String fileName,
                                                 boolean forceOverwrite)
                                          throws IOException

Serialize a TextAnnotation and then write to file. If forceOverwrite_ is set to false and file already exists, this method throws an exception. Uses binary serialization for TextAnnotation.

Parameters:

ta - The text annotation to be serialized

fileName - Name of file to write to

forceOverwrite - Whether or not to overwrite existing file.

Throws:

IOException

serializeTextAnnotationToFile

public static void serializeTextAnnotationToFile(TextAnnotation ta,
                                                 String fileName,
                                                 boolean forceOverwrite,
                                                 boolean useJson)
                                          throws IOException

Serialize a TextAnnotation and then write to file. If forceOverwrite_ is set to false and file already exists, this method throws an exception.

Parameters:

ta - The text annotation to be serialized

fileName - Name of file to write to

forceOverwrite - Whether or not to overwrite existing file.

Throws:

IOException

serializeTextAnnotationToBytes

public static byte[] serializeTextAnnotationToBytes(TextAnnotation ta)
                                             throws IOException

Serialize a text annotation into a byte array. This can be useful for writing into a file or a database record. Uses Apache's SerializationUtils.

Parameters:

ta - The text annotation to be serialized

Returns:

A byte array

Throws:

IOException

deserializeTextAnnotationFromFile

public static TextAnnotation deserializeTextAnnotationFromFile(String fileName)
                                                        throws Exception

Read serialized record from file and deserialize it. Expects Thrift serialization format, one record in a single file.

Parameters:

fileName - Name of file to read from

Returns:

A text annotation

Throws:

Exception

deserializeTextAnnotationFromFile

public static TextAnnotation deserializeTextAnnotationFromFile(String fileName,
                                                               boolean isJson)
                                                        throws Exception

Read serialized record from file and deserialize it. Expects Thrift serialization format, one record in a single file.

Parameters:

fileName - Name of file to read from

Returns:

A text annotation

Throws:

Exception

deserializeTextAnnotationFromBytes

public static TextAnnotation deserializeTextAnnotationFromBytes(byte[] obj)

Read a text annotation from a byte array. The byte array must be one that is generated by the serializeTextAnnotationToBytes(TextAnnotation) function. Uses Apache's SerializationUtils.

Parameters:

obj - The byte array

Returns:

A text annotation

serializeToJson

public static String serializeToJson(TextAnnotation ta,
                                     boolean writeTokenCharacterOffsets)

Serialize a text annotation into a json string, with option for explicit offsets for tokens. This is potentially useful for generating annotated data for use with other tool sets.

Parameters:

ta - The text annotation to be serialized

writeTokenCharacterOffsets - whether or not to write explicit token offsets.

Returns:

A json string

serializeToJson

public static String serializeToJson(TextAnnotation ta)

Serialize a text annotation into a json string. This can be useful for writing into a file or a database record

Parameters:

ta - The text annotation to be serialized

Returns:

A json string

deserializeFromJson

public static TextAnnotation deserializeFromJson(String jsonString)
                                          throws Exception

Read a text annotation from a json string. The input string must be one that is generated by the serializeToJson(TextAnnotation) function

Parameters:

jsonString - The json string representation for the text

Returns:

A text annotation

Throws:

Exception

serializeTextAnnotationToProtobuf

public static void serializeTextAnnotationToProtobuf(TextAnnotation ta,
                                                     String fileName,
                                                     boolean forceOverwrite)
                                              throws Exception

Serialize a text annotation into a protocol buffer encoded output file.

Parameters:

ta - Text Annotation to be serialized

fileName - Name of the file to write to

forceOverwrite - Boolean indicating if the output file should be overwritten if it already exists

Throws:

Exception

deserializeFromProtobuf

public static TextAnnotation deserializeFromProtobuf(String fileName)
                                              throws Exception

Read a text annotation from a Protocol Buffer encoding of Text Annotation.

Parameters:

fileName - Input file name

Returns:

A text annotation

Throws:

Exception