Result

java.lang.Object
- org.biojava.nbio.core.search.io.Result

All Implemented Interfaces:

java.lang.Iterable<Hit>

Direct Known Subclasses:

BlastResult
```
public abstract class Result
extends java.lang.Object
implements java.lang.Iterable<Hit>
```
This class models a search result. You will find one of this for every query sequence specified in the run. Designed by Paolo Pavan. You may want to find my contacts on Github and LinkedIn for code info or discuss major changes. https://github.com/paolopavan

Author:

Paolo Pavan

Constructor Summary

Constructors
Constructor and Description
`Result(java.lang.String program, java.lang.String version, java.lang.String reference, java.lang.String dbFile, java.util.HashMap<java.lang.String,java.lang.String> programSpecificParameters, int iterationNumber, java.lang.String queryID, java.lang.String queryDef, int queryLength, java.util.List<Hit> hits, Sequence querySequence)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Experimental.
`java.lang.String`	`getDbFile()`
`int`	`getHitCounter()`
`int`	`getIterationNumber()`
`java.lang.String`	`getProgram()`
`java.lang.String`	`getProgramSpecificParameter(java.lang.String key)`
`java.util.Set<java.lang.String>`	`getProgramSpecificParametersList()`
`java.lang.String`	`getQueryDef()`
`java.lang.String`	`getQueryID()`
`int`	`getQueryLength()`
`Sequence`	`getQuerySequence()` returns the reference to the original and whole sequence used to query the database.
`java.lang.String`	`getReference()`
`java.lang.String`	`getVersion()`
`int`	`hashCode()`
`java.util.Iterator<Hit>`	`iterator()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Constructor Detail

Result

public Result(java.lang.String program,
              java.lang.String version,
              java.lang.String reference,
              java.lang.String dbFile,
              java.util.HashMap<java.lang.String,java.lang.String> programSpecificParameters,
              int iterationNumber,
              java.lang.String queryID,
              java.lang.String queryDef,
              int queryLength,
              java.util.List<Hit> hits,
              Sequence querySequence)

Method Detail
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class java.lang.Object
- equals
```
public boolean equals(java.lang.Object obj)
```
  Experimental. Wants to return an hashcode designed to allow conceptual comparisons of search results. Wants to implement conceptual comparisons of search results. Fields unrelated to search are deliberately not considered.
  
  Overrides:
  
  equals in class java.lang.Object
  
  Returns:
- getIterationNumber
```
public int getIterationNumber()
```
- getQueryID
```
public java.lang.String getQueryID()
```
- getQueryDef
```
public java.lang.String getQueryDef()
```
- getQueryLength
```
public int getQueryLength()
```
- getHitCounter
```
public int getHitCounter()
```
- getProgram
```
public java.lang.String getProgram()
```
- getVersion
```
public java.lang.String getVersion()
```
- getReference
```
public java.lang.String getReference()
```
- getDbFile
```
public java.lang.String getDbFile()
```
- getProgramSpecificParametersList
```
public java.util.Set<java.lang.String> getProgramSpecificParametersList()
```
- getProgramSpecificParameter
```
public java.lang.String getProgramSpecificParameter(java.lang.String key)
```
- getQuerySequence
```
public Sequence getQuerySequence()
```
  returns the reference to the original and whole sequence used to query the database. Available only if the ResultFactory implements setQueryReferences and it was used before the parsing with SearchIO
  
  Returns:
  
  Sequence object
- iterator
```
public java.util.Iterator<Hit> iterator()
```
  Specified by:
  
  iterator in interface java.lang.Iterable<Hit>

Class Result

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Result

Method Detail

hashCode

equals

getIterationNumber

getQueryID

getQueryDef

getQueryLength

getHitCounter

getProgram

getVersion

getReference

getDbFile

getProgramSpecificParametersList

getProgramSpecificParameter

getQuerySequence

iterator