ca.odell.glazedlists.filter

Interface TextSearchStrategy

public interface TextSearchStrategy

This interface defines a Strategy for locating a particular subtext within another (typically larger) text. Implementations may make assumptions about the texts in order to gain performance benefits. Users of this interface must call setSubtext(String) before indexOf(String) or indexOf will throw an IllegalStateException.

Author:

James Lemieux

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TextSearchStrategy.Factory The factory for building implementations of TextSearchStrategy which is used as an identifier for the strategy itself.

Method Summary

Modifier and Type	Method and Description
int	indexOf(java.lang.String text) Returns the index of the first occurrence of subtext within text; or -1 if subtext does not occur within text.
void	setCharacterMap(char[] charMap) Sets the strategy, if any, to map the characters being compared during a text search.
void	setSubtext(java.lang.String subtext) Sets the subtext to locate when indexOf(String) is called.

Method Detail

setCharacterMap

void setCharacterMap(char[] charMap)

Sets the strategy, if any, to map the characters being compared during a text search. A null normalizer indicates the raw characters should be used during the text search.

Parameters:

charMap - the strategy to use when normalizing characters immediately before comparing them for equality

setSubtext

void setSubtext(java.lang.String subtext)

Sets the subtext to locate when indexOf(String) is called. Implementations should build any special data structures they may need concerning the subtext in this method.

Parameters:

subtext - the String to locate in indexOf(String)

indexOf

int indexOf(java.lang.String text)

Returns the index of the first occurrence of subtext within text; or -1 if subtext does not occur within text. Implementations must throw an IllegalStateException if setSubtext(String) has not yet been called.

Parameters:

text - String in which to locate subtext

Returns:

the index of the first occurrence of subtext within text; or -1

Throws:

java.lang.IllegalStateException - if no subtext has been set