tml.vectorspace.operations
Class PassagesSimilarity

java.lang.Object
  tml.vectorspace.operations.AbstractOperation<PassageSimilarityResult>
      tml.vectorspace.operations.PassagesSimilarity

All Implemented Interfaces:

Operation<PassageSimilarityResult>

public class PassagesSimilarity
extends AbstractOperation<PassageSimilarityResult>

This operation calculates the similarity between all documents within a Corpus, it can calculate the similarities based on its own SemanticSpace, or use another Corpus to project all documents and the calculate similarities between all documents in both corpora.

Author:

Jorge Villalon

Constructor Summary

PassagesSimilarity()

Method Summary

Jama.Matrix	getSimilarities()
boolean	isSortBySimilarity()
void	setIncludeBackgroundInResults(boolean includeBackgroundInResults)
void	setIncludeBackgroundInSimilarity(boolean includeBackgroundInSimilarity)
void	setSortBySimilarity(boolean sortBySimilarity)
void	start() Starts the operation execution

Methods inherited from class tml.vectorspace.operations.AbstractOperation

addOperationListener, getBackgroundKnowledgeCorpus, getCorpus, getMaxResults, getName, getRepository, getResults, getResultsCSVString, getResultsNumber, getResultsString, getResultsStringTable, getResultsTable, getResultsTableHeader, getResultsXML, getTimeElapsed, printResults, printResultsCSV, printResultsMatlab, removeOperationListener, setBackgroundKnowledgeCorpus, setCorpus, setMaxResults, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PassagesSimilarity

public PassagesSimilarity()

Method Detail

isSortBySimilarity

public boolean isSortBySimilarity()

Returns:

the sortBySimilarity

setSortBySimilarity

public void setSortBySimilarity(boolean sortBySimilarity)

Parameters:

sortBySimilarity - the sortBySimilarity to set

getSimilarities

public Jama.Matrix getSimilarities()

Returns:

the similarities

setIncludeBackgroundInResults

public void setIncludeBackgroundInResults(boolean includeBackgroundInResults)

Parameters:

includeBackgroundInResults - the includeBackgroundInResults to set

setIncludeBackgroundInSimilarity

public void setIncludeBackgroundInSimilarity(boolean includeBackgroundInSimilarity)

Parameters:

includeBackgroundInSimilarity - the includeBackgroundInSimilarity to set

start

public void start()
           throws java.lang.Exception

Description copied from interface: Operation

Starts the operation execution

Specified by:

start in interface Operation<PassageSimilarityResult>

Overrides:

start in class AbstractOperation<PassageSimilarityResult>

Throws:

java.lang.Exception