edu.ucla.sspace.common

Class SemanticSpaceWriter

java.lang.Object

edu.ucla.sspace.common.SemanticSpaceWriter

public class SemanticSpaceWriter
extends Object

An output utility to write a SemanticSpace incrementally, one vector at a time. This class is designed for algorithms that need to write SemanticSpace instances that are too large to fit into memory but can still be computed.

Upon writing the last vector, users of this class must call #close() close to ensure that the file header is correctly written.

See Also:

SemanticSpaceIO

Constructor Summary

Constructors

Constructor and Description
SemanticSpaceWriter(File sspaceFile, SemanticSpaceIO.SSpaceFormat format) Creates a SemanticSpaceWriter that will write a SemanticSpace to the provided file in the specified format.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Finishes writing the SemanticSpace and writes all the associated meta data.
File	getFile() Returns the file containing the SemanticSpace
void	write(String word, Vector vector) Writes the provided word and vector to the SemanticSpace on disk.

Methods inherited from class java.lang.Object

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

Constructor Detail

SemanticSpaceWriter

public SemanticSpaceWriter(File sspaceFile,
                   SemanticSpaceIO.SSpaceFormat format)

Creates a SemanticSpaceWriter that will write a SemanticSpace to the provided file in the specified format.

Parameters:

sspaceFile - the file to which the SemanticSpace will be written

format - the format of the semantic space

Method Detail

close

public void close()
           throws IOException

Finishes writing the SemanticSpace and writes all the associated meta data. Once this method has been called, the backing file is valid to read using SemanticSpaceIO.

Throws:

IOException

getFile

public File getFile()

Returns the file containing the SemanticSpace

write

public void write(String word,
         Vector vector)
           throws IOException

Writes the provided word and vector to the SemanticSpace on disk.

Throws:

IOException