Package de.isas.mztab2.model
Class MsRun
- java.lang.Object
-
- de.isas.mztab2.model.IndexedElement
-
- de.isas.mztab2.model.MsRun
-
@Generated(value="io.swagger.codegen.languages.JavaClientCodegen", date="2019-08-07T11:09:24.487+02:00") public class MsRun extends IndexedElement
Specification of ms_run. location: Location of the external data file e.g. raw files on which analysis has been performed. If the actual location of the MS run is unknown, a “null” MUST be used as a place holder value, since the [1-n] cardinality is referenced elsewhere. If pre-fractionation has been performed, then [1-n] ms_runs SHOULD be created per assay. instrument_ref: If different instruments are used in different runs, instrument_ref can be used to link a specific instrument to a specific run. format: Parameter specifying the data format of the external MS data file. If ms_run[1-n]-format is present, ms_run[1-n]-id_format SHOULD also be present, following the parameters specified in Table 1. id_format: Parameter specifying the id format used in the external data file. If ms_run[1-n]-id_format is present, ms_run[1-n]-format SHOULD also be present. fragmentation_method: The type(s) of fragmentation used in a given ms run. scan_polarity: The polarity mode of a given run. Usually only one value SHOULD be given here except for the case of mixed polarity runs. hash: Hash value of the corresponding external MS data file defined in ms_run[1-n]-location. If ms_run[1-n]-hash is present, ms_run[1-n]-hash_method SHOULD also be present. hash_method: A parameter specifying the hash methods used to generate the String in ms_run[1-n]-hash. Specifics of the hash method used MAY follow the definitions of the mzML format. If ms_run[1-n]-hash is present, ms_run[1-n]-hash_method SHOULD also be present.mzTab-M specification example(s):
COM location can be a local or remote URI MTD ms_run[1]-location file:///C:/path/to/my/file.mzML MTD ms_run[1]-instrument_ref instrument[1] MTD ms_run[1]-format [MS, MS:1000584, mzML file, ] MTD ms_run[1]-id_format [MS, MS:1000530, mzML unique identifier, ] MTD ms_run[1]-fragmentation_method[1] [MS, MS:1000133, CID, ] COM for mixed polarity scan scenarios MTD ms_run[1]-scan_polarity[1] [MS, MS:1000130, positive scan, ] MTD ms_run[1]-scan_polarity[2] [MS, MS:1000129, negative scan, ] MTD ms_run[1]-hash_method [MS, MS:1000569, SHA-1, ] MTD ms_run[1]-hash de9f2c7fd25e1b3afad3e85a0bd17d9b100db4b3
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMsRun.PropertiesProperty enumeration for MsRun.
-
Constructor Summary
Constructors Constructor Description MsRun()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MsRunaddFragmentationMethodItem(Parameter fragmentationMethodItem)Add a single fragmentationMethodItem to the fragmentationMethod collection.MsRunaddScanPolarityItem(Parameter scanPolarityItem)Add a single scanPolarityItem to the scanPolarity collection.MsRunelementType(String elementType)Builder method for elementType.booleanequals(Object o)MsRunformat(Parameter format)Builder method for format.MsRunfragmentationMethod(List<Parameter> fragmentationMethod)Builder method for fragmentationMethod.@Valid ParametergetFormat()The msRun's file format.@Valid List<Parameter>getFragmentationMethod()The fragmentation methods applied during this msRun.StringgetHash()The file hash value of this msRun's data file.@Valid ParametergetHashMethod()The hash method used to calculate the file hash.@Valid ParametergetIdFormat()The msRun's mass spectra id format.@Valid InstrumentgetInstrumentRef()The instrument on which this msRun was measured.@NotNull StringgetLocation()The msRun's location URI.@NotNull StringgetName()The msRun's name.@Valid List<Parameter>getScanPolarity()The scan polarity/polarities used during this msRun.MsRunhash(String hash)Builder method for hash.inthashCode()MsRunhashMethod(Parameter hashMethod)Builder method for hashMethod.MsRunid(Integer id)Builder method for id.MsRunidFormat(Parameter idFormat)Builder method for idFormat.MsRuninstrumentRef(Instrument instrumentRef)Builder method for instrumentRef.MsRunlocation(String location)Builder method for location.MsRunname(String name)Builder method for name.MsRunscanPolarity(List<Parameter> scanPolarity)Builder method for scanPolarity.voidsetFormat(Parameter format)Set format.voidsetFragmentationMethod(List<Parameter> fragmentationMethod)Set fragmentationMethod.voidsetHash(String hash)Set hash.voidsetHashMethod(Parameter hashMethod)Set hashMethod.voidsetIdFormat(Parameter idFormat)Set idFormat.voidsetInstrumentRef(Instrument instrumentRef)Set instrumentRef.voidsetLocation(String location)Set location.voidsetName(String name)Set name.voidsetScanPolarity(List<Parameter> scanPolarity)Set scanPolarity.StringtoString()-
Methods inherited from class de.isas.mztab2.model.IndexedElement
getElementType, getId, setElementType, setId
-
-
-
-
Constructor Detail
-
MsRun
public MsRun()
-
-
Method Detail
-
id
public MsRun id(Integer id)
Description copied from class:IndexedElementBuilder method for id.- Overrides:
idin classIndexedElement- Parameters:
id- aIntegerparameter.- Returns:
- IndexedElement
- See Also:
IndexedElement#setId for specification examples,IndexedElement#getId for validation constraints
-
elementType
public MsRun elementType(String elementType)
Description copied from class:IndexedElementBuilder method for elementType.- Overrides:
elementTypein classIndexedElement- Parameters:
elementType- aStringparameter.- Returns:
- IndexedElement
- See Also:
IndexedElement#setElementType for specification examples,IndexedElement#getElementType for validation constraints
-
name
public MsRun name(String name)
Builder method for name.- Parameters:
name- aStringparameter.- Returns:
- MsRun
- See Also:
MsRun#setName for specification examples,MsRun#getName for validation constraints
-
setName
public void setName(String name)
Set name.- Parameters:
name- aStringparameter.- See Also:
MsRun#getName for validation constraints
-
location
public MsRun location(String location)
Builder method for location.- Parameters:
location- aStringparameter.- Returns:
- MsRun
- See Also:
MsRun#setLocation for specification examples,MsRun#getLocation for validation constraints
-
getLocation
@NotNull public @NotNull String getLocation()
The msRun's location URI.- Returns:
- location
-
setLocation
public void setLocation(String location)
Set location.- Parameters:
location- aStringparameter.- See Also:
MsRun#getLocation for validation constraints
-
instrumentRef
public MsRun instrumentRef(Instrument instrumentRef)
Builder method for instrumentRef.- Parameters:
instrumentRef- aInstrumentparameter.- Returns:
- MsRun
- See Also:
MsRun#setInstrumentRef for specification examples,MsRun#getInstrumentRef for validation constraints
-
getInstrumentRef
@Valid public @Valid Instrument getInstrumentRef()
The instrument on which this msRun was measured.- Returns:
- instrumentRef
-
setInstrumentRef
public void setInstrumentRef(Instrument instrumentRef)
Set instrumentRef.- Parameters:
instrumentRef- aInstrumentparameter.- See Also:
MsRun#getInstrumentRef for validation constraints
-
format
public MsRun format(Parameter format)
Builder method for format.- Parameters:
format- aParameterparameter.- Returns:
- MsRun
- See Also:
MsRun#setFormat for specification examples,MsRun#getFormat for validation constraints
-
setFormat
public void setFormat(Parameter format)
Set format.- Parameters:
format- aParameterparameter.- See Also:
MsRun#getFormat for validation constraints
-
idFormat
public MsRun idFormat(Parameter idFormat)
Builder method for idFormat.- Parameters:
idFormat- aParameterparameter.- Returns:
- MsRun
- See Also:
MsRun#setIdFormat for specification examples,MsRun#getIdFormat for validation constraints
-
getIdFormat
@Valid public @Valid Parameter getIdFormat()
The msRun's mass spectra id format.- Returns:
- idFormat
-
setIdFormat
public void setIdFormat(Parameter idFormat)
Set idFormat.- Parameters:
idFormat- aParameterparameter.- See Also:
MsRun#getIdFormat for validation constraints
-
fragmentationMethod
public MsRun fragmentationMethod(List<Parameter> fragmentationMethod)
Builder method for fragmentationMethod.- Parameters:
fragmentationMethod- aList<Parameter>parameter.- Returns:
- MsRun
- See Also:
MsRun#setFragmentationMethod for specification examples,MsRun#getFragmentationMethod for validation constraints
-
addFragmentationMethodItem
public MsRun addFragmentationMethodItem(Parameter fragmentationMethodItem)
Add a single fragmentationMethodItem to the fragmentationMethod collection.- Parameters:
fragmentationMethodItem- aParameterparameter.- Returns:
- MsRun
- See Also:
MsRun#getFragmentationMethod for validation constraints
-
getFragmentationMethod
@Valid public @Valid List<Parameter> getFragmentationMethod()
The fragmentation methods applied during this msRun.- Returns:
- fragmentationMethod
-
setFragmentationMethod
public void setFragmentationMethod(List<Parameter> fragmentationMethod)
Set fragmentationMethod.- Parameters:
fragmentationMethod- aList<Parameter>parameter.- See Also:
MsRun#getFragmentationMethod for validation constraints
-
scanPolarity
public MsRun scanPolarity(List<Parameter> scanPolarity)
Builder method for scanPolarity.- Parameters:
scanPolarity- aList<Parameter>parameter.- Returns:
- MsRun
- See Also:
MsRun#setScanPolarity for specification examples,MsRun#getScanPolarity for validation constraints
-
addScanPolarityItem
public MsRun addScanPolarityItem(Parameter scanPolarityItem)
Add a single scanPolarityItem to the scanPolarity collection.- Parameters:
scanPolarityItem- aParameterparameter.- Returns:
- MsRun
- See Also:
MsRun#getScanPolarity for validation constraints
-
getScanPolarity
@Valid public @Valid List<Parameter> getScanPolarity()
The scan polarity/polarities used during this msRun.- Returns:
- scanPolarity
-
setScanPolarity
public void setScanPolarity(List<Parameter> scanPolarity)
Set scanPolarity.- Parameters:
scanPolarity- aList<Parameter>parameter.- See Also:
MsRun#getScanPolarity for validation constraints
-
hash
public MsRun hash(String hash)
Builder method for hash.- Parameters:
hash- aStringparameter.- Returns:
- MsRun
- See Also:
MsRun#setHash for specification examples,MsRun#getHash for validation constraints
-
setHash
public void setHash(String hash)
Set hash.- Parameters:
hash- aStringparameter.- See Also:
MsRun#getHash for validation constraints
-
hashMethod
public MsRun hashMethod(Parameter hashMethod)
Builder method for hashMethod.- Parameters:
hashMethod- aParameterparameter.- Returns:
- MsRun
- See Also:
MsRun#setHashMethod for specification examples,MsRun#getHashMethod for validation constraints
-
getHashMethod
@Valid public @Valid Parameter getHashMethod()
The hash method used to calculate the file hash.- Returns:
- hashMethod
-
setHashMethod
public void setHashMethod(Parameter hashMethod)
Set hashMethod.- Parameters:
hashMethod- aParameterparameter.- See Also:
MsRun#getHashMethod for validation constraints
-
equals
public boolean equals(Object o)
- Overrides:
equalsin classIndexedElement
-
hashCode
public int hashCode()
- Overrides:
hashCodein classIndexedElement
-
toString
public String toString()
- Overrides:
toStringin classIndexedElement
-
-