edu.ucla.sspace.tools

Class BasisMaker.OccurrenceCounter

java.lang.Object

edu.ucla.sspace.tools.BasisMaker.OccurrenceCounter

All Implemented Interfaces:

SemanticSpace

Enclosing class:

BasisMaker

public class BasisMaker.OccurrenceCounter
extends Object
implements SemanticSpace

A simple term SemanticSpace implementation that counts word co-occurrences, performs a transform, and then scores each recorded basis dimension based on the row summed scores for each word.

Constructor Summary

Constructors

Constructor and Description
BasisMaker.OccurrenceCounter(Transform transform, int bound, int windowSize) Creates a new BasisMaker.OccurrenceCounter.

Method Summary

Methods

Modifier and Type	Method and Description
String	getSpaceName() Returns a unique string describing the name and configuration of this algorithm.
DoubleVector	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasisMaker.OccurrenceCounter

public BasisMaker.OccurrenceCounter(Transform transform,
                            int bound,
                            int windowSize)

Creates a new BasisMaker.OccurrenceCounter.

Method Detail

processDocument

public void processDocument(BufferedReader document)
                     throws IOException

Processes the contents of the provided file as a document.

Specified by:

processDocument in interface SemanticSpace

Parameters:

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

Throws:

IOException - if any error occurs while reading the document

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

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

processSpace

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

Specified by:

processSpace in interface SemanticSpace

Parameters:

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

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