public interface SearchListener
The callbacks will always be called in the order startSearch, hit, endSearch, during which time there may be multiple hit calls. The seqID of startSearch and endSearch will match. After this, a new startSearch may begin. These events will usually originate from the search method of DataStore.
Modifier and Type | Interface and Description |
---|---|
static class |
SearchListener.Echo
A SearchListener that prints events out to a PrintStream.
|
static class |
SearchListener.FilterByLength
A simple listener that filters out all hits that are too short.
|
static class |
SearchListener.Tee
A SearchListener that passes events on to two delegate listeners.
|
static class |
SearchListener.Wrapper
A simple wrapper implementation.
|
Modifier and Type | Method and Description |
---|---|
void |
endSearch(String seqID)
Indicates that a sequence has been searched against a DataStore.
|
void |
hit(int hitID,
int queryOffset,
int hitOffset,
int hitLength)
There has been a hit between the query sequence and a database
sequence.
|
void |
startSearch(String seqID)
Indicates that a sequence is about to be searched against a DataStore.
|
void startSearch(String seqID)
seqID
- the id of the sequence to be searchedvoid endSearch(String seqID)
seqID
- the id of the sequence to be searchedvoid hit(int hitID, int queryOffset, int hitOffset, int hitLength)
hitID
- the number of the sequence hit; resolvable by
String id = DataStore.seqNameForID(hitID)queryOffset
- the offset into the query sequencehitOffset
- the offset into the sequence hit in the databasehitLength
- the number of symbols hitCopyright © 2014 BioJava. All rights reserved.