kea.programs.jPrimrose
Class OligoSearchResultCollection

java.lang.Object
  extended by kea.programs.jPrimrose.OligoSearchResultCollection

public class OligoSearchResultCollection
extends java.lang.Object

Collection of OligoSearchResult objects, generated by SearchDatabase.

Version:
2.17.
Author:
Kevin Ashelford.

Constructor Summary
OligoSearchResultCollection()
          Creates a new instance of OligoSearchResultCollection.
 
Method Summary
 void addOligoSearchResult(OligoSearchResult oligoSearchResult)
          Add OligoSearchResult object to collection.
 OligoSearchResult getOligoSearchResult(int index)
          Returns OligoSearchResult object corresponding to index number supplied.
 OligoSearchResult getOligoSearchResult(kea.database.Oligo oligo)
          Returns OligoSearchResult object corresponding to Oligo object supplied.
 OligoSearchResult[] getOligoSearchResults()
          Returns array of oligo search result objects.
 int getSize()
          Returns size of collection.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OligoSearchResultCollection

public OligoSearchResultCollection()
Creates a new instance of OligoSearchResultCollection.

Method Detail

addOligoSearchResult

public void addOligoSearchResult(OligoSearchResult oligoSearchResult)
Add OligoSearchResult object to collection.

Parameters:
oligoSearchResult - Search result to add to collection.

getOligoSearchResult

public OligoSearchResult getOligoSearchResult(kea.database.Oligo oligo)
Returns OligoSearchResult object corresponding to Oligo object supplied.

Parameters:
oligo - Oligo object.
Returns:
OligoSearchResult object.

getOligoSearchResult

public OligoSearchResult getOligoSearchResult(int index)
Returns OligoSearchResult object corresponding to index number supplied.

Parameters:
index - Index number of required OligoSearchResult object.
Returns:
OligoSearchResult object.

getOligoSearchResults

public OligoSearchResult[] getOligoSearchResults()
Returns array of oligo search result objects.

Returns:
Array of oligo search objects.

getSize

public int getSize()
Returns size of collection.

Returns:
Number of OligoSearchResult objects stored in collection.