edu.mssm.crover.mutations.drivers
Class DriverInformation

java.lang.Object
  |
  +--edu.mssm.crover.mutations.drivers.DriverInformation

public final class DriverInformation

extends java.lang.Object

Provides information about a driver that are potentially of interest to an end-user.

Constructor Summary

DriverInformation(java.lang.String shortname, java.lang.String driverManufacturer, java.lang.String driverAuthors, java.lang.String descriptionURL, java.lang.String driverDescriptionURL, java.lang.String howToCiteOriginalDB, java.lang.String[] supportedOrigins)

Method Summary

java.lang.String	getDescriptionURL() A URL that describes the original DB that the driver reads.
java.lang.String	getDriverAuthors() The name of the author(s) of this driver.
java.lang.String	getDriverDescriptionURL() A URL that describes the driver.
java.lang.String	getDriverManufacturer() What organization did develop this driver?
java.lang.String	getHowToCiteOriginalDB() A text that explains how to cite the original DB.
java.lang.String	getShortname() Get a short name for this driver.
java.lang.String[]	getSupportedOrigins() Returns the origins that this driver supports.
boolean	isOriginSupported(java.lang.String origin) Is this origin supported by this driver?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DriverInformation

public DriverInformation(java.lang.String shortname,
                         java.lang.String driverManufacturer,
                         java.lang.String driverAuthors,
                         java.lang.String descriptionURL,
                         java.lang.String driverDescriptionURL,
                         java.lang.String howToCiteOriginalDB,
                         java.lang.String[] supportedOrigins)

Method Detail

getShortname

public java.lang.String getShortname()

Get a short name for this driver. A Short name is less than 20 characters.

getDriverManufacturer

public java.lang.String getDriverManufacturer()

What organization did develop this driver?

getDriverAuthors

public java.lang.String getDriverAuthors()

The name of the author(s) of this driver.

getDescriptionURL

public java.lang.String getDescriptionURL()

A URL that describes the original DB that the driver reads.

getDriverDescriptionURL

public java.lang.String getDriverDescriptionURL()

A URL that describes the driver.

getHowToCiteOriginalDB

public java.lang.String getHowToCiteOriginalDB()

A text that explains how to cite the original DB.

getSupportedOrigins

public java.lang.String[] getSupportedOrigins()

Returns the origins that this driver supports. Origins identify a sequence database that associates an accession code to a sequence so that each sequence can be uniquely determined relatively to the DB. Aliases for a given database can appear in the list. For instance {"swissprot", "sw"} is returned by drivers which know only about SwissProt sequences.

isOriginSupported

public boolean isOriginSupported(java.lang.String origin)

Is this origin supported by this driver?