Package com.compomics.util.io.export

Interface ExportFactory

public interface ExportFactory
An export factory manages and generates reports.
Author:
Marc Vaudel

  • Method Details

    • getExportScheme

      ExportScheme getExportScheme(String schemeName)
      Returns the export scheme indexed by the given name.
      Parameters:
      schemeName - the name of the desired export scheme
      Returns:
      the desired export scheme

    • removeExportScheme

      void removeExportScheme(String schemeName)
      Removes a user scheme.
      Parameters:
      schemeName - the name of the scheme to remove

    • addExportScheme

      void addExportScheme(ExportScheme exportScheme)
      Adds an export scheme to the map of user schemes.
      Parameters:
      exportScheme - the new export scheme, will be accessible via its name

    • getImplementedSections

      ArrayList<String> getImplementedSections()
      Returns the implemented sections.
      Returns:
      the implemented sections

    • getExportFeatures

      ArrayList<ExportFeature> getExportFeatures(String sectionName, boolean includeSubFeatures)
      Returns the export features implemented for the given section.
      Parameters:
      sectionName - the name of the section of interest
      includeSubFeatures - indicates whether sub-features should be included
      Returns:
      a list of export features