All Classes and Interfaces
Class
Description
A
CellAssertion
that succeeds if the value in another cell with a position defined relative
to the CellValue.location()
is within a set of allowed values.Builder for creating an instance of
AdjacentCellAssertion
.A setting to control the behavior for normalizing case in column names
automatically inferred from a header in the input Excel data.
An assertion checked by
CellValue
in order to ensure that extracted data matches expectations.Builder for creating an instance of
CellValue
.An assertion checked by
CheckboxValue
in order to ensure that extracted data matches expectations.A function that defines the behavior for getting the checked state of a checkbox.
A
ValueExtractor
for extracting the checked state of a checkbox.A
NumericCellStringifier
that uses NumberFormat.format(double)
.A collection of XML
VmlShape
objects extracted from a sheet's legacyDrawing element as returned from
CTWorksheet.getLegacyDrawing()
.The definition of a field to be extracted from a form-style Excel, including the column name to assign to
the value in the output dataframe and logic for extracting the value.
A
Parser
for extracting data in a non-tabular format.A builder for creating instances of
FormParser
.Information used by a
RowExtractor
to identify where tabular data is located and the names associated with
each column.A builder for creating instances of
Header
.A function that, given a sheet, returns a
Header
, which guides subsequent extraction of rows with a RowExtractor
.A
CheckboxSpecifier
for extracting data from a checkbox with a user-visible ID and ObjectType=Pict.Functions that are convenient when using the transforms-excel-parser library in incremental pipelines.
A
NumericCellStringifier
that uses Double.toString(double)
.This class is an implementation detail that is only public because being public is a requirement for Kryo
serialization.
A location within a
Sheet
as defined by a 0-indexed row, column pair.A
CheckboxSpecifier
for extracting data from a checkbox without an ID and with ObjectType=CheckBox.A
HeaderExtractor
for extracting complex headers consisting of multiple rows with a hierarchy of merged cells.A builder for constructing an instance of
MultilayerMergedHeaderExtractor
.The function used to convert the value of a numeric cell to a String in the output
dataframe (this library outputs strings for all values in an Excel sheet to avoid
issues due to inconsistently typed fields).
An assertion that the location of a checkbox drawing on the sheet overlaps with a specific cell.
A high-level abstraction over the idea of taking a
WorkbookWithMetadata
and returning some data.The return value from
TransformsExcelParser.parse(Dataset)
.A function to provide a set of passwords to use to try to decrypt a file,
given the file path.
A sheet selector that matches all sheets whose names contain a match for the specified regular expression.
A function that, given the
Header
returned from a HeaderExtractor
and a Sheet
returned from a SheetSelector
, extracts data.This class is an implementation detail that is only public because being public is a requirement for Kryo
serialization.
A simple
StopCondition
that tells a SimpleRowExtractor
to stop extracting data after a specific row in the sheet.A function that, given a
WorkbookWithMetadata
, returns a collection of Sheet
objects to extract
data from.Information passed to
StopCondition.shouldStop(ShouldStopParameters)
.A
HeaderExtractor
appropriate for extracting a single-row header.A builder for constructing an instance of
SimpleHeaderExtractor
.The default implementation of
RowExtractor
.A function that, given some information about a row, returns true if that row should not be extracted and
furthermore that extraction of data from the sheet should stop upon seeing that row.
A
Parser
for extracting tabular data from Excel.A builder for creating instances of
TableParser
.A class for extracting data from a dataset of Excel files and returning a
ParseResult
including
error details, decryption success/failure details, and one or more dataframes.A builder for constructing an instance of
TransformsExcelParser
with customized settings and/or
multiple outputs.Logic for extracting a value from a form-style Excel sheet, as used in a
FieldSpec
.Information passed to
ValueExtractor.extractValue(ValueExtractorParameters)
.A
CellAssertion
that succeeds if the value in a cell is within a set of allowed values.Functions that are generally convenient when working with
Workbook
objects.A
Workbook
object (the result of loading an Excel file from a dataset into Apache POI)
along with information about the file in the dataset such as its path.