edu.ucla.sspace.common

Interface SemanticSpace

All Known Subinterfaces:

DimensionallyInterpretableSemanticSpace<T>, TemporalSemanticSpace

All Known Implementing Classes:

BaseWordsi, BasisMaker.OccurrenceCounter, Beagle, CachingOnDiskSemanticSpace, Coals, DependencyBasisMaker.OccurrenceCounter, DependencyRandomIndexing, DependencyVectorSpace, EvaluationWordsi, ExplicitSemanticAnalysis, FileBasedTemporalSemanticSpace, FixedDurationTemporalRandomIndexing, GenericTermDocumentVectorSpace, GenericWordSpace, Grefenstette, HyperspaceAnalogueToLanguage, IncrementalSemanticAnalysis, LatentSemanticAnalysis, LocalityPreservingCooccurrenceSpace, LocalityPreservingSemanticAnalysis, OnDiskSemanticSpace, OrderedTemporalRandomIndexing, PurandareFirstOrder, RandomIndexing, ReflectiveRandomIndexing, StaticSemanticSpace, StreamingWordsi, StructuredVectorSpace, VectorMapSemanticSpace, VectorSpaceModel, WaitingWordsi

public interface SemanticSpace

A common interface for interacting with semantic space models of meaning. Implementations should expect the following sequence of processing.

1. processDocument will be called one or more times with the text of the corpus.
2. processSpace will be called after all the documents have been used. Once this method has been called, no further calls to processDocument should be made
3. getVector may be called after the space has been processed. Implementations may optionally support this method being called prior to processSpace but this is not required.

In addition, getWords() may be called at any time to determine which words are currently represented in the space. Implementations should specify in their class documentations what parameters are available as properties for the processSpace method, and what the default value of those parameters are.

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) Processes the contents of the provided file as a document.
void	processSpace(Properties properties) Once all the documents have been processed, performs any post-processing steps on the data.

Method Detail

processDocument

void processDocument(BufferedReader document)
                     throws IOException

Processes the contents of the provided file as a document.

Parameters:

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

Throws:

IOException - if any error occurs while reading the document

getWords

Set<String> getWords()

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

Returns:

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

getVector

Vector getVector(String word)

Returns the semantic vector for the provided word.

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.

processSpace

void processSpace(Properties properties)

Once all the documents have been processed, performs any post-processing steps on the data. An algorithm should treat this as a no-op if no post-processing is required. Callers may specify the values for any exposed parameters using the properties argument.

By general contract, once this method has been called, processDocument will not be called again.

Parameters:

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

getSpaceName

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.

getVectorLength

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.