tml.vectorspace.operations
Interface Operation<E>

Type Parameters:

E - the class representing the results of the operation

All Known Subinterfaces:

SummarizationOperation

All Known Implementing Classes:

AbstractOperation, AbstractSummarizationOperation, CompoundNounsSummarized, ConceptExtraction, FactorAnalysisPlot, GrammarChecker, LastPassage, LatentSemanticAnalysisSummarization, LexiconAnalysis, ParagraphCoherenceIndex, PassageDistances, PassageExtractionSummarization, PassagesSimilarity, RapidAutomaticKeywordExtraction, Readability, RelationshipExtraction, Summary, TagClouds, TermExtractionSummarization, VectorLengthSummarization

public interface Operation<E>

This interface represents an operation on the SemanticSpace of a Corpus.

Author:

Jorge Villalon

Method Summary

void	addOperationListener(OperationListener listener)
Corpus	getBackgroundKnowledgeCorpus()
Corpus	getCorpus()
int	getMaxResults()
java.lang.String	getName()
java.util.List<E>	getResults()
java.lang.String	getResultsCSVString()
int	getResultsNumber()
java.lang.String[][]	getResultsStringTable()
java.lang.Object[][]	getResultsTable()
java.lang.Object[]	getResultsTableHeader()
java.lang.String	getResultsXML()
long	getTimeElapsed()
void	printResultsCSV() Prints the results on the console using a comma as separator
void	printResultsMatlab() Prints the results on the console a'la Matlab
void	removeOperationListener(OperationListener listener)
void	setBackgroundKnowledgeCorpus(Corpus backgroundKnowledgeCorpus)
void	setCorpus(Corpus corpus)
void	setMaxResults(int maxResults)
void	start() Starts the operation execution

Method Detail

getName

java.lang.String getName()

Returns:

the name of the operation in a human readable way

setCorpus

void setCorpus(Corpus corpus)

Parameters:

corpus - sets the Corpus that will be used for the operation

getCorpus

Corpus getCorpus()

Returns:

the Corpus used for the operation

getTimeElapsed

long getTimeElapsed()

Returns:

the time the operation took

start

void start()
           throws java.lang.Exception

Starts the operation execution

Throws:

java.lang.Exception

getResultsNumber

int getResultsNumber()

Returns:

the number of results the operation got

getResults

java.util.List<E> getResults()

Returns:

the results of the operation

getResultsTable

java.lang.Object[][] getResultsTable()

Returns:

the table with the results

getResultsStringTable

java.lang.String[][] getResultsStringTable()

Returns:

the table with the results

getResultsTableHeader

java.lang.Object[] getResultsTableHeader()

Returns:

the headers of the results table

setMaxResults

void setMaxResults(int maxResults)

Parameters:

maxResults - the maximum results the operation will return

getMaxResults

int getMaxResults()

Returns:

the maximum results set for this operation

printResultsCSV

void printResultsCSV()

Prints the results on the console using a comma as separator

getResultsCSVString

java.lang.String getResultsCSVString()

Returns:

results are presented as a set of lines separated by commas

getResultsXML

java.lang.String getResultsXML()

printResultsMatlab

void printResultsMatlab()

Prints the results on the console a'la Matlab

setBackgroundKnowledgeCorpus

void setBackgroundKnowledgeCorpus(Corpus backgroundKnowledgeCorpus)

getBackgroundKnowledgeCorpus

Corpus getBackgroundKnowledgeCorpus()

addOperationListener

void addOperationListener(OperationListener listener)

removeOperationListener

void removeOperationListener(OperationListener listener)