Package de.isas.mztab2.model

Class Database

java.lang.Object

de.isas.mztab2.model.IndexedElement

de.isas.mztab2.model.Database

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2020-02-11T15:12:05.057+01:00")
public class Database
extends IndexedElement

Specification of databases. (empty): The description of databases used. For cases, where a known database has not been used for identification, a userParam SHOULD be inserted to describe any identification performed e.g. de novo. If no identification has been performed at all then "no database" should be inserted followed by null. prefix: The prefix used in the “identifier” column of data tables. For the “no database” case "null" must be used. version: The database version is mandatory where identification has been performed. This may be a formal version number e.g. “1.4.1”, a date of access “2016-10-27” (ISO-8601 format) or “Unknown” if there is no suitable version that can be annotated. uri: The URI to the database. For the “no database” case, "null" must be reported.

mzTab-M specification example(s):

MTD     database[1]     [MIRIAM, MIR:00100079, HMDB, ]
MTD     database[1]-prefix      hmdb
MTD     database[1]-version     3.6
MTD     database[1]-uri http://www.hmdb.ca/
MTD     database[2]     [,, "de novo", ]
MTD     database[2]-prefix      dn
MTD     database[2]-version     Unknown
MTD     database[2]-uri null
MTD     database[3]     [,, "no database", null ]
MTD     database[3]-prefix      null
MTD     database[3]-version     Unknown
MTD     database[3]-uri null

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Database.Properties	Property enumeration for Database.

Constructor Summary

Constructors

Constructor	Description
Database()

Method Summary

Modifier and Type	Method	Description
Database	elementType(String elementType)	Builder method for elementType.
boolean	equals(Object o)
@NotNull @Valid Parameter	getParam()	The parameter to identify this database.
@NotNull String	getPrefix()	The database prefix.
@NotNull String	getUri()	The URI to the online database.
@NotNull String	getVersion()	The database version.
int	hashCode()
Database	id(Integer id)	Builder method for id.
Database	param(Parameter param)	Builder method for param.
Database	prefix(String prefix)	Builder method for prefix.
void	setParam(Parameter param)	Set param.
void	setPrefix(String prefix)	Set prefix.
void	setUri(String uri)	Set uri.
void	setVersion(String version)	Set version.
String	toString()
Database	uri(String uri)	Builder method for uri.
Database	version(String version)	Builder method for version.

Methods inherited from class de.isas.mztab2.model.IndexedElement

getElementType, getId, setElementType, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Database

public Database()

Method Detail

id

public Database id(Integer id)

Description copied from class: IndexedElement

Builder method for id.

Overrides:

id in class IndexedElement

Parameters:

id - a Integer parameter.

Returns:

IndexedElement

See Also:

IndexedElement#setId for specification examples, IndexedElement#getId for validation constraints

elementType

public Database elementType(String elementType)

Description copied from class: IndexedElement

Builder method for elementType.

Overrides:

elementType in class IndexedElement

Parameters:

elementType - a String parameter.

Returns:

IndexedElement

See Also:

IndexedElement#setElementType for specification examples, IndexedElement#getElementType for validation constraints

param

public Database param(Parameter param)

Builder method for param.

Parameters:

param - a Parameter parameter.

Returns:

Database

See Also:

Database#setParam for specification examples, Database#getParam for validation constraints

getParam

@NotNull
@Valid
public @NotNull @Valid Parameter getParam()

The parameter to identify this database.

Returns:

param

setParam

public void setParam(Parameter param)

Set param.

Parameters:

param - a Parameter parameter.

See Also:

Database#getParam for validation constraints

prefix

public Database prefix(String prefix)

Builder method for prefix.

Parameters:

prefix - a String parameter.

Returns:

Database

See Also:

Database#setPrefix for specification examples, Database#getPrefix for validation constraints

getPrefix

@NotNull
public @NotNull String getPrefix()

The database prefix.

Returns:

prefix

setPrefix

public void setPrefix(String prefix)

Set prefix.

Parameters:

prefix - a String parameter.

See Also:

Database#getPrefix for validation constraints

version

public Database version(String version)

Builder method for version.

Parameters:

version - a String parameter.

Returns:

Database

See Also:

Database#setVersion for specification examples, Database#getVersion for validation constraints

getVersion

@NotNull
public @NotNull String getVersion()

The database version.

Returns:

version

setVersion

public void setVersion(String version)

Set version.

Parameters:

version - a String parameter.

See Also:

Database#getVersion for validation constraints

uri

public Database uri(String uri)

Builder method for uri.

Parameters:

uri - a String parameter.

Returns:

Database

See Also:

Database#setUri for specification examples, Database#getUri for validation constraints

getUri

@NotNull
public @NotNull String getUri()

The URI to the online database.

Returns:

uri

setUri

public void setUri(String uri)

Set uri.

Parameters:

uri - a String parameter.

See Also:

Database#getUri for validation constraints

equals

public boolean equals(Object o)

Overrides:

equals in class IndexedElement

hashCode

public int hashCode()

Overrides:

hashCode in class IndexedElement

toString

public String toString()

Overrides:

toString in class IndexedElement