info.textgrid.lab.collatex.model

Class CollationResults

java.lang.Object

info.textgrid.lab.collatex.model.CollationResults

public class CollationResults
extends Object

Contains all data relevant to a running or finished collation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CollationResults.ICollationResultsListener

Constructor Summary

Constructors

Constructor and Description
CollationResults()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(CollationResults.ICollationResultsListener listener)
CollationSet	getCollationSet()
EqualityTokenComparator	getComparator() Returns the Comparator that is used to compare tokens in this CollationSet.
Equivalences	getEquivalences()
CollationSetWitness	getFocusedCSWitness() In user interfaces representing the CollationSet, a witness can be focused.
BasicWitness	getFocusedWitness() Returns the Witness to be used as base text.
VariantGraph	getVariantGraph()
protected void	notifyFocusChanged()
void	removeListener(CollationResults.ICollationResultsListener listener)
void	setCollationSet(CollationSet collationSet)
void	setEquivalences(Equivalences equivalences)
void	setFocusedCSWitness(CollationSetWitness focusedCSWitness)
void	setVariantGraph(VariantGraph variantGraph)

Methods inherited from class java.lang.Object

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

Constructor Detail

CollationResults

public CollationResults()

Method Detail

addListener

public void addListener(CollationResults.ICollationResultsListener listener)

removeListener

public void removeListener(CollationResults.ICollationResultsListener listener)

notifyFocusChanged

protected void notifyFocusChanged()

getCollationSet

public CollationSet getCollationSet()

setCollationSet

public void setCollationSet(CollationSet collationSet)

getEquivalences

public Equivalences getEquivalences()

setEquivalences

public void setEquivalences(Equivalences equivalences)

getVariantGraph

public VariantGraph getVariantGraph()

Returns:

The variant graph that contains the actual results of the collation.

setVariantGraph

public void setVariantGraph(VariantGraph variantGraph)

getComparator

public EqualityTokenComparator getComparator()

Returns the Comparator that is used to compare tokens in this CollationSet.

getFocusedCSWitness

public CollationSetWitness getFocusedCSWitness()

In user interfaces representing the CollationSet, a witness can be focused. While CollateX actual collation is baseless, this focused witness should be considered the base text by visualisations of the collation result that assume or highlight a base text.

Clients can register a CollationResults.ICollationResultsListener to be notified when the witness changes. Clients can alternatively use getFocusedWitness() to retrieve the Witness from the variant graph corresponding to the focused witness.

getFocusedWitness

public BasicWitness getFocusedWitness()

Returns the Witness to be used as base text. See getFocusedCSWitness() for an explanation of the concept.

setFocusedCSWitness

public void setFocusedCSWitness(CollationSetWitness focusedCSWitness)