kea.programs.jPrimrose
Class PrimroseOligoDatabase

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

public class PrimroseOligoDatabase
extends java.lang.Object

Stores OligoCollection objects.

Version:
2.17.
Author:
Kevin Ashelford.

Constructor Summary
PrimroseOligoDatabase()
          Creates a new instance of PrimroseOligoDatabase.
 
Method Summary
 void addOligoCollection(kea.database.OligoCollection oligoCollection)
          Adds an OligoCollection object to database.
 int getNumberOfCollections()
          Returns number of OligoCollections in database.
 int getNumberOfOligos(int index)
          Returns number of Oligo objects within a specified Oligo collection.
 kea.database.OligoCollection getOligoCollection(int index)
          Returns OligoCollection object corresponding to index number.
 PrimroseOligo[] getOligos()
          Returns an array of all Oligo objects stored in database.
 int getTotalNumberOfOligos()
          Returns total number of oligo objects in database (the sum of all OligoCollection sizes).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PrimroseOligoDatabase

public PrimroseOligoDatabase()
Creates a new instance of PrimroseOligoDatabase.

Method Detail

addOligoCollection

public void addOligoCollection(kea.database.OligoCollection oligoCollection)
Adds an OligoCollection object to database.

Parameters:
oligoCollection - OligoCollection object to add.

getOligoCollection

public kea.database.OligoCollection getOligoCollection(int index)
Returns OligoCollection object corresponding to index number.

Parameters:
index - Index number of OligoCollection object.
Returns:
OligoCollection object.

getOligos

public PrimroseOligo[] getOligos()
Returns an array of all Oligo objects stored in database.

Returns:
Array of Oligo objects.

getNumberOfCollections

public int getNumberOfCollections()
Returns number of OligoCollections in database.

Returns:
Size of database.

getTotalNumberOfOligos

public int getTotalNumberOfOligos()
Returns total number of oligo objects in database (the sum of all OligoCollection sizes).

Returns:
Total number of Oligo objects.

getNumberOfOligos

public int getNumberOfOligos(int index)
Returns number of Oligo objects within a specified Oligo collection.

Parameters:
index - Index number of oligo collection to check.
Returns:
Number of Oligo objects within oligo collection.