com.dkfqs.tools.text

Class TextPhraseWizardElement

java.lang.Object

com.dkfqs.tools.text.TextPhraseWizardElement

All Implemented Interfaces:

java.lang.Comparable<TextPhraseWizardElement>

public class TextPhraseWizardElement
extends java.lang.Object
implements java.lang.Comparable<TextPhraseWizardElement>

A single text phrase computed by the 'text phrase wizard'.

See Also:

TextPhraseWizard

Method Summary

Modifier and Type	Method and Description
int	compareTo(TextPhraseWizardElement otherInstance) Compare this instance with another instance - used to sort the instances by 1) ranking and 2) token position
void	dumpToStdout() Dump the data of this instance to stdout.
float	getRanking() Get the ranking of the text phrase.
java.lang.String	getTextPhrase() Get the text phrase.

Methods inherited from class java.lang.Object

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

Method Detail

compareTo

public int compareTo(TextPhraseWizardElement otherInstance)

Compare this instance with another instance - used to sort the instances by 1) ranking and 2) token position

Specified by:

compareTo in interface java.lang.Comparable<TextPhraseWizardElement>

Parameters:

otherInstance - the other instance

Returns:

0 (equal), or a value less than 0 or a value greater than 0

getTextPhrase

public java.lang.String getTextPhrase()

Get the text phrase.

Returns:

the text phrase

getRanking

public float getRanking()

Get the ranking of the text phrase.

Returns:

the ranking of the text phrase (range: 0.0 .. 1.0)

dumpToStdout

public void dumpToStdout()

Dump the data of this instance to stdout.