edu.ucla.sspace.temporal

Interface TemporalSemanticSpace

All Superinterfaces:

SemanticSpace

All Known Implementing Classes:

FileBasedTemporalSemanticSpace, FixedDurationTemporalRandomIndexing, OrderedTemporalRandomIndexing

public interface TemporalSemanticSpace
extends SemanticSpace

A common interface for interacting with semantic space models of meaning that include time information in their word representation.

Author:

David Jurgens

See Also:

SemanticSpace

Method Summary

Methods

Modifier and Type	Method and Description
Long	endTime() Returns the time for the latest semantics contained within this space.
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 startTime, 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).
void	processDocument(BufferedReader document) Processes the contents of the provided reader as a document, using the current time as the timestamp.
void	processDocument(BufferedReader document, long timestamp) Processes the contents of the provided buffer as a document, using the provided timestamp as the date when the document was written.
Long	startTime() Returns the time for the earliest semantics contained within this space.

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

getSpaceName, getVectorLength, getWords, processSpace

Method Detail

processDocument

void processDocument(BufferedReader document)
                     throws IOException

Processes the contents of the provided reader as a document, using the current time as the timestamp.

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

processDocument

void processDocument(BufferedReader document,
                   long timestamp)
                     throws IOException

Processes the contents of the provided buffer as a document, using the provided timestamp as the date when the document was written.

Parameters:

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

timestamp - the time at which the document was written

Throws:

IOException - if any error occurs while reading the document

startTime

Long startTime()

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

endTime

Long endTime()

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

getTimeSteps

SortedSet<Long> getTimeSteps(String word)

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

Parameters:

word -

getVectorAfter

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

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

Vector getVectorBefore(String word,
                     long endTime)

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

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

Vector getVectorBetween(String word,
                      long startTime,
                      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).

Parameters:

word - a word in the semantic space

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

Throws:

IllegalArgumentException - if startTime > endTime

getVector

Vector getVector(String word)

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

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.