org.bridgedb
Class DataSource.Builder

java.lang.Object
  org.bridgedb.DataSource.Builder

Enclosing class:

DataSource

public static final class DataSource.Builder
extends java.lang.Object

Uses builder pattern to set optional attributes for a DataSource. For example, this allows you to use the following code:

 DataSource.register("X", "Affymetrix")
     .mainUrl("http://www.affymetrix.com")
     .type("probe")
     .primary(false);
 

Method Summary

DataSource	asDataSource()
DataSource.Builder	idExample(java.lang.String idExample)
DataSource.Builder	mainUrl(java.lang.String mainUrl)
DataSource.Builder	organism(java.lang.Object organism)
DataSource.Builder	primary(boolean isPrimary)
DataSource.Builder	type(java.lang.String type)
DataSource.Builder	urlPattern(java.lang.String urlPattern)
DataSource.Builder	urnBase(java.lang.String base)

Methods inherited from class java.lang.Object

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

Method Detail

asDataSource

public DataSource asDataSource()

Returns:

the DataSource under construction

urlPattern

public DataSource.Builder urlPattern(java.lang.String urlPattern)

Parameters:

urlPattern - is a template for generating valid URL's for identifiers. The pattern should contain the substring "$ID", which will be replaced by the actual identifier.

Returns:

the same Builder object so you can chain setters

mainUrl

public DataSource.Builder mainUrl(java.lang.String mainUrl)

Parameters:

mainUrl - url of homepage

Returns:

the same Builder object so you can chain setters

idExample

public DataSource.Builder idExample(java.lang.String idExample)

Parameters:

idExample - an example id from this system

Returns:

the same Builder object so you can chain setters

primary

public DataSource.Builder primary(boolean isPrimary)

Parameters:

isPrimary - secondary id's such as EC numbers, Gene Ontology or vendor-specific systems occur in data or linkouts, but their use in pathways is discouraged

Returns:

the same Builder object so you can chain setters

type

public DataSource.Builder type(java.lang.String type)

Parameters:

type - the type of datasource, for example "protein", "gene", "metabolite"

Returns:

the same Builder object so you can chain setters

organism

public DataSource.Builder organism(java.lang.Object organism)

Parameters:

organism - organism for which this system code is suitable, or null for any / not applicable

Returns:

the same Builder object so you can chain setters

urnBase

public DataSource.Builder urnBase(java.lang.String base)

Parameters:

base - for urn generation, for example "urn:miriam:uniprot"

Returns:

the same Builder object so you can chain setters