org.jdesktop.swingx.search
Class AbstractSearchable

java.lang.Object
  org.jdesktop.swingx.search.AbstractSearchable

All Implemented Interfaces:

Searchable

Direct Known Subclasses:

ListSearchable, TableSearchable, TreeSearchable

public abstract class AbstractSearchable
extends Object
implements Searchable

An abstract implementation of Searchable supporting incremental search. Keeps internal state to represent the previous search result. For all methods taking a String as parameter: compiles the String to a Pattern as-is and routes to the central method taking a Pattern.

Nested Class Summary

static class

AbstractSearchable.SearchResult A convenience class to hold search state.

Field Summary

protected AbstractSearchable.SearchResult	lastSearchResult stores the result of the previous search.
static String	MATCH_HIGHLIGHTER key for client property to use SearchHighlighter as match marker.

Constructor Summary

AbstractSearchable()

Method Summary

protected abstract void	addHighlighter(Highlighter highlighter) Adds the highlighter to the target.
protected int	adjustStartPosition(int startIndex, boolean backwards) Called if startIndex is different from last search and make sure a backwards/forwards search starts at last/first row, respectively.
protected int	convertColumnIndexToModel(int viewColumn) Converts and returns the given column index from view coordinates to model coordinates.
protected AbstractHighlighter	createMatchHighlighter() Creates and returns the Highlighter used as match marker.
protected HighlightPredicate	createMatchPredicate() Creates and returns a HighlightPredicate appropriate for the current search result.
protected AbstractSearchable.SearchResult	createSearchResult(Matcher matcher, int row, int column) Factory method to create a SearchResult from the given parameters.
protected int	doSearch(Pattern pattern, int startIndex, boolean backwards) Performs a search starting at the given startIndex using the pattern; Pattern.
protected void	ensureInsertedSearchHighlighters(Highlighter highlighter) Ensure that the given Highlighter is the last in the list of the highlighters registered on the target.
protected abstract AbstractSearchable.SearchResult	findExtendedMatch(Pattern pattern, int row) Matches the cell at row/lastFoundColumn against the pattern.
protected abstract void	findMatchAndUpdateState(Pattern pattern, int startRow, boolean backwards) Loops through the searchable until a match is found or the end is reached.
protected AbstractHighlighter	getConfiguredMatchHighlighter() Configures and returns the match highlighter for the current match.
protected abstract Highlighter[]	getHighlighters() Returns the highlighters registered on the search target.
protected AbstractHighlighter	getMatchHighlighter() Returns the Hihglighter to use as match marker, lazyly created if null.
protected abstract int	getSize() Returns the size of this searchable.
abstract JComponent	getTarget() It's the responsibility of subclasses to covariant override.
protected boolean	hasMatch() Returns a boolean indicating whether the current search result is a match.
protected boolean	isEmpty(String searchString) Checks if the searchString should be interpreted as empty.
protected boolean	isEqualPattern(Pattern pattern) Checks if the given Pattern should be considered as the same as in a previous search.
protected boolean	isEqualStartIndex(int startIndex) Checks if the startIndex should be considered as the same as in the previous search.
protected boolean	isTrivialNoMatch(Pattern pattern, int startIndex) Returns a boolean indicating if it can be trivially decided to not match.
protected boolean	isValidIndex(int index) Checks if index is in range: 0 <= index < getSize().
protected boolean	markByHighlighter() Returns a boolean indicating whether a match should be marked with a Highlighter.
protected abstract void	moveMatchMarker() Moves the match marker according to current found state.
protected int	moveStartPosition(int startIndex, boolean backwards) Moves the internal start position for matching as appropriate and returns the new startIndex to use.
protected abstract void	removeHighlighter(Highlighter searchHighlighter) Removes the highlighter.
int	search(Pattern pattern) Performs a forward search starting at the beginning across the Searchable using the pattern; Pattern.
int	search(Pattern pattern, int startIndex) Performs a forward search starting at the given startIndex using the Pattern; Pattern.
int	search(Pattern pattern, int startIndex, boolean backwards) Performs a search starting at the given startIndex using the pattern; Pattern.
int	search(String searchString) Performs a forward search starting at the beginning across the Searchable using String that represents a regex pattern; Pattern.
int	search(String searchString, int startIndex) Performs a forward search starting at the given startIndex using String that represents a regex pattern; Pattern.
int	search(String searchString, int startIndex, boolean backward) Performs a search starting at the given startIndex using String that represents a regex pattern; Pattern.
void	setMatchHighlighter(AbstractHighlighter hl) Sets the AbstractHighlighter to use as match marker, if enabled.
protected void	updateState(AbstractSearchable.SearchResult searchResult) Updates inner searchable state based on provided search result

Methods inherited from class java.lang.Object

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

Field Detail

lastSearchResult

protected final AbstractSearchable.SearchResult lastSearchResult

stores the result of the previous search.

MATCH_HIGHLIGHTER

public static final String MATCH_HIGHLIGHTER

key for client property to use SearchHighlighter as match marker.

See Also:

Constant Field Values

Constructor Detail

AbstractSearchable

public AbstractSearchable()

Method Detail

search

public int search(String searchString)

Performs a forward search starting at the beginning across the Searchable using String that represents a regex pattern; Pattern.

Specified by:

search in interface Searchable

Parameters:

searchString - String that we will try to locate

Returns:

the position of the match in appropriate coordinates or -1 if no match found.

search

public int search(String searchString,
                  int startIndex)

Performs a forward search starting at the given startIndex using String that represents a regex pattern; Pattern.

Specified by:

search in interface Searchable

Parameters:

searchString - String that we will try to locate

startIndex - position in the document in the appropriate coordinates from which we will start search or -1 to start from the beginning

Returns:

the position of the match in appropriate coordinates or -1 if no match found.

search

public int search(String searchString,
                  int startIndex,
                  boolean backward)

Performs a search starting at the given startIndex using String that represents a regex pattern; Pattern. The search direction depends on the boolean parameter: forward/backward if false/true, respectively.

Specified by:

search in interface Searchable

Parameters:

searchString - String that we will try to locate

startIndex - position in the document in the appropriate coordinates from which we will start search or -1 to start from the beginning

backward - true if we should perform search towards the beginning

Returns:

the position of the match in appropriate coordinates or -1 if no match found.

search

public int search(Pattern pattern)

Performs a forward search starting at the beginning across the Searchable using the pattern; Pattern.

Specified by:

search in interface Searchable

Parameters:

pattern - Pattern that we will try to locate

Returns:

the position of the match in appropriate coordinates or -1 if no match found.

search

public int search(Pattern pattern,
                  int startIndex)

Performs a forward search starting at the given startIndex using the Pattern; Pattern.

Specified by:

search in interface Searchable

Parameters:

pattern - Pattern that we will try to locate

startIndex - position in the document in the appropriate coordinates from which we will start search or -1 to start from the beginning

Returns:

the position of the match in appropriate coordinates or -1 if no match found.

search

public int search(Pattern pattern,
                  int startIndex,
                  boolean backwards)

Performs a search starting at the given startIndex using the pattern; Pattern. The search direction depends on the boolean parameter: forward/backward if false/true, respectively.

Updates visible and internal search state.

Specified by:

search in interface Searchable

Parameters:

pattern - Pattern that we will try to locate

startIndex - position in the document in the appropriate coordinates from which we will start search or -1 to start from the beginning

backwards - true if we should perform search towards the beginning

Returns:

the position of the match in appropriate coordinates or -1 if no match found.

doSearch

protected int doSearch(Pattern pattern,
                       int startIndex,
                       boolean backwards)

Performs a search starting at the given startIndex using the pattern; Pattern. The search direction depends on the boolean parameter: forward/backward if false/true, respectively.

Updates internal search state.

Parameters:

pattern - Pattern that we will try to locate

startIndex - position in the document in the appropriate coordinates from which we will start search or -1 to start from the beginning

backwards - true if we should perform search towards the beginning

Returns:

the position of the match in appropriate coordinates or -1 if no match found.

findMatchAndUpdateState

protected abstract void findMatchAndUpdateState(Pattern pattern,
                                                int startRow,
                                                boolean backwards)

Loops through the searchable until a match is found or the end is reached. Updates internal search state.

Parameters:

pattern - Pattern that we will try to locate

startRow - position in the document in the appropriate coordinates from which we will start search or -1 to start from the beginning

backwards - true if we should perform search towards the beginning

isTrivialNoMatch

protected boolean isTrivialNoMatch(Pattern pattern,
                                   int startIndex)

Returns a boolean indicating if it can be trivially decided to not match.

This implementation returns true if pattern is null or startIndex exceeds the upper size limit.

Parameters:

pattern - Pattern that we will try to locate

startIndex - position in the document in the appropriate coordinates from which we will start search or -1 to start from the beginning

Returns:

true if we can say ahead that no match will be found with given search criteria

adjustStartPosition

protected int adjustStartPosition(int startIndex,
                                  boolean backwards)

Called if startIndex is different from last search and make sure a backwards/forwards search starts at last/first row, respectively.

Parameters:

startIndex - position in the document in the appropriate coordinates from which we will start search or -1 to start from the beginning

backwards - true if we should perform search from towards the beginning

Returns:

adjusted startIndex

moveStartPosition

protected int moveStartPosition(int startIndex,
                                boolean backwards)

Moves the internal start position for matching as appropriate and returns the new startIndex to use. Called if search was messaged with the same startIndex as previously.

This implementation returns a by 1 decremented/incremented startIndex depending on backwards true/false, respectively.

Parameters:

startIndex - position in the document in the appropriate coordinates from which we will start search or -1 to start from the beginning

backwards - true if we should perform search towards the beginning

Returns:

adjusted startIndex

isEqualPattern

protected boolean isEqualPattern(Pattern pattern)

Checks if the given Pattern should be considered as the same as in a previous search.

This implementation compares the patterns' regex.

Parameters:

pattern - Pattern that we will compare with last request

Returns:

if provided Pattern is the same as the stored from the previous search attempt

isEqualStartIndex

protected boolean isEqualStartIndex(int startIndex)

Checks if the startIndex should be considered as the same as in the previous search.

Parameters:

startIndex - startIndex that we will compare with the index stored by the previous search request

Returns:

true if the startIndex should be re-matched, false if not.

isEmpty

protected boolean isEmpty(String searchString)

Checks if the searchString should be interpreted as empty.

This implementation returns true if string is null or has zero length.

Parameters:

searchString - String that we should evaluate

Returns:

true if the provided String should be interpreted as empty

findExtendedMatch

protected abstract AbstractSearchable.SearchResult findExtendedMatch(Pattern pattern,
                                                                     int row)

Matches the cell at row/lastFoundColumn against the pattern. Called if sameRowIndex && !hasEqualRegEx. PRE: lastFoundColumn valid.

Parameters:

pattern - Pattern that we will try to match

row - position at which we will get the value to match with the provided Pattern

Returns:

result of the match; AbstractSearchable.SearchResult

createSearchResult

protected AbstractSearchable.SearchResult createSearchResult(Matcher matcher,
                                                             int row,
                                                             int column)

Factory method to create a SearchResult from the given parameters.

Parameters:

matcher - the matcher after a successful find. Must not be null.

row - the found index

column - the found column

Returns:

newly created SearchResult

isValidIndex

protected boolean isValidIndex(int index)

Checks if index is in range: 0 <= index < getSize().

Parameters:

index - possible start position that we will check for validity

Returns:

true if given parameter is valid index

getSize

protected abstract int getSize()

Returns the size of this searchable.

Returns:

size of this searchable

updateState

protected void updateState(AbstractSearchable.SearchResult searchResult)

Updates inner searchable state based on provided search result

Parameters:

searchResult - SearchResult that represents the new state of this AbstractSearchable

moveMatchMarker

protected abstract void moveMatchMarker()

Moves the match marker according to current found state.

getTarget

public abstract JComponent getTarget()

It's the responsibility of subclasses to covariant override.

Returns:

the target component

removeHighlighter

protected abstract void removeHighlighter(Highlighter searchHighlighter)

Removes the highlighter.

Parameters:

searchHighlighter - the Highlighter to remove.

getHighlighters

protected abstract Highlighter[] getHighlighters()

Returns the highlighters registered on the search target.

Returns:

all registered highlighters

addHighlighter

protected abstract void addHighlighter(Highlighter highlighter)

Adds the highlighter to the target.

Parameters:

highlighter - the Highlighter to add.

ensureInsertedSearchHighlighters

protected void ensureInsertedSearchHighlighters(Highlighter highlighter)

Ensure that the given Highlighter is the last in the list of the highlighters registered on the target.

Parameters:

highlighter - the Highlighter to be inserted as last.

convertColumnIndexToModel

protected int convertColumnIndexToModel(int viewColumn)

Converts and returns the given column index from view coordinates to model coordinates.

This implementation returns the view coordinate, that is assumes that both coordinate systems are the same.

Parameters:

viewColumn - the column index in view coordinates, must be a valid index in that system.

Returns:

the column index in model coordinates.

hasMatch

protected boolean hasMatch()

Returns a boolean indicating whether the current search result is a match.

PENDING JW: move to SearchResult?

Returns:

a boolean indicating whether the current search result is a match.

markByHighlighter

protected boolean markByHighlighter()

Returns a boolean indicating whether a match should be marked with a Highlighter.

This implementation returns true if the target component has a client property for key MATCH_HIGHLIGHTER with value Boolean.TRUE, false otherwise.

Returns:

a boolean indicating whether a match should be marked by a using a Highlighter.

setMatchHighlighter

public void setMatchHighlighter(AbstractHighlighter hl)

Sets the AbstractHighlighter to use as match marker, if enabled. A null value will re-install the default.

Parameters:

hl - the Highlighter to use as match marker.

getMatchHighlighter

protected AbstractHighlighter getMatchHighlighter()

Returns the Hihglighter to use as match marker, lazyly created if null.

Returns:

a highlighter used for matching, guaranteed to be not null.

createMatchHighlighter

protected AbstractHighlighter createMatchHighlighter()

Creates and returns the Highlighter used as match marker.

Returns:

a highlighter used for matching

getConfiguredMatchHighlighter

protected AbstractHighlighter getConfiguredMatchHighlighter()

Configures and returns the match highlighter for the current match.

Returns:

a highlighter configured for matching

createMatchPredicate

protected HighlightPredicate createMatchPredicate()

Creates and returns a HighlightPredicate appropriate for the current search result.

Returns:

a HighlightPredicate appropriate for the current search result.