Package org.brapi.schematools.core.xlsx

Class XSSFWorkbookGenerator

java.lang.Object
org.brapi.schematools.core.xlsx.XSSFWorkbookGenerator
public class XSSFWorkbookGenerator extends Object
Generates Excel (xlsx) file(s) for type and their field descriptions from a BrAPI Json Schema.

  • Constructor Details

    • XSSFWorkbookGenerator

      public XSSFWorkbookGenerator(Path outputPath)
      Creates a XSSFWorkbookGenerator using a default BrAPISchemaReader and the default OntModelGeneratorOptions.
      Parameters:
      outputPath - the path of the output file or directory

    • XSSFWorkbookGenerator

      public XSSFWorkbookGenerator(XSSFWorkbookGeneratorOptions options, Path outputPath)
      Creates a XSSFWorkbookGenerator using a default BrAPISchemaReader and the provided XSSFWorkbookGenerator.
      Parameters:
      options - The options to be used in the generation.
      outputPath - the path of the output file or directory

  • Method Details

    • generate

      public Response<List<Path>> generate(Path schemaDirectory)
      Generates Excel (xlsx) file(s) for type and their field descriptions from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.
      Parameters:
      schemaDirectory - the path to the complete BrAPI Specification
      Returns:
      the path of the Excel (xlsx) file(s) generated from the complete BrAPI Specification