net.ontopia.topicmaps.classify
Class Term

java.lang.Object
  net.ontopia.topicmaps.classify.Term

public class Term
extends java.lang.Object

PUBLIC: Represents a concept which occurs in the classified content. A term can have many variants, all of which can be found from this object. It also has a score, indicating the importance of the term within the content.

Field Summary

protected double	score
protected static java.util.Comparator	SCORE_COMPARATOR
protected java.lang.String	stem
protected int	totalOccurrences
protected gnu.trove.TObjectIntHashMap<Variant>	variants

Method Summary

protected void	addScore(double ascore, java.lang.String reason)
protected void	addVariant(Variant variant)
protected void	addVariant(Variant variant, int occurrences)
protected void	divideScore(double factor, java.lang.String reason)
int	getOccurrences() PUBLIC: Returns the number of times the term occurred within the classified content.
protected int	getOccurrences(Variant variant)
java.lang.String	getPreferredName() PUBLIC: Returns the preferred variant of the term.
double	getScore() PUBLIC: Returns the term's score, a number in the range 0-1, indicating its importance within the content.
protected double	getScore(Variant v)
java.lang.String	getStem() PUBLIC: Returns the stem common to all variants of the term.
Variant[]	getVariants() PUBLIC: Returns all variant spellings of this term within the content.
Variant[]	getVariantsByRank() PUBLIC: Returns all variant spellings of this term within the content, with the most important first.
protected void	merge(Term other)
protected void	multiplyScore(double factor, java.lang.String reason)
protected void	setScore(double score, java.lang.String reason)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

stem

protected java.lang.String stem

score

protected double score

totalOccurrences

protected int totalOccurrences

variants

protected gnu.trove.TObjectIntHashMap<Variant> variants

SCORE_COMPARATOR

protected static java.util.Comparator SCORE_COMPARATOR

Method Detail

getStem

public java.lang.String getStem()

PUBLIC: Returns the stem common to all variants of the term. Often, the stem does not actually occur in the content.

getScore

public double getScore()

PUBLIC: Returns the term's score, a number in the range 0-1, indicating its importance within the content.

getVariants

public Variant[] getVariants()

PUBLIC: Returns all variant spellings of this term within the content.

getVariantsByRank

public Variant[] getVariantsByRank()

PUBLIC: Returns all variant spellings of this term within the content, with the most important first.

getOccurrences

public int getOccurrences()

PUBLIC: Returns the number of times the term occurred within the classified content.

getPreferredName

public java.lang.String getPreferredName()

PUBLIC: Returns the preferred variant of the term. This is a form of the term which actually occurred in the classified content.

getScore

protected double getScore(Variant v)

getOccurrences

protected int getOccurrences(Variant variant)

setScore

protected void setScore(double score,
                        java.lang.String reason)

addScore

protected void addScore(double ascore,
                        java.lang.String reason)

multiplyScore

protected void multiplyScore(double factor,
                             java.lang.String reason)

divideScore

protected void divideScore(double factor,
                           java.lang.String reason)

addVariant

protected void addVariant(Variant variant)

addVariant

protected void addVariant(Variant variant,
                          int occurrences)

merge

protected void merge(Term other)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object