edu.ucla.sspace.temporal

Class FileBasedTemporalSemanticSpace

java.lang.Object

edu.ucla.sspace.temporal.FileBasedTemporalSemanticSpace

All Implemented Interfaces:

SemanticSpace, TemporalSemanticSpace

public class FileBasedTemporalSemanticSpace
extends Object
implements TemporalSemanticSpace

A TemporalSemanticSpace created from the serialized output of another TemporalSemanticSpace after it has finished processing. The input format of the file should be one of the formats specified by TSSpaceFormat.

See Also:

TemporalSemanticSpaceUtils

Constructor Summary

Constructors

Constructor and Description
FileBasedTemporalSemanticSpace(File file) Creates the FileBasedTemporalSemanticSpace from the provided file in the text format.
FileBasedTemporalSemanticSpace(File file, TemporalSemanticSpaceUtils.TSSpaceFormat format) Creates the FileBasedTemporalSemanticSpace from the provided file in the specified format.
FileBasedTemporalSemanticSpace(String filename) Creates the FileBasedTemporalSemanticSpace from the file using the text format.
FileBasedTemporalSemanticSpace(String filename, TemporalSemanticSpaceUtils.TSSpaceFormat format) Creates the FileBasedTemporalSemanticSpace from the file in the specified format.

Method Summary

Methods

Modifier and Type	Method and Description
Long	endTime() Returns the time for the latest semantics contained within this space.
String	getSpaceName() Returns a unique string describing the name and configuration of this algorithm.
SortedSet<Long>	getTimeSteps(String word) Returns the time steps in which the provided word occurs (optional operation).
Vector	getVector(String word) Returns the provided word's semantic vector based on all temporal occurrences.
Vector	getVectorAfter(String word, long startTime) Returns the provided word's semantic vector based on all temporal occurrences occurring on or after the provided timestamp (optional operation).
Vector	getVectorBefore(String word, long endTime) Returns the provided word's semantic vector based on all temporal occurrences before the provided timestamp (optional operation).
Vector	getVectorBetween(String word, long start, long endTime) Returns the provided word's semantic vector based on all temporal occurrences that happened on or after the start timestamp but before the ending timestamp (optional operation).
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) A noop.
void	processDocument(BufferedReader document, long time) A noop.
void	processSpace(Properties props) A noop.
Long	startTime() Returns the time for the earliest semantics contained within this space.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBasedTemporalSemanticSpace

public FileBasedTemporalSemanticSpace(String filename)

Creates the FileBasedTemporalSemanticSpace from the file using the text format.

Parameters:

filename - filename of the data intended be provided by this TemporalSemanticSpace.

FileBasedTemporalSemanticSpace

public FileBasedTemporalSemanticSpace(File file)

Creates the FileBasedTemporalSemanticSpace from the provided file in the text format.

Parameters:

file - a file containing the data intended be provided by this TemporalSemanticSpace.

FileBasedTemporalSemanticSpace

public FileBasedTemporalSemanticSpace(String filename,
                              TemporalSemanticSpaceUtils.TSSpaceFormat format)

Creates the FileBasedTemporalSemanticSpace from the file in the specified format.

Parameters:

filename - the name of a file containing the data intended be provided by this TemporalSemanticSpace.

FileBasedTemporalSemanticSpace

public FileBasedTemporalSemanticSpace(File file,
                              TemporalSemanticSpaceUtils.TSSpaceFormat format)

Creates the FileBasedTemporalSemanticSpace from the provided file in the specified format.

Parameters:

file - a file containing the data intended be provided by this TemporalSemanticSpace.

Method Detail

startTime

public Long startTime()

Returns the time for the earliest semantics contained within this space.

Specified by:

startTime in interface TemporalSemanticSpace

endTime

public Long endTime()

Returns the time for the latest semantics contained within this space.

Specified by:

endTime in interface TemporalSemanticSpace

getVector

public Vector getVector(String word)

Returns the provided word's semantic vector based on all temporal occurrences.

Specified by:

getVector in interface SemanticSpace

Specified by:

getVector in interface TemporalSemanticSpace

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.

getVectorAfter

public Vector getVectorAfter(String word,
                    long startTime)

Returns the provided word's semantic vector based on all temporal occurrences occurring on or after the provided timestamp (optional operation).

Specified by:

getVectorAfter in interface TemporalSemanticSpace

Parameters:

word - a word in the semantic space

startTime - a UNIX timestamp that denotes the time after which all occurrences of the provided word should be counted.

Returns:

the semantic vector for the word after the provided time or null if the word was not in the space.

getVectorBefore

public Vector getVectorBefore(String word,
                     long endTime)

Returns the provided word's semantic vector based on all temporal occurrences before the provided timestamp (optional operation).

Specified by:

getVectorBefore in interface TemporalSemanticSpace

Parameters:

word - a word in the semantic space

endTime - a UNIX timestamp that denotes the time before which all occurrences of the provided would should be counted.

Returns:

the semantic vector for the word after the provided time or null if the word was not in the space.

getVectorBetween

public Vector getVectorBetween(String word,
                      long start,
                      long endTime)

Returns the provided word's semantic vector based on all temporal occurrences that happened on or after the start timestamp but before the ending timestamp (optional operation).

Specified by:

getVectorBetween in interface TemporalSemanticSpace

Parameters:

word - a word in the semantic space

start - a UNIX timestamp that denotes the time before which no occurrences of the word should be counted.

endTime - a UNIX timestamp that denotes the time after which no occurrences of the word should be counted.

Returns:

the semantic vector for the word after the provided time or null if the word was not in the space.

getTimeSteps

public SortedSet<Long> getTimeSteps(String word)

Returns the time steps in which the provided word occurs (optional operation).

Specified by:

getTimeSteps in interface TemporalSemanticSpace

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.

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)

A noop.

Specified by:

processDocument in interface SemanticSpace

Specified by:

processDocument in interface TemporalSemanticSpace

Parameters:

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

processDocument

public void processDocument(BufferedReader document,
                   long time)

A noop.

Specified by:

processDocument in interface TemporalSemanticSpace

Parameters:

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

time - the time at which the document was written

processSpace

public void processSpace(Properties props)

A noop.

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.