edu.ucla.sspace.common

Class OnDiskSemanticSpace

java.lang.Object

edu.ucla.sspace.common.OnDiskSemanticSpace

All Implemented Interfaces:

SemanticSpace

public class OnDiskSemanticSpace
extends Object
implements SemanticSpace

A SemanticSpace where all vector data is kept on disk. This class is designed for large semantic spaces whose data, even in sparse format, will not fit into memory.

The performance of this class is dependent on the format of the backing vector data; .sspace files in binary or sparse binary format will likely be faster for accessing the data due to it being in its native format.

The getWords method will return words in the order they are stored on disk. Accessing the words in this order will have to a significant performance improve over random access. Furtherore, random access to text and sparse text formatted matrices will have particularly poor performance for large semantic spaces, as the internal cursor to the data will have to restart from the beginning of the file.

This class is thread-safe.

See Also:

SemanticSpaceIO, StaticSemanticSpace

Constructor Summary

Constructors

Constructor and Description
OnDiskSemanticSpace(File file) Creates the OnDiskSemanticSpace from the provided file.
OnDiskSemanticSpace(File file, SemanticSpaceIO.SSpaceFormat format) Deprecated.
OnDiskSemanticSpace(String filename) Creates the OnDiskSemanticSpace from the file.

Method Summary

Methods

Modifier and Type	Method and Description
String	getSpaceName() Returns a unique string describing the name and configuration of this algorithm.
Vector	getVector(String word) Returns the semantic vector for the provided word.
int	getVectorLength() Returns the length of vectors in this semantic space.
Set<String>	getWords() Returns the set of words that are represented in this semantic space.
void	processDocument(BufferedReader document) Not supported; throws an UnsupportedOperationException if called.
void	processSpace(Properties props) Not supported; throws an UnsupportedOperationException if called.

Methods inherited from class java.lang.Object

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

Constructor Detail

OnDiskSemanticSpace

public OnDiskSemanticSpace(String filename)
                    throws IOException

Creates the OnDiskSemanticSpace from the file.

Parameters:

filename - the name of a semantic space file

Throws:

IOException - if any I/O exception occurs when reading the semantic space data from the file

Error - if the 4-byte header for the file contains an unrecognized semantic space format

OnDiskSemanticSpace

public OnDiskSemanticSpace(File file)
                    throws IOException

Creates the OnDiskSemanticSpace from the provided file.

Parameters:

file - a file containing a store semantic space

Throws:

IOException - if any I/O exception occurs when reading the semantic space data from the file

Error - if the 4-byte header for the file contains an unrecognized semantic space format

OnDiskSemanticSpace

@Deprecated
public OnDiskSemanticSpace(File file,
                              SemanticSpaceIO.SSpaceFormat format)
                    throws IOException

Deprecated.

Creates the OnDiskSemanticSpace from the provided file in the specified format. This constructor should only be used for loading semantic space files that do not have the 4-byte header indicating their format.

Parameters:

file - a file containing a semantic space

format - the format of the semanti space.

Throws:

IOException - if any I/O exception occurs when reading the semantic space data from the file

Method Detail

getWords

public Set<String> getWords()

Returns the set of words that are represented in this semantic space.

Specified by:

getWords in interface SemanticSpace

Returns:

the set of words that are represented in this semantic space.

getVector

public Vector getVector(String word)

Returns the semantic vector for the provided word.

Specified by:

getVector in interface SemanticSpace

Parameters:

word - a word that may be in the semantic space

Returns:

The Vector for the provided word or null if the word was not in the space.

Throws:

IOError - if any IOException occurs when reading the data from the underlying semantic space file.

getSpaceName

public String getSpaceName()

Returns a unique string describing the name and configuration of this algorithm. Any configurable parameters that would affect the resulting semantic space should be expressed as a part of this name.

Specified by:

getSpaceName in interface SemanticSpace

getVectorLength

public int getVectorLength()

Returns the length of vectors in this semantic space. Implementations are left free to define whether the returned value is valid before processSpace is called.

Specified by:

getVectorLength in interface SemanticSpace

processDocument

public void processDocument(BufferedReader document)

Not supported; throws an UnsupportedOperationException if called.

Specified by:

processDocument in interface SemanticSpace

Parameters:

document - a reader that allows access to the text of the document

processSpace

public void processSpace(Properties props)

Not supported; throws an UnsupportedOperationException if called.

Specified by:

processSpace in interface SemanticSpace

Parameters:

props - a set of properties and values that may be used to configure any exposed parameters of the algorithm.