|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
SearchContentHandler
is a notification interface for
objects which listen to search stream parsers. This is applicable
to all types of search results which are represented by flat files
created by external programs e.g. Fasta, (T)BlastN/PX, EMBOSS
programs. This is not limited to sequence similarity searches, but
includes any format consisting of a header followed by hits, each
of which may, or may not, have subhits.
Method Summary | |
void |
addHitProperty(java.lang.Object key,
java.lang.Object value)
The addHitProperty method adds a key/value pair
containing some property of a particular hit. |
void |
addSearchProperty(java.lang.Object key,
java.lang.Object value)
The addSearchProperty method adds a key/value pair
containing some property of the overall search result. |
void |
addSubHitProperty(java.lang.Object key,
java.lang.Object value)
The addSubHitProperty method adds a key/value pair
containing some property of a particular subhit. |
void |
endHeader()
The endHeader method indicates the end of a
formatted header. |
void |
endHit()
The endHit method indicates the end of a formatted
hit. |
void |
endSearch()
The endSearch method indicates the end of useful
search information. |
void |
endSubHit()
The endSubHit method indicates the end of a
formatted subhit. |
boolean |
getMoreSearches()
getMoreSearches returns the state of the
SearchContentHandler with respect to further
searches from its data source. |
void |
setDatabaseID(java.lang.String databaseID)
setDatabaseID identifies the database searched by
a name, ID or URN. |
void |
setMoreSearches(boolean value)
setMoreSearches sets the state of the
SearchContentHandler 's expectation of receiving
more results. |
void |
setQueryID(java.lang.String queryID)
setQueryID identifies the query sequence by a
name, ID or URN. |
void |
startHeader()
The startHeader method indicates the start of a
formatted header. |
void |
startHit()
The startHit method indicates the start of a
formatted hit. |
void |
startSearch()
The startSearch method indicates the start of
useful search information. |
void |
startSubHit()
The startSubHit method indicates the start of a
formatted subhit. |
Method Detail |
public boolean getMoreSearches()
getMoreSearches
returns the state of the
SearchContentHandler
with respect to further
searches from its data source. Used for handling streams of
search results.
boolean
value.public void setMoreSearches(boolean value)
setMoreSearches
sets the state of the
SearchContentHandler
's expectation of receiving
more results. Used for handling streams of search results.
value
- a boolean
value.public void startSearch()
startSearch
method indicates the start of
useful search information.
public void endSearch()
endSearch
method indicates the end of useful
search information.
public void startHeader()
startHeader
method indicates the start of a
formatted header. This usually contains information relevant to
the search as a whole.
public void endHeader()
endHeader
method indicates the end of a
formatted header.
public void startHit()
startHit
method indicates the start of a
formatted hit. This could be a single line, or a block of
lines.
public void endHit()
endHit
method indicates the end of a formatted
hit.
public void startSubHit()
startSubHit
method indicates the start of a
formatted subhit. There may be zero or more of these per hit.
public void endSubHit()
endSubHit
method indicates the end of a
formatted subhit.
public void addSearchProperty(java.lang.Object key, java.lang.Object value)
addSearchProperty
method adds a key/value pair
containing some property of the overall search result.
key
- an Object
.value
- an Object
.public void addHitProperty(java.lang.Object key, java.lang.Object value)
addHitProperty
method adds a key/value pair
containing some property of a particular hit.
key
- an Object
.value
- an Object
.public void addSubHitProperty(java.lang.Object key, java.lang.Object value)
addSubHitProperty
method adds a key/value pair
containing some property of a particular subhit.
key
- an Object
.value
- an Object
.public void setQueryID(java.lang.String queryID)
setQueryID
identifies the query sequence by a
name, ID or URN.
queryID
- a String
which should be an unique
identifer for the sequence.public void setDatabaseID(java.lang.String databaseID)
setDatabaseID
identifies the database searched by
a name, ID or URN.
databaseID
- a String
which should be an unique
identifier for the database searched.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |