com.dkfqs.tools.text

Class TextPhraseWizard

java.lang.Object

com.dkfqs.tools.text.TextPhraseWizard

public class TextPhraseWizard
extends java.lang.Object

A heuristic algorithm which extracts from a text content the most meaningful, static text phrase(s).

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashSet<java.lang.String>	EXCLUDE_TEXT_FRAGMENT_DEFAULT_SET The default set of text fragments which cannot be part of a text phrase.
static int	MAX_TEXT_ELEMENTS The default maximum number of potential text phrases.
static int	MAX_TEXT_LENGTH The default maximum length of a text phrase.
static int	MIN_TEXT_LENGTH The default minimum length of a text phrase.
static java.lang.String	PRINTABLE_DELIMITER_CHARS_DEFAULT The default printable delimiter chars.

Constructor Summary

Constructors

Constructor and Description
TextPhraseWizard(java.lang.String content) Create a new instance.

Method Summary

Modifier and Type	Method and Description
TextPhraseWizardElement[]	execute(int maxResultSize) Execute the wizard.
java.lang.String	getDelimiterChars() Get the delimiter chars (control characters and printable characters).
void	setExcludeTextFragments(java.util.ArrayList<java.lang.String> excludeTextFragmentsList) Set a list of text fragments which cannot be part of a text phrase.
void	setMaxTextElements(int maxTextElements) Set the maximum number of potential text phrases.
void	setMaxTextLength(int maxTextLength) Set the maximum length of a text phrase.
void	setMinTextLength(int minTextLength) Set the minimum length of a text phrase.
void	setPrintableDelimiterChars(java.lang.String delimiterChars) Set the printable delimiter chars.

Methods inherited from class java.lang.Object

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

Field Detail

EXCLUDE_TEXT_FRAGMENT_DEFAULT_SET

public static final java.util.HashSet<java.lang.String> EXCLUDE_TEXT_FRAGMENT_DEFAULT_SET

The default set of text fragments which cannot be part of a text phrase.

PRINTABLE_DELIMITER_CHARS_DEFAULT

public static final java.lang.String PRINTABLE_DELIMITER_CHARS_DEFAULT

The default printable delimiter chars.

See Also:

Constant Field Values

MIN_TEXT_LENGTH

public static final int MIN_TEXT_LENGTH

The default minimum length of a text phrase.

See Also:

Constant Field Values

MAX_TEXT_LENGTH

public static final int MAX_TEXT_LENGTH

The default maximum length of a text phrase.

See Also:

Constant Field Values

MAX_TEXT_ELEMENTS

public static final int MAX_TEXT_ELEMENTS

The default maximum number of potential text phrases.

See Also:

Constant Field Values

Constructor Detail

TextPhraseWizard

public TextPhraseWizard(java.lang.String content)

Create a new instance.

Parameters:

content - the content to process

Method Detail

getDelimiterChars

public java.lang.String getDelimiterChars()

Get the delimiter chars (control characters and printable characters).

Returns:

the delimiter chars

setPrintableDelimiterChars

public void setPrintableDelimiterChars(java.lang.String delimiterChars)

Set the printable delimiter chars.

Parameters:

delimiterChars - the printable delimiter chars

See Also:

PRINTABLE_DELIMITER_CHARS_DEFAULT

setExcludeTextFragments

public void setExcludeTextFragments(java.util.ArrayList<java.lang.String> excludeTextFragmentsList)

Set a list of text fragments which cannot be part of a text phrase.

Parameters:

excludeTextFragmentsList - the list of text fragments which cannot be part of a text phrase

See Also:

EXCLUDE_TEXT_FRAGMENT_DEFAULT_SET

setMinTextLength

public void setMinTextLength(int minTextLength)

Set the minimum length of a text phrase.

Parameters:

minTextLength - the minimum length of a text phrase

See Also:

MIN_TEXT_LENGTH

setMaxTextLength

public void setMaxTextLength(int maxTextLength)

Set the maximum length of a text phrase.

Parameters:

maxTextLength - the maximum length of a text phrase

See Also:

MAX_TEXT_LENGTH

setMaxTextElements

public void setMaxTextElements(int maxTextElements)

Set the maximum number of potential text phrases.

Parameters:

maxTextElements - the maximum number of potential text phrases

execute

public TextPhraseWizardElement[] execute(int maxResultSize)

Execute the wizard.

Parameters:

maxResultSize - the maximum number of returned text phrase elements, or -1 = unlimited = only limited by 'the maximum number of potential text phrases'

Returns:

the computed array of the text phrase elements, sorted by 1) ranking and 2) token position (= position within the content)