RETAAnalysis (RETA CORE JavaDocs)

java.lang.Object
- com.ben12.reta.util.RETAAnalysis

public final class RETAAnalysis
extends Object

Author:: Benoît Moreau (ben.12)

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.StringProperty`	`output`
`javafx.collections.ObservableList<InputRequirementSource>`	`requirementSources`

Field Summary

Fields
Modifier and Type Field and Description

static String OUTPUT
output property name.

static String REQUIREMENT_SOURCES
requirementSources property name.

Fields
Modifier and Type	Field and Description
`static String`	`OUTPUT` `output` property name.
`static String`	`REQUIREMENT_SOURCES` `requirementSources` property name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`analyse()` Analyze the parsing result.
`void`	`configure(File iniFile)`
`File`	`getConfig()`
`static RETAAnalysis`	`getInstance()`
`SourceProviderPlugin`	`getPlugin(String pluginClass)`
`Collection<SourceProviderPlugin>`	`getPluginList()`
`Optional<InputRequirementSource>`	`getRequirementSource(String sourceName)`
`javafx.beans.property.StringProperty`	`outputProperty()`
`void`	`parse(javafx.beans.property.DoubleProperty progress)` Parallel parsing of input requirement sources.
`void`	`parse(InputRequirementSource requirementSource, StringBuilder sourceText, int limit)`
`javafx.collections.ObservableList<InputRequirementSource>`	`requirementSourcesProperty()`
`void`	`saveConfig(File iniFile)`
`String`	`toString()`
`void`	`writeExcel()` Write Excel file result of requirement traceability analysis.
`void`	`writeExcel(org.apache.poi.ss.usermodel.Workbook workbook, Path outputFile)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Property Detail
  - requirementSources
```
public javafx.collections.ObservableList<InputRequirementSource> requirementSourcesProperty
```
    Returns:
    
    the requirementSources
  - output
```
public javafx.beans.property.StringProperty outputProperty
```
    Returns:
    
    the output
- Field Detail
  - REQUIREMENT_SOURCES
```
public static final String REQUIREMENT_SOURCES
```
    requirementSources property name.
    
    See Also:
    
    Constant Field Values
  - OUTPUT
```
public static final String OUTPUT
```
    output property name.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static RETAAnalysis getInstance()
```
    Returns:
    
    the singleton instance.
  - getPluginList
```
public Collection<SourceProviderPlugin> getPluginList()
```
    Returns:
    
    the plugin list
  - getPlugin
```
public 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
  - outputProperty
```
public javafx.beans.property.StringProperty outputProperty()
```
    Returns:
    
    the output
  - configure
```
public void configure(File iniFile)
```
    Parameters:
    
    iniFile - RETA INI file
  - saveConfig
```
public void saveConfig(File iniFile)
```
    Parameters:
    
    iniFile - INI file where save configuration
  - parse
```
public void parse(javafx.beans.property.DoubleProperty progress)
           throws RETAParseException
```
    Parallel parsing of input requirement sources.
    
    Parameters:
    
    progress - progression in percent
    
    Throws:
    
    RETAParseException - RETA Parser exception
  - parse
```
public void parse(InputRequirementSource requirementSource,
                  StringBuilder sourceText,
                  int limit)
           throws RETAParseException
```
    Parameters:
    
    requirementSource - input requirement source
    
    sourceText - source content parsed
    
    limit - source limit size to parse
    
    Throws:
    
    RETAParseException - Parsing exception
  - analyse
```
public void analyse()
```
    Analyze the parsing result. Search requirement references in requirements.
  - writeExcel
```
public void writeExcel()
                throws IOException,
                       org.apache.poi.openxml4j.exceptions.InvalidFormatException
```
    Write Excel file result of requirement traceability analysis.
    
    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,
                       Path 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

Class RETAAnalysis

Property Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

requirementSources

output

Field Detail

REQUIREMENT_SOURCES

OUTPUT

Method Detail

getInstance

getPluginList

getPlugin

requirementSourcesProperty

getRequirementSource

getConfig

outputProperty

configure

saveConfig

parse

parse

analyse

writeExcel

writeExcel

toString