com.levigo.jadice.search
Interface Result

All Superinterfaces:

Selection

public interface Result
extends Selection

A Result is created by the SearchEngine, if it has found something. A Result is a Selection with an additional handback.

Method Summary

Object

getHandback() Returns the handback object associated with this Result object.

Methods inherited from interface com.levigo.jadice.document.Selection

getBounds, getPage, getSelectedText, getShape, isValid

Method Detail

getHandback

Object getHandback()

Returns the handback object associated with this Result object. The handback object is any kind of object which has been passed to the MatchConsumer.match(int, int, Object) method for later use. The value is completely unprocessed. The PatternSearchRequest for example will provide the matching pattern as the handback object. See PatternSearchRequest for details.

Returns:

the handback object