Package com.ben12.reta.util

Class RETAAnalysis

java.lang.Object
com.ben12.reta.util.RETAAnalysis
public final class RETAAnalysis extends Object
Author:
Benoît Moreau (ben.12)

  • Property Details

  • Field Details

    • REQUIREMENT_SOURCES

      public static final String REQUIREMENT_SOURCES
      requirementSources property name.
      See Also:

  • Method Details

    • getInstance

      public static RETAAnalysis getInstance()
      Returns:
      the singleton instance.

    • getPluginList

      public Collection<com.ben12.reta.plugin.SourceProviderPlugin> getPluginList()
      Returns:
      the plugin list

    • getPlugin

      public com.ben12.reta.plugin.SourceProviderPlugin getPlugin(String pluginClass)
      Parameters:
      pluginClass - plugin class implementation
      Returns:
      the plugin

    • requirementSourcesProperty

      public javafx.collections.ObservableList<InputRequirementSource> requirementSourcesProperty()
      Returns:
      the requirementSources

    • getRequirementSource

      public Optional<InputRequirementSource> getRequirementSource(String sourceName)
      Parameters:
      sourceName - input requirement source name
      Returns:
      the InputRequirementSource with same name

    • getConfig

      public File getConfig()
      Returns:
      the config

    • configure

      public void configure(File iniFile)
      Parameters:
      iniFile - RETA INI file

    • saveConfig

      public boolean saveConfig(File iniFile)
      Parameters:
      iniFile - INI file where save configuration
      Returns:
      true on success

    • parse

      public void parse(Consumer<Double> progress) throws com.ben12.reta.api.RETAParseException
      Parallel parsing of input requirement sources.
      Parameters:
      progress - progression in percent
      Throws:
      com.ben12.reta.api.RETAParseException - RETA Parser exception

    • parse

      public void parse(InputRequirementSource requirementSource, StringBuilder sourceText, int limit) throws com.ben12.reta.api.RETAParseException
      Parameters:
      requirementSource - input requirement source
      sourceText - source content parsed
      limit - source limit size to parse
      Throws:
      com.ben12.reta.api.RETAParseException - Parsing exception

    • analyse

      public void analyse(Consumer<Double> progress)
      Analyze the parsing result. Search requirement references in requirements.
      Parameters:
      progress - progression in percent

    • writeExcel

      public void writeExcel(File outputFile) throws IOException, org.apache.poi.openxml4j.exceptions.InvalidFormatException
      Write Excel file result of requirement traceability analysis.
      Parameters:
      outputFile - output file
      Throws:
      IOException - I/O exception
      org.apache.poi.openxml4j.exceptions.InvalidFormatException - Invalid Excel format exception

    • writeExcel

      public void writeExcel(org.apache.poi.ss.usermodel.Workbook workbook, File outputFile) throws IOException
      Parameters:
      workbook - Workbook to write
      outputFile - output file path
      Throws:
      IOException - I/O exception

    • toString

      public String toString()
      Overrides:
      toString in class Object