edu.ucla.sspace.common

Class StaticSemanticSpace

java.lang.Object

edu.ucla.sspace.common.StaticSemanticSpace

All Implemented Interfaces:

SemanticSpace

public class StaticSemanticSpace
extends Object
implements SemanticSpace

An unmodifiable SemanticSpace whose data is loaded into memory from an .sspace file. Instance of this class perform no document processing, and the processDocument and processSpace methods throw an UnsupportedOperationException.

In general, users should call SemanticSpaceUtils.loadSemanticSpace(File) rather than create an instance of this class directly.

This class is thread-safe

See Also:

OnDiskSemanticSpace, SemanticSpaceUtils, SemanticSpaceUtils.SSpaceFormat

Constructor Summary

Constructors

Constructor and Description
StaticSemanticSpace(File file) Creates the StaticSemanticSpace from the provided file.
StaticSemanticSpace(File file, SemanticSpaceIO.SSpaceFormat format) Deprecated.
StaticSemanticSpace(String filename) Creates the StaticSemanticSpace 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 term) 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

StaticSemanticSpace

public StaticSemanticSpace(String filename)
                    throws IOException

Creates the StaticSemanticSpace from the file.

Parameters:

filename - the name of a file containing SemanticSpace data.

Throws:

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

StaticSemanticSpace

public StaticSemanticSpace(File file)
                    throws IOException

Creates the StaticSemanticSpace from the provided file.

Parameters:

file - a file containing the data of a SemanticSpace.

Throws:

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

StaticSemanticSpace

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

Deprecated.

Creates the StaticSemanticSpace from the provided file in the specified format. This method is only to be used in accessing SemanticSpace files that do not include the format in their file contents.

Parameters:

file - a file containing the data of a SemanticSpace.

format - the format of the semantic 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 term)

Returns the semantic vector for the provided word.

Specified by:

getVector in interface SemanticSpace

Parameters:

term - 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.

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

Throws:

an - UnsupportedOperationException if called

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.

Throws:

an - UnsupportedOperationException if called