Package de.isas.mztab2.model

Class SpectraRef

java.lang.Object

de.isas.mztab2.model.SpectraRef

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2021-01-02T19:25:37.430+01:00")
public class SpectraRef
extends Object

Reference to a spectrum in a spectrum file, for example a fragmentation spectrum has been used to support the identification. If a separate spectrum file has been used for fragmentation spectrum, this MUST be reported in the metadata section as additional ms_runs. The reference must be in the format ms_run[1-n]:{SPECTRA_REF} where SPECTRA_REF MUST follow the format defined in 5.2 (including references to chromatograms where these are used to inform identification). Multiple spectra MUST be referenced using a “|” delimited list for the (rare) cases in which search engines have combined or aggregated multiple spectra in advance of the search to make identifications. If a fragmentation spectrum has not been used, the value should indicate the ms_run to which is identification is mapped e.g. “ms_run[1]”.

mzTab-M specification example(s):

SEH     SME_ID  …       spectra_ref     …
SME     1                       ms_run[1]:index=5       …

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
SpectraRef()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NotNull @Valid MsRun	getMsRun()	The ms run object reference by this spectral reference.
@NotNull String	getReference()	The (vendor-dependendent) reference string to the actual mass spectrum.
int	hashCode()
SpectraRef	msRun(MsRun msRun)	Builder method for msRun.
SpectraRef	reference(String reference)	Builder method for reference.
void	setMsRun(MsRun msRun)	Set msRun.
void	setReference(String reference)	Set reference.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SpectraRef

public SpectraRef()

Method Detail

msRun

public SpectraRef msRun(MsRun msRun)

Builder method for msRun.

Parameters:

msRun - a MsRun parameter.

Returns:

SpectraRef

See Also:

SpectraRef#setMsRun for specification examples, SpectraRef#getMsRun for validation constraints

getMsRun

@NotNull
@Valid
public @NotNull @Valid MsRun getMsRun()

The ms run object reference by this spectral reference.

Returns:

msRun

setMsRun

public void setMsRun(MsRun msRun)

Set msRun.

Parameters:

msRun - a MsRun parameter.

See Also:

SpectraRef#getMsRun for validation constraints

reference

public SpectraRef reference(String reference)

Builder method for reference.

Parameters:

reference - a String parameter.

Returns:

SpectraRef

See Also:

SpectraRef#setReference for specification examples, SpectraRef#getReference for validation constraints

getReference

@NotNull
public @NotNull String getReference()

The (vendor-dependendent) reference string to the actual mass spectrum.

Returns:

reference

setReference

public void setReference(String reference)

Set reference.

Parameters:

reference - a String parameter.

See Also:

SpectraRef#getReference for validation constraints

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object