edu.ucla.sspace.wordsi

Class BaseWordsi

java.lang.Object

edu.ucla.sspace.wordsi.BaseWordsi

All Implemented Interfaces:

SemanticSpace, Wordsi

Direct Known Subclasses:

EvaluationWordsi, StreamingWordsi, WaitingWordsi

public abstract class BaseWordsi
extends Object
implements Wordsi, SemanticSpace

This base class accepts or rejects key words based on a set of acceptedWords and dispatches calls to a ContextExtractor so that Wordsi sub-classes will be called with each generated vector.

Author:

Keith Stevens

Constructor Summary

Constructors

Constructor and Description
BaseWordsi(Set<String> acceptedWords, ContextExtractor extractor) Creates a new BaseWordsi.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptWord(String word) Returns true if this Wordsi implementation should generate a semantic vector for word.
String	getSpaceName() Returns a unique string describing the name and configuration of this algorithm.
int	getVectorLength() Returns the length of vectors in this semantic space.
void	processDocument(BufferedReader document) Processes the contents of the provided file as a document.

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.ucla.sspace.wordsi.Wordsi

handleContextVector

Methods inherited from interface edu.ucla.sspace.common.SemanticSpace

getVector, getWords, processSpace

Constructor Detail

BaseWordsi

public BaseWordsi(Set<String> acceptedWords,
          ContextExtractor extractor)

Creates a new BaseWordsi.

Parameters:

acceptedWords - The set of words which Wordsi should represent, may be null or empty.

trackSecondaryKeys - If true, secondary key assignments will be tracked

Method Detail

acceptWord

public boolean acceptWord(String word)

Returns true if this Wordsi implementation should generate a semantic vector for word.

Specified by:

acceptWord in interface Wordsi

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)

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