com.jidesoft.search
Class FindResults

java.lang.Object
  com.jidesoft.search.FindResults

public class FindResults
extends Object

FindResult represents one occurrence of the find result. FindResults represents all the FindResults in one piece of the text.

Constructor Summary

FindResults(String name, FindResultIntepreter intepreter)

Method Summary

void	addFindResult(FindResult findResult) Adds a FindResult.
void	addFindResults(FindResults findResults) Adds a FindResults.
Object	getElementAt(int index) Gets the element at the index.
int	getElementCount() Gets the element count.
FindResult	getFirstFindResult(FindResultIntepreter interpreter) Gets the first match result for the interpreter.
FindResultIntepreter	getIntepreter() Gets the interpreter.
String	getName() Gets the name of the find results.
int	getNumberOfFindResults() Gets the number of FindResult.

Methods inherited from class java.lang.Object

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

Constructor Detail

FindResults

public FindResults(String name,
                   FindResultIntepreter intepreter)

Method Detail

getName

public String getName()

Gets the name of the find results.

Returns:

the name of the find results.

addFindResult

public void addFindResult(FindResult findResult)

Adds a FindResult.

Parameters:

findResult -

addFindResults

public void addFindResults(FindResults findResults)

Adds a FindResults. Please note, it doesn't take each FindResult of the FindResults and add them separately. It will simply add a FindResults as a whole thing. By allowing adding FindResults to FindResults, you can easily form a tree of FindResults.

Parameters:

findResults -

getElementAt

public Object getElementAt(int index)

Gets the element at the index.

Parameters:

index -

Returns:

the element at the index.

getElementCount

public int getElementCount()

Gets the element count.

Returns:

the element count.

getNumberOfFindResults

public int getNumberOfFindResults()

Gets the number of FindResult. It will recursively iterate into each FindResults and find all FindResult(s).

Returns:

the number of all FindResult(s).

getFirstFindResult

public FindResult getFirstFindResult(FindResultIntepreter interpreter)

Gets the first match result for the interpreter.

Parameters:

interpreter - the target interpreter

Returns:

the first match result. null if there is no match.

Since:

3.3.1

getIntepreter

public FindResultIntepreter getIntepreter()

Gets the interpreter.

Returns:

the interpreter.