Package com.compomics.util.experiment.filtering

Interface Filter

All Known Implementing Classes:
AssumptionFilter, MatchFilter, PeptideFilter, ProteinFilter, PsmFilter
public interface Filter
Generic interface for a filter.
Author:
Marc Vaudel

  • Method Summary

    Modifier and Type
    Method
    Description
    Filter
    clone()
    Clones the filter.
    String
    getCondition()
    Returns a description of the condition to match for the filter to validate.
    String
    getDescription()
    Returns a description for the filter.
    String
    getName()
    Returns the name of the filter.
    String
    getReport(boolean filterPassed)
    Returns a filter report depending on whether the condition was met.
    boolean
    isSameAs(Filter anotherFilter)
    Indicates whether another filter is the same as the current filter.

  • Method Details

    • getName

      String getName()
      Returns the name of the filter.
      Returns:
      the name of the filter

    • getDescription

      String getDescription()
      Returns a description for the filter.
      Returns:
      a description for the filter

    • getCondition

      String getCondition()
      Returns a description of the condition to match for the filter to validate.
      Returns:
      the condition to match for the filter to validate

    • getReport

      String getReport(boolean filterPassed)
      Returns a filter report depending on whether the condition was met.
      Parameters:
      filterPassed - boolean indicating whether the filter was passed
      Returns:
      the report of the filter

    • clone

      Filter clone()
      Clones the filter.
      Returns:
      a clone of the filter

    • isSameAs

      boolean isSameAs(Filter anotherFilter)
      Indicates whether another filter is the same as the current filter.
      Parameters:
      anotherFilter - another filter
      Returns:
      a boolean indicating whether another filter is the same as the current filter