com.compomics.util.experiment.filters.massspectrometry.spectrumfilters
Class Or

java.lang.Object
  extended by com.compomics.util.experiment.filters.massspectrometry.SpectrumFilter
      extended by com.compomics.util.experiment.filters.massspectrometry.spectrumfilters.Or
All Implemented Interfaces:
Serializable

public class Or
extends SpectrumFilter

Filter consisting of several filters. The validation will be an 'or' of all individual validations.

Author:
Marc Vaudel
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.compomics.util.experiment.filters.massspectrometry.SpectrumFilter
name
 
Constructor Summary
Or()
          Constructor.
 
Method Summary
 void addFilter(SpectrumFilter spectrumFilter)
          Adds a filter to the or Filters will be tested iteratively so put the fast/discriminative first.
 String getDescription()
          Returns a description of the validated spectra, typically "containing a peak at m/z 114".
 boolean validateSpectrum(MSnSpectrum spectrum)
          Returns a boolean indicating whether one of the implemented filters validated the spectrum.
 
Methods inherited from class com.compomics.util.experiment.filters.massspectrometry.SpectrumFilter
getElementaryFilters, getFilter, getName, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Or

public Or()
Constructor.

Method Detail

addFilter

public void addFilter(SpectrumFilter spectrumFilter)
Adds a filter to the or Filters will be tested iteratively so put the fast/discriminative first.

Parameters:
spectrumFilter -

validateSpectrum

public boolean validateSpectrum(MSnSpectrum spectrum)
Returns a boolean indicating whether one of the implemented filters validated the spectrum.

Specified by:
validateSpectrum in class SpectrumFilter
Parameters:
spectrum - the spectrum
Returns:
a boolean indicating whether one of the implemented filters validated the spectrum

getDescription

public String getDescription()
Description copied from class: SpectrumFilter
Returns a description of the validated spectra, typically "containing a peak at m/z 114".

Specified by:
getDescription in class SpectrumFilter
Returns:
a description of the validated spectra


Copyright © 2013. All Rights Reserved.