Package org.biojava.bio.search
Interface SeqSimilaritySearchResult
- All Superinterfaces:
Annotatable
,Changeable
- All Known Implementing Classes:
SequenceDBSearchResult
,SimpleSeqSimilaritySearchResult
Objects of this type represent one particular result of a sequence
similarity search.
- Author:
- Gerald Loeffler, Keith James
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.biojava.bio.Annotatable
Annotatable.AnnotationForwarder
-
Field Summary
Fields inherited from interface org.biojava.bio.Annotatable
ANNOTATION
-
Method Summary
Modifier and TypeMethodDescriptiongetHits()
Return all hits in this sequence similarity search result.Returns the query sequence which was used to perform the search.Returns the search parameters used in the search that produced this search result.Returns the sequence database against which the search was performed.Methods inherited from interface org.biojava.bio.Annotatable
getAnnotation
Methods inherited from interface org.biojava.utils.Changeable
addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener
-
Method Details
-
getQuerySequence
Returns the query sequence which was used to perform the search.- Returns:
- the
Sequence
object used to search theSequenceDB
. Never returns null.
-
getSequenceDB
Returns the sequence database against which the search was performed.- Returns:
- the
SequenceDB object
against which the search was carried out. Never returns null.
-
getSearchParameters
Returns the search parameters used in the search that produced this search result.- Returns:
- the (immutable) search parameter
Map object
. May return null.
-
getHits
Return all hits in this sequence similarity search result. The hits are sorted from best to worst.- Returns:
- an (immutable)
List
ofSeqSimilaritySearchHit
objects containing all hits in the search result. Never returns null but may return an empty list.
-