Package org.biojava.bio.search
Class FilteringContentHandler
java.lang.Object
org.biojava.bio.search.SearchContentAdapter
org.biojava.bio.search.FilteringContentHandler
- All Implemented Interfaces:
BlastLikeSearchFilter.Node
,SearchContentHandler
public class FilteringContentHandler
extends SearchContentAdapter
implements BlastLikeSearchFilter.Node
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclass
Visitor class that parses the filter tree -
Constructor Summary
ConstructorsConstructorDescriptionFilteringContentHandler
(BlastLikeSearchFilter filter, SearchContentHandler delegate) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addHitProperty
(Object key, Object value) TheaddHitProperty
method adds a key/value pair containing some property of a particular hit.void
addSearchProperty
(Object key, Object value) TheaddSearchProperty
method adds a key/value pair containing some property of the overall search result.void
addSubHitProperty
(Object key, Object value) TheaddSubHitProperty
method adds a key/value pair containing some property of a particular subhit.void
TheendHeader
method indicates the end of a formatted header.void
endHit()
TheendHit
method indicates the end of a formatted hit.void
TheendSearch
method indicates the end of useful search information.void
TheendSubHit
method indicates the end of a formatted subhit.getHitProperty
(Object key) getSearchProperty
(Object key) getSubHitProperty
(Object key) void
setDatabaseID
(String id) setDatabaseID
identifies the database searched by a name, ID or URN.void
setQueryID
(String queryID) setQueryID
identifies the query sequence by a name, ID or URN.void
setSearchContentHandler
(SearchContentHandler delegate) void
ThestartHeader
method indicates the start of a formatted header.void
startHit()
ThestartHit
method indicates the start of a formatted hit.void
ThestartSearch
method indicates the start of useful search information.void
ThestartSubHit
method indicates the start of a formatted subhit.Methods inherited from class org.biojava.bio.search.SearchContentAdapter
getMoreSearches, setMoreSearches
-
Constructor Details
-
FilteringContentHandler
public FilteringContentHandler(BlastLikeSearchFilter filter, SearchContentHandler delegate) throws BioException - Throws:
BioException
-
FilteringContentHandler
- Throws:
BioException
-
-
Method Details
-
getSearchProperty
- Specified by:
getSearchProperty
in interfaceBlastLikeSearchFilter.Node
-
getHitProperty
- Specified by:
getHitProperty
in interfaceBlastLikeSearchFilter.Node
-
getSubHitProperty
- Specified by:
getSubHitProperty
in interfaceBlastLikeSearchFilter.Node
-
setSearchContentHandler
-
startHeader
Description copied from interface:SearchContentHandler
ThestartHeader
method indicates the start of a formatted header. This usually contains information relevant to the search as a whole.- Specified by:
startHeader
in interfaceSearchContentHandler
- Overrides:
startHeader
in classSearchContentAdapter
-
setDatabaseID
Description copied from interface:SearchContentHandler
setDatabaseID
identifies the database searched by a name, ID or URN.- Specified by:
setDatabaseID
in interfaceSearchContentHandler
- Overrides:
setDatabaseID
in classSearchContentAdapter
- Parameters:
id
- aString
which should be an unique identifier for the database searched.
-
endHeader
Description copied from interface:SearchContentHandler
TheendHeader
method indicates the end of a formatted header.- Specified by:
endHeader
in interfaceSearchContentHandler
- Overrides:
endHeader
in classSearchContentAdapter
-
startSearch
Description copied from interface:SearchContentHandler
ThestartSearch
method indicates the start of useful search information.- Specified by:
startSearch
in interfaceSearchContentHandler
- Overrides:
startSearch
in classSearchContentAdapter
-
setQueryID
Description copied from interface:SearchContentHandler
setQueryID
identifies the query sequence by a name, ID or URN.- Specified by:
setQueryID
in interfaceSearchContentHandler
- Overrides:
setQueryID
in classSearchContentAdapter
- Parameters:
queryID
- aString
which should be an unique identifer for the sequence.
-
addSearchProperty
Description copied from interface:SearchContentHandler
TheaddSearchProperty
method adds a key/value pair containing some property of the overall search result.- Specified by:
addSearchProperty
in interfaceSearchContentHandler
- Overrides:
addSearchProperty
in classSearchContentAdapter
- Parameters:
key
- anObject
.value
- anObject
.
-
startHit
Description copied from interface:SearchContentHandler
ThestartHit
method indicates the start of a formatted hit. This could be a single line, or a block of lines.- Specified by:
startHit
in interfaceSearchContentHandler
- Overrides:
startHit
in classSearchContentAdapter
-
addHitProperty
Description copied from interface:SearchContentHandler
TheaddHitProperty
method adds a key/value pair containing some property of a particular hit.- Specified by:
addHitProperty
in interfaceSearchContentHandler
- Overrides:
addHitProperty
in classSearchContentAdapter
- Parameters:
key
- anObject
.value
- anObject
.
-
startSubHit
Description copied from interface:SearchContentHandler
ThestartSubHit
method indicates the start of a formatted subhit. There may be zero or more of these per hit.- Specified by:
startSubHit
in interfaceSearchContentHandler
- Overrides:
startSubHit
in classSearchContentAdapter
-
addSubHitProperty
Description copied from interface:SearchContentHandler
TheaddSubHitProperty
method adds a key/value pair containing some property of a particular subhit.- Specified by:
addSubHitProperty
in interfaceSearchContentHandler
- Overrides:
addSubHitProperty
in classSearchContentAdapter
- Parameters:
key
- anObject
.value
- anObject
.
-
endSubHit
Description copied from interface:SearchContentHandler
TheendSubHit
method indicates the end of a formatted subhit.- Specified by:
endSubHit
in interfaceSearchContentHandler
- Overrides:
endSubHit
in classSearchContentAdapter
-
endHit
Description copied from interface:SearchContentHandler
TheendHit
method indicates the end of a formatted hit.- Specified by:
endHit
in interfaceSearchContentHandler
- Overrides:
endHit
in classSearchContentAdapter
-
endSearch
Description copied from interface:SearchContentHandler
TheendSearch
method indicates the end of useful search information.- Specified by:
endSearch
in interfaceSearchContentHandler
- Overrides:
endSearch
in classSearchContentAdapter
-