Package de.isas.mztab2.model

Class Instrument

java.lang.Object

de.isas.mztab2.model.IndexedElement

de.isas.mztab2.model.Instrument

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

The name, source, analyzer and detector of the instruments used in the experiment. Multiple instruments are numbered [1-n].

mzTab-M specification example(s):

MTD     instrument[1]-name      [MS, MS:1000449, LTQ Orbitrap,]
MTD     instrument[1]-source    [MS, MS:1000073, ESI,]
…
MTD     instrument[2]-source    [MS, MS:1000598, ETD,]
MTD     instrument[1]-analyzer[1]       [MS, MS:1000291, linear ion trap,]
…
MTD     instrument[2]-analyzer[1]       [MS, MS:1000484, orbitrap,]
MTD     instrument[1]-detector  [MS, MS:1000253, electron multiplier,]
…
MTD     instrument[2]-detector  [MS, MS:1000348, focal plane collector,]

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
Instrument()

Method Summary

Modifier and Type	Method	Description
Instrument	addAnalyzerItem(Parameter analyzerItem)	Add a single analyzerItem to the analyzer collection.
Instrument	analyzer(List<Parameter> analyzer)	Builder method for analyzer.
Instrument	detector(Parameter detector)	Builder method for detector.
Instrument	elementType(String elementType)	Builder method for elementType.
boolean	equals(Object o)
@Valid List<Parameter>	getAnalyzer()	The instrument's mass analyzer, as defined by the parameter.
@Valid Parameter	getDetector()	The instrument's detector, as defined by the parameter.
@Valid Parameter	getName()	Get name.
@Valid Parameter	getSource()	The instrument's source, as defined by the parameter.
int	hashCode()
Instrument	id(Integer id)	Builder method for id.
Instrument	name(Parameter name)	Builder method for name.
void	setAnalyzer(List<Parameter> analyzer)	Set analyzer.
void	setDetector(Parameter detector)	Set detector.
void	setName(Parameter name)	Set name.
void	setSource(Parameter source)	Set source.
Instrument	source(Parameter source)	Builder method for source.
String	toString()

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

Instrument

public Instrument()

Method Detail

id

public Instrument 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 Instrument 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

name

public Instrument name(Parameter name)

Builder method for name.

Parameters:

name - a Parameter parameter.

Returns:

Instrument

See Also:

Instrument#setName for specification examples, Instrument#getName for validation constraints

getName

@Valid
public @Valid Parameter getName()

Get name.

Returns:

name

setName

public void setName(Parameter name)

Set name.

Parameters:

name - a Parameter parameter.

See Also:

Instrument#getName for validation constraints

source

public Instrument source(Parameter source)

Builder method for source.

Parameters:

source - a Parameter parameter.

Returns:

Instrument

See Also:

Instrument#setSource for specification examples, Instrument#getSource for validation constraints

getSource

@Valid
public @Valid Parameter getSource()

The instrument's source, as defined by the parameter.

Returns:

source

setSource

public void setSource(Parameter source)

Set source.

Parameters:

source - a Parameter parameter.

See Also:

Instrument#getSource for validation constraints

analyzer

public Instrument analyzer(List<Parameter> analyzer)

Builder method for analyzer.

Parameters:

analyzer - a List<Parameter> parameter.

Returns:

Instrument

See Also:

Instrument#setAnalyzer for specification examples, Instrument#getAnalyzer for validation constraints

addAnalyzerItem

public Instrument addAnalyzerItem(Parameter analyzerItem)

Add a single analyzerItem to the analyzer collection.

Parameters:

analyzerItem - a Parameter parameter.

Returns:

Instrument

See Also:

Instrument#getAnalyzer for validation constraints

getAnalyzer

@Valid
public @Valid List<Parameter> getAnalyzer()

The instrument's mass analyzer, as defined by the parameter.

Returns:

analyzer

setAnalyzer

public void setAnalyzer(List<Parameter> analyzer)

Set analyzer.

Parameters:

analyzer - a List<Parameter> parameter.

See Also:

Instrument#getAnalyzer for validation constraints

detector

public Instrument detector(Parameter detector)

Builder method for detector.

Parameters:

detector - a Parameter parameter.

Returns:

Instrument

See Also:

Instrument#setDetector for specification examples, Instrument#getDetector for validation constraints

getDetector

@Valid
public @Valid Parameter getDetector()

The instrument's detector, as defined by the parameter.

Returns:

detector

setDetector

public void setDetector(Parameter detector)

Set detector.

Parameters:

detector - a Parameter parameter.

See Also:

Instrument#getDetector 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