de.espirit.firstspirit.agency

Interface HighlightAgent

public interface HighlightAgent

Definition of an agent offering highlighting capabilities.

Since:

5.1.31

Field Summary

Fields

Modifier and Type	Field and Description
static SpecialistType<HighlightAgent>	TYPE Technical type of an agent specialized in highlighting.

Method Summary

Methods

Modifier and Type	Method and Description
void	highlightExactMatch(String text) Request to highlight the specified String.
void	highlightPattern(String pattern) Request to highlight text fragments that matches the specified regular expression.
void	highlightWords(String words) Request to highlight the words contained in the specified String.
void	reset() Request to remove the current highlighting.

Field Detail

TYPE

static final SpecialistType<HighlightAgent> TYPE

Technical type of an agent specialized in highlighting.

Since:

5.1.31

Method Detail

highlightWords

void highlightWords(String words)

Request to highlight the words contained in the specified String. The specified String should contain a whitespace-separated list of words. Words may contain the character * which matches any sequence of characters, and ? which matches any single character (not including whitespace).

Parameters:

words - a whitespace-separated list of words to highlight

Since:

5.1.31

highlightExactMatch

void highlightExactMatch(String text)

Request to highlight the specified String. Metacharacters or escape sequences in the input sequence will be given no special meaning.

Parameters:

text - the String to highlight

Since:

5.1.31

highlightPattern

void highlightPattern(String pattern)

Request to highlight text fragments that matches the specified regular expression.

Parameters:

pattern - the regular expression to use for highlighting

Throws:

IllegalArgumentException - if the expression's syntax is invalid

Since:

5.1.31

reset

void reset()

Request to remove the current highlighting.

Since:

5.1.31