Index
All Classes and Interfaces|All Packages|Serialized Form
A
- above(int, String...) - Static method in interface com.palantir.transforms.excel.form.cellvalue.AdjacentCellAssertion
- accept(AssertionResult.Visitor<T>) - Method in class com.palantir.transforms.excel.form.assertion.AssertionFailure
- accept(AssertionResult.Visitor<T>) - Method in interface com.palantir.transforms.excel.form.assertion.AssertionResult
- accept(AssertionResult.Visitor<T>) - Method in class com.palantir.transforms.excel.form.assertion.AssertionSuccess
- AdjacentCellAssertion - Interface in com.palantir.transforms.excel.form.cellvalue
-
A
CellAssertion
that succeeds if the value in another cell with a position defined relative to theCellValue.location()
is within a set of allowed values. - AdjacentCellAssertion.Builder - Class in com.palantir.transforms.excel.form.cellvalue
-
Builder for creating an instance of
AdjacentCellAssertion
. - allowedValues() - Method in interface com.palantir.transforms.excel.form.cellvalue.AdjacentCellAssertion
-
The set of acceptable values for the cell with location
AdjacentCellAssertion.rowOffset()
,AdjacentCellAssertion.columnOffset()
relative to theCellValue.location()
. - anchor() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.Checkbox
- Anchor - Interface in com.palantir.transforms.excel.form.checkboxvalue
- AssertionFailure - Class in com.palantir.transforms.excel.form.assertion
- AssertionFailure(String) - Constructor for class com.palantir.transforms.excel.form.assertion.AssertionFailure
- AssertionFailureException - Exception in com.palantir.transforms.excel.form.assertion
- AssertionFailureException(Collection<AssertionFailure>) - Constructor for exception com.palantir.transforms.excel.form.assertion.AssertionFailureException
- AssertionResult - Interface in com.palantir.transforms.excel.form.assertion
- AssertionResult.Visitor<T> - Interface in com.palantir.transforms.excel.form.assertion
- assertions() - Method in interface com.palantir.transforms.excel.form.cellvalue.CellValue
-
Assertions that must all return an instance of
AssertionSuccess
for a value to be extracted. - assertions() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.CheckboxValue
- AssertionSuccess - Class in com.palantir.transforms.excel.form.assertion
- AssertionSuccess() - Constructor for class com.palantir.transforms.excel.form.assertion.AssertionSuccess
B
- bottomRightCellName() - Method in interface com.palantir.transforms.excel.table.MultilayerMergedHeaderExtractor
-
The bottom-right cell of the header.
- builder() - Static method in interface com.palantir.transforms.excel.form.cellvalue.AdjacentCellAssertion
-
Create an
AdjacentCellAssertion.Builder
for constructing an instance of this class. - builder() - Static method in interface com.palantir.transforms.excel.form.cellvalue.CellValue
-
Create a
CellValue.Builder
for constructing an instance of this class. - builder() - Static method in interface com.palantir.transforms.excel.form.checkboxvalue.CheckboxValue
- builder() - Static method in interface com.palantir.transforms.excel.form.checkboxvalue.IdCheckboxSpecifier
- builder() - Static method in interface com.palantir.transforms.excel.form.FormParser
-
Create a
FormParser.Builder
for constructing an instance of this class. - builder() - Static method in interface com.palantir.transforms.excel.form.VmlShape
- builder() - Static method in interface com.palantir.transforms.excel.table.Header
-
Create a
Header.Builder
for constructing an instance of this class. - builder() - Static method in interface com.palantir.transforms.excel.table.MultilayerMergedHeaderExtractor
-
Create a builder for constructing an instance of this class.
- builder() - Static method in interface com.palantir.transforms.excel.table.SimpleHeaderExtractor
-
Create a builder for constructing an instance of this class.
- builder() - Static method in interface com.palantir.transforms.excel.table.TableParser
-
Create a
TableParser.Builder
for constructing an instance of this class. - builder() - Static method in class com.palantir.transforms.excel.TransformsExcelParser
-
Create a builder for constructing an instance of
TransformsExcelParser
with customized settings and/or multiple outputs. - builder() - Static method in interface com.palantir.transforms.excel.WorkbookWithMetadata
- Builder() - Constructor for class com.palantir.transforms.excel.form.cellvalue.AdjacentCellAssertion.Builder
- Builder() - Constructor for class com.palantir.transforms.excel.form.cellvalue.CellValue.Builder
- Builder() - Constructor for class com.palantir.transforms.excel.form.checkboxvalue.CheckboxValue.Builder
- Builder() - Constructor for class com.palantir.transforms.excel.form.checkboxvalue.IdCheckboxSpecifier.Builder
- Builder() - Constructor for class com.palantir.transforms.excel.form.FormParser.Builder
- Builder() - Constructor for class com.palantir.transforms.excel.form.VmlShape.Builder
- Builder() - Constructor for class com.palantir.transforms.excel.table.Header.Builder
- Builder() - Constructor for class com.palantir.transforms.excel.table.MultilayerMergedHeaderExtractor.Builder
- Builder() - Constructor for class com.palantir.transforms.excel.table.SimpleHeaderExtractor.Builder
- Builder() - Constructor for class com.palantir.transforms.excel.table.TableParser.Builder
- Builder() - Constructor for class com.palantir.transforms.excel.TransformsExcelParser.Builder
- Builder() - Constructor for class com.palantir.transforms.excel.WorkbookWithMetadata.Builder
C
- canBeMissing() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.IdCheckboxSpecifier
-
A setting that controls whether it is acceptable for the checkbox with the specified
IdCheckboxSpecifier.id()
to be missing. - carryForward() - Method in interface com.palantir.transforms.excel.table.MultilayerMergedHeaderExtractor
-
Treat an empty cell as if it had the value of the previous non-empty cell in the row, even if it is not actually merged with that previous cell.
- caseNormalizationOption() - Method in interface com.palantir.transforms.excel.table.MultilayerMergedHeaderExtractor
-
Defaults to
CaseNormalizationOption.DO_NOT_NORMALIZE
. - caseNormalizationOption() - Method in interface com.palantir.transforms.excel.table.SimpleHeaderExtractor
-
Defaults to
CaseNormalizationOption.DO_NOT_NORMALIZE
. - CaseNormalizationOption - Enum Class in com.palantir.transforms.excel.table
-
A setting to control the behavior for normalizing case in column names automatically inferred from a header in the input Excel data.
- CellAssertion - Interface in com.palantir.transforms.excel.form.cellvalue
-
An assertion checked by
CellValue
in order to ensure that extracted data matches expectations. - CellValue - Interface in com.palantir.transforms.excel.form.cellvalue
- CellValue.Builder - Class in com.palantir.transforms.excel.form.cellvalue
-
Builder for creating an instance of
CellValue
. - check() - Method in interface com.palantir.transforms.excel.form.cellvalue.AdjacentCellAssertion
-
Ensure that the instance of this class is valid at construction time.
- check() - Method in class com.palantir.transforms.excel.TransformsExcelParser
- check(WorkbookWithMetadata, Sheet, Checkbox) - Method in interface com.palantir.transforms.excel.form.checkboxvalue.CheckboxAssertion
- check(WorkbookWithMetadata, Sheet, Checkbox) - Method in class com.palantir.transforms.excel.form.checkboxvalue.OverlapsCellAssertion
- check(WorkbookWithMetadata, Sheet, Location) - Method in interface com.palantir.transforms.excel.form.cellvalue.AdjacentCellAssertion
- check(WorkbookWithMetadata, Sheet, Location) - Method in interface com.palantir.transforms.excel.form.cellvalue.CellAssertion
- check(WorkbookWithMetadata, Sheet, Location) - Method in class com.palantir.transforms.excel.form.cellvalue.ValueInAssertion
- Checkbox - Interface in com.palantir.transforms.excel.form.checkboxvalue
- CheckboxAssertion - Interface in com.palantir.transforms.excel.form.checkboxvalue
-
An assertion checked by
CheckboxValue
in order to ensure that extracted data matches expectations. - CheckboxSpecifier - Interface in com.palantir.transforms.excel.form.checkboxvalue
-
A function that defines the behavior for getting the checked state of a checkbox.
- CheckboxValue - Interface in com.palantir.transforms.excel.form.checkboxvalue
-
A
ValueExtractor
for extracting the checked state of a checkbox. - CheckboxValue.Builder - Class in com.palantir.transforms.excel.form.checkboxvalue
- clientData() - Method in interface com.palantir.transforms.excel.form.VmlShape
- column() - Method in interface com.palantir.transforms.excel.form.Location
-
0-indexed column.
- columnNameToType() - Method in interface com.palantir.transforms.excel.Parser
- columnNameToType() - Method in interface com.palantir.transforms.excel.table.TableParser
-
Defines that the metadata columns
_row_number_in_sheet
,_row_number_in_table
should be integers in the final output. - columnOffset() - Method in interface com.palantir.transforms.excel.form.cellvalue.AdjacentCellAssertion
-
Column offset from the
CellValue.location()
. - com.palantir.transforms.excel - package com.palantir.transforms.excel
-
A Java transforms library for efficiently converting from a
Dataset<PortableFile>
containing Excel files to one or more instances ofDataset<Row>
that can be written to multiple output datasets in a single transform. - com.palantir.transforms.excel.form - package com.palantir.transforms.excel.form
-
FormParser
and related classes. - com.palantir.transforms.excel.form.assertion - package com.palantir.transforms.excel.form.assertion
- com.palantir.transforms.excel.form.cellvalue - package com.palantir.transforms.excel.form.cellvalue
-
CellValue
and related classes. - com.palantir.transforms.excel.form.checkboxvalue - package com.palantir.transforms.excel.form.checkboxvalue
-
CheckboxValue
and related classes. - com.palantir.transforms.excel.functions - package com.palantir.transforms.excel.functions
-
Functional interfaces and their implementations that are relevant for multiple
Parser
types. - com.palantir.transforms.excel.table - package com.palantir.transforms.excel.table
-
TableParser
and related classes. - com.palantir.transforms.excel.utils - package com.palantir.transforms.excel.utils
-
Generally useful functions for consumers of this library (some of which are also used by the library internally).
- CONVERT_TO_LOWERCASE - Enum constant in enum class com.palantir.transforms.excel.table.CaseNormalizationOption
- CONVERT_TO_UPPERCASE - Enum constant in enum class com.palantir.transforms.excel.table.CaseNormalizationOption
- currentRow() - Method in interface com.palantir.transforms.excel.table.ShouldStopParameters
D
- dataframeForKey(String) - Method in class com.palantir.transforms.excel.ParseResult
-
Get the result dataframe associated with a key, as configured when creating the
TransformsExcelParser
object using the methodsImmutableTransformsExcelParser.Builder.putKeyToParser(String, Parser)
. - dataLeftmostColumnNumber() - Method in interface com.palantir.transforms.excel.table.Header
-
The 0-indexed column number for the left bound (inclusive) of the table.
- dataRightmostColumnNumber() - Method in interface com.palantir.transforms.excel.table.Header
-
The 0-indexed column number for the right bound (inclusive) of the table.
- dataTopRowNumber() - Method in interface com.palantir.transforms.excel.table.Header
-
The 0-indexed row number for the first data row.
- DecimalFormatNumericCellStringifier - Class in com.palantir.transforms.excel.functions
-
A
NumericCellStringifier
that usesNumberFormat.format(double)
. - DecimalFormatNumericCellStringifier(String) - Constructor for class com.palantir.transforms.excel.functions.DecimalFormatNumericCellStringifier
- decryptionResultDataframe() - Method in class com.palantir.transforms.excel.ParseResult
-
Details about successful and failed attempts to open password-protected files, if a
PasswordProvider
was included as part of the configuration of theTransformsExcelParser
that generated thisParseResult
. - defaultNumericCellStringifier() - Static method in interface com.palantir.transforms.excel.functions.NumericCellStringifier
-
Use
DecimalFormat
with a format string of "0.#############", which will keep data up to thirteen decimal places. - DO_NOT_NORMALIZE - Enum constant in enum class com.palantir.transforms.excel.table.CaseNormalizationOption
- drawings() - Method in interface com.palantir.transforms.excel.form.ValueExtractorParameters
- Drawings - Interface in com.palantir.transforms.excel.form
-
A collection of XML
VmlShape
objects extracted from a sheet's legacyDrawing element as returned fromCTWorksheet.getLegacyDrawing()
.
E
- equals(Object) - Method in class com.palantir.transforms.excel.Field
- equals(Object) - Method in class com.palantir.transforms.excel.KeyedParsedRecord
- equals(Object) - Method in class com.palantir.transforms.excel.ParsedRecord
- equals(Object) - Method in class com.palantir.transforms.excel.Schema
- errorDataframe() - Method in class com.palantir.transforms.excel.ParseResult
-
A
Dataset<Row>
containing information about errors that occurred during parsing. - extract(Sheet) - Static method in interface com.palantir.transforms.excel.form.Drawings
- extractHeader(Sheet) - Method in interface com.palantir.transforms.excel.table.HeaderExtractor
- extractHeader(Sheet) - Method in interface com.palantir.transforms.excel.table.MultilayerMergedHeaderExtractor
- extractHeader(Sheet) - Method in interface com.palantir.transforms.excel.table.SimpleHeaderExtractor
- extractRows(Sheet, Header, NumericCellStringifier) - Method in interface com.palantir.transforms.excel.table.RowExtractor
- extractRows(Sheet, Header, NumericCellStringifier) - Method in interface com.palantir.transforms.excel.table.SimpleRowExtractor
- extractValue(ValueExtractorParameters) - Method in interface com.palantir.transforms.excel.form.cellvalue.CellValue
- extractValue(ValueExtractorParameters) - Method in interface com.palantir.transforms.excel.form.checkboxvalue.CheckboxValue
- extractValue(ValueExtractorParameters) - Method in interface com.palantir.transforms.excel.form.ValueExtractor
F
- failedAssertions() - Method in exception com.palantir.transforms.excel.form.assertion.AssertionFailureException
- Field - Class in com.palantir.transforms.excel
- fieldName() - Method in interface com.palantir.transforms.excel.form.FieldSpec
-
Column name to assign to the value in the output dataframe.
- fieldNames() - Method in class com.palantir.transforms.excel.Schema
- fieldNames() - Method in interface com.palantir.transforms.excel.table.Header
-
Column names such that the first item of the list is the column name associated with
Header.dataLeftmostColumnNumber()
and the last item of the list is the column name associated withHeader.dataRightmostColumnNumber()
. - fields() - Method in class com.palantir.transforms.excel.ParsedRecord
- FieldSpec - Interface in com.palantir.transforms.excel.form
-
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.
- fieldSpecs() - Method in interface com.palantir.transforms.excel.form.FormParser
- filePath() - Method in interface com.palantir.transforms.excel.WorkbookWithMetadata
- FormParser - Interface in com.palantir.transforms.excel.form
-
A
Parser
for extracting data in a non-tabular format. - FormParser.Builder - Class in com.palantir.transforms.excel.form
-
A builder for creating instances of
FormParser
. - fromCol() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.Anchor
- fromColDx() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.Anchor
- fromRow() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.Anchor
- fromRowDy() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.Anchor
G
- getAddressOfMergedCell(Sheet, CellAddress) - Static method in class com.palantir.transforms.excel.utils.WorkbookUtils
- getCell(Sheet) - Method in interface com.palantir.transforms.excel.form.Location
- getCellValuesIncludingNulls(Row, int, int, NumericCellStringifier) - Static method in class com.palantir.transforms.excel.utils.WorkbookUtils
- getCellValuesIncludingNullsRespectingMerges(Sheet, Row, int, int) - Static method in class com.palantir.transforms.excel.utils.WorkbookUtils
- getCheckboxData(WorkbookWithMetadata, Sheet, Drawings) - Method in interface com.palantir.transforms.excel.form.checkboxvalue.CheckboxSpecifier
- getCheckboxData(WorkbookWithMetadata, Sheet, Drawings) - Method in interface com.palantir.transforms.excel.form.checkboxvalue.IdCheckboxSpecifier
- getCheckboxData(WorkbookWithMetadata, Sheet, Drawings) - Method in interface com.palantir.transforms.excel.form.checkboxvalue.LocationCheckboxSpecifier
- getFailures(Collection<AssertionResult>) - Static method in interface com.palantir.transforms.excel.form.assertion.AssertionResult
- getMessage() - Method in class com.palantir.transforms.excel.form.assertion.AssertionFailure
- getMessage() - Method in exception com.palantir.transforms.excel.form.assertion.AssertionFailureException
- getNumericCellValueAsString(Cell) - Method in class com.palantir.transforms.excel.functions.DecimalFormatNumericCellStringifier
- getNumericCellValueAsString(Cell) - Method in class com.palantir.transforms.excel.functions.JavaToStringNumericCellStringifier
- getNumericCellValueAsString(Cell) - Method in interface com.palantir.transforms.excel.functions.NumericCellStringifier
-
Convert the value of a
Cell
that is known to contain a numeric value without date/time formatting to aString
. - getValueAsString(Cell) - Static method in class com.palantir.transforms.excel.utils.WorkbookUtils
- getValueAsString(Cell, NumericCellStringifier) - Static method in class com.palantir.transforms.excel.utils.WorkbookUtils
H
- hashCode() - Method in class com.palantir.transforms.excel.Field
- hashCode() - Method in class com.palantir.transforms.excel.KeyedParsedRecord
- hashCode() - Method in class com.palantir.transforms.excel.ParsedRecord
- hashCode() - Method in class com.palantir.transforms.excel.Schema
- Header - Interface in com.palantir.transforms.excel.table
-
Information used by a
RowExtractor
to identify where tabular data is located and the names associated with each column. - Header.Builder - Class in com.palantir.transforms.excel.table
-
A builder for creating instances of
Header
. - headerExtractor() - Method in interface com.palantir.transforms.excel.table.TableParser
-
Defaults to a
SimpleHeaderExtractor
with default configuration, as appropriate when the first row of the sheet is the header. - HeaderExtractor - Interface in com.palantir.transforms.excel.table
-
A function that, given a sheet, returns a
Header
, which guides subsequent extraction of rows with aRowExtractor
.
I
- id() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.IdCheckboxSpecifier
-
The ID of the checkbox to extract data from.
- id() - Method in interface com.palantir.transforms.excel.form.VmlShape
- IdCheckboxSpecifier - Interface in com.palantir.transforms.excel.form.checkboxvalue
-
A
CheckboxSpecifier
for extracting data from a checkbox with a user-visible ID and ObjectType=Pict. - IdCheckboxSpecifier.Builder - Class in com.palantir.transforms.excel.form.checkboxvalue
- includeFileModifiedTimestamp() - Method in class com.palantir.transforms.excel.TransformsExcelParser
-
A default-true setting that controls whether a
_file_modified_timestamp
column should be included in output dataframes. - IncrementalUtils - Class in com.palantir.transforms.excel.utils
-
Functions that are convenient when using the transforms-excel-parser library in incremental pipelines.
- isChecked() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.Checkbox
J
- JavaToStringNumericCellStringifier - Class in com.palantir.transforms.excel.functions
-
A
NumericCellStringifier
that usesDouble.toString(double)
. - JavaToStringNumericCellStringifier() - Constructor for class com.palantir.transforms.excel.functions.JavaToStringNumericCellStringifier
K
- key() - Method in class com.palantir.transforms.excel.KeyedParsedRecord
- KeyedParsedRecord - Class in com.palantir.transforms.excel
-
This class is an implementation detail that is only public because being public is a requirement for Kryo serialization.
- keyToDataframe() - Method in class com.palantir.transforms.excel.ParseResult
- keyToParser() - Method in class com.palantir.transforms.excel.TransformsExcelParser
-
A mapping between keys (arbitrary strings) and their associated
Parser
.
L
- left(int, String...) - Static method in interface com.palantir.transforms.excel.form.cellvalue.AdjacentCellAssertion
- location() - Method in interface com.palantir.transforms.excel.form.cellvalue.CellValue
-
Location of the cell to extract a value from.
- location() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.LocationCheckboxSpecifier
-
The cell location used to identify the checkbox to extract data from.
- Location - Interface in com.palantir.transforms.excel.form
-
A location within a
Sheet
as defined by a 0-indexed row, column pair. - LocationCheckboxSpecifier - Interface in com.palantir.transforms.excel.form.checkboxvalue
-
A
CheckboxSpecifier
for extracting data from a checkbox without an ID and with ObjectType=CheckBox.
M
- maxByteArraySize() - Method in class com.palantir.transforms.excel.TransformsExcelParser
-
A setting that needs to be set to a large value in order to open large Excel files.
- minInflateRatio() - Method in class com.palantir.transforms.excel.TransformsExcelParser
-
A setting that controls the lowest acceptable size ratio of compressed to uncompressed files when attempting to open an xlsx or xlsm file (these file types are actually zip archives).
- MultilayerMergedHeaderExtractor - Interface in com.palantir.transforms.excel.table
-
A
HeaderExtractor
for extracting complex headers consisting of multiple rows with a hierarchy of merged cells. - MultilayerMergedHeaderExtractor.Builder - Class in com.palantir.transforms.excel.table
-
A builder for constructing an instance of
MultilayerMergedHeaderExtractor
.
N
- name() - Method in class com.palantir.transforms.excel.Field
- numericCellStringifier() - Method in interface com.palantir.transforms.excel.form.FormParser
- numericCellStringifier() - Method in interface com.palantir.transforms.excel.form.ValueExtractorParameters
- numericCellStringifier() - Method in interface com.palantir.transforms.excel.table.TableParser
- NumericCellStringifier - Interface in com.palantir.transforms.excel.functions
-
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).
O
- objectType() - Method in interface com.palantir.transforms.excel.form.VmlShape
- of(int, int, int, int, int, int, int, int) - Static method in interface com.palantir.transforms.excel.form.checkboxvalue.Anchor
- of(Location) - Static method in interface com.palantir.transforms.excel.form.checkboxvalue.LocationCheckboxSpecifier
-
Create an instance of this class from a
Location
. - of(Parser) - Static method in class com.palantir.transforms.excel.TransformsExcelParser
-
Create a
TransformsExcelParser
with default configuration from a singleParser
. - of(Parser, PasswordProvider) - Static method in class com.palantir.transforms.excel.TransformsExcelParser
-
Create a
TransformsExcelParser
with default configuration from a singleParser
andPasswordProvider
. - of(Iterable<Field>) - Static method in class com.palantir.transforms.excel.ParsedRecord
- of(String) - Static method in interface com.palantir.transforms.excel.form.checkboxvalue.IdCheckboxSpecifier
-
Create an instance of this class from a checkbox ID string.
- of(String) - Static method in interface com.palantir.transforms.excel.form.Location
-
Create from a
String
cell name, such as "A1". - of(String...) - Static method in class com.palantir.transforms.excel.form.cellvalue.ValueInAssertion
- of(String, ValueExtractor) - Static method in interface com.palantir.transforms.excel.form.FieldSpec
- of(String, String) - Static method in class com.palantir.transforms.excel.Field
- overlaps(Location) - Method in interface com.palantir.transforms.excel.form.checkboxvalue.Anchor
- OverlapsCellAssertion - Class in com.palantir.transforms.excel.form.checkboxvalue
-
An assertion that the location of a checkbox drawing on the sheet overlaps with a specific cell.
- OverlapsCellAssertion(Location) - Constructor for class com.palantir.transforms.excel.form.checkboxvalue.OverlapsCellAssertion
P
- parse(String) - Static method in interface com.palantir.transforms.excel.form.checkboxvalue.Anchor
-
Produce an anchor from a string as represented inside Excel's XML.
- parse(Dataset<PortableFile>) - Method in class com.palantir.transforms.excel.TransformsExcelParser
-
Process the input dataset and return a
ParseResult
. - parsedRecord() - Method in class com.palantir.transforms.excel.KeyedParsedRecord
- ParsedRecord - Class in com.palantir.transforms.excel
- Parser - Interface in com.palantir.transforms.excel
-
A high-level abstraction over the idea of taking a
WorkbookWithMetadata
and returning some data. - ParseResult - Class in com.palantir.transforms.excel
-
The return value from
TransformsExcelParser.parse(Dataset)
. - ParseResult() - Constructor for class com.palantir.transforms.excel.ParseResult
- parseWorkbook(WorkbookWithMetadata) - Method in interface com.palantir.transforms.excel.form.FormParser
- parseWorkbook(WorkbookWithMetadata) - Method in interface com.palantir.transforms.excel.Parser
-
Return a collection of parsed records.
- parseWorkbook(WorkbookWithMetadata) - Method in interface com.palantir.transforms.excel.table.TableParser
- passwordProvider() - Method in class com.palantir.transforms.excel.TransformsExcelParser
-
A function to provide a set of passwords to try, given a workbook.
- PasswordProvider - Interface in com.palantir.transforms.excel
-
A function to provide a set of passwords to use to try to decrypt a file, given the file path.
- passwordsToTry(String) - Method in interface com.palantir.transforms.excel.PasswordProvider
- predicate() - Method in interface com.palantir.transforms.excel.table.SimpleHeaderExtractor
-
After skipping
SimpleHeaderExtractor.rowsToSkip()
, the first subsequent row for which this function returns true will be treated as the header. - previousRow() - Method in interface com.palantir.transforms.excel.table.ShouldStopParameters
R
- RegexSubstringMatchingSheetSelector - Class in com.palantir.transforms.excel.functions
-
A sheet selector that matches all sheets whose names contain a match for the specified regular expression.
- RegexSubstringMatchingSheetSelector(String) - Constructor for class com.palantir.transforms.excel.functions.RegexSubstringMatchingSheetSelector
- relative(Location, int, int) - Static method in interface com.palantir.transforms.excel.form.Location
-
Create a new Location relative to an existing Location.
- returnNullOnAssertionFailure() - Method in interface com.palantir.transforms.excel.form.cellvalue.CellValue
-
Setting that controls whether
CellValue.extractValue(ValueExtractorParameters)
should return null instead of raising an error if one of theCellValue.assertions()
returns an instance ofAssertionFailure
. - row() - Method in interface com.palantir.transforms.excel.form.Location
-
0-indexed row.
- rowExtractor() - Method in interface com.palantir.transforms.excel.table.TableParser
-
Defaults to a
SimpleRowExtractor
with noStopCondition
, so will extract data from theHeader.dataTopRowNumber()
until the end of the sheet. - RowExtractor - Interface in com.palantir.transforms.excel.table
-
A function that, given the
Header
returned from aHeaderExtractor
and aSheet
returned from aSheetSelector
, extracts data. - rowNumberInSheet() - Method in interface com.palantir.transforms.excel.table.ShouldStopParameters
-
1-indexed row number in the sheet.
- rowNumberInTable() - Method in interface com.palantir.transforms.excel.table.ShouldStopParameters
-
1-indexed row number in the table.
- rowOffset() - Method in interface com.palantir.transforms.excel.form.cellvalue.AdjacentCellAssertion
-
Row offset from the
CellValue.location()
. - RowPredicate - Interface in com.palantir.transforms.excel.table
- rowsToSkip() - Method in interface com.palantir.transforms.excel.table.SimpleHeaderExtractor
-
A static number of rows at the top of the sheet to ignore.
S
- Schema - Class in com.palantir.transforms.excel
-
This class is an implementation detail that is only public because being public is a requirement for Kryo serialization.
- selectSheets(WorkbookWithMetadata) - Method in class com.palantir.transforms.excel.functions.RegexSubstringMatchingSheetSelector
- selectSheets(WorkbookWithMetadata) - Method in interface com.palantir.transforms.excel.functions.SheetSelector
- shapes() - Method in interface com.palantir.transforms.excel.form.Drawings
- sheet() - Method in interface com.palantir.transforms.excel.form.ValueExtractorParameters
- sheet() - Method in interface com.palantir.transforms.excel.table.ShouldStopParameters
- SheetRowNumberStopCondition - Class in com.palantir.transforms.excel.table
-
A simple
StopCondition
that tells aSimpleRowExtractor
to stop extracting data after a specific row in the sheet. - SheetRowNumberStopCondition(int) - Constructor for class com.palantir.transforms.excel.table.SheetRowNumberStopCondition
- sheetSelector() - Method in interface com.palantir.transforms.excel.form.FormParser
- sheetSelector() - Method in interface com.palantir.transforms.excel.table.TableParser
-
Defaults to a
SheetSelector
that will include all sheets in the file. - SheetSelector - Interface in com.palantir.transforms.excel.functions
-
A function that, given a
WorkbookWithMetadata
, returns a collection ofSheet
objects to extract data from. - shouldStop(ShouldStopParameters) - Method in class com.palantir.transforms.excel.table.SheetRowNumberStopCondition
- shouldStop(ShouldStopParameters) - Method in interface com.palantir.transforms.excel.table.StopCondition
- ShouldStopParameters - Interface in com.palantir.transforms.excel.table
-
Information passed to
StopCondition.shouldStop(ShouldStopParameters)
. - SimpleHeaderExtractor - Interface in com.palantir.transforms.excel.table
-
A
HeaderExtractor
appropriate for extracting a single-row header. - SimpleHeaderExtractor.Builder - Class in com.palantir.transforms.excel.table
-
A builder for constructing an instance of
SimpleHeaderExtractor
. - SimpleRowExtractor - Interface in com.palantir.transforms.excel.table
-
The default implementation of
RowExtractor
. - singleResult() - Method in class com.palantir.transforms.excel.ParseResult
-
A convenience method for when only one parser is passed.
- specifier() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.CheckboxValue
- stopCondition() - Method in interface com.palantir.transforms.excel.table.SimpleRowExtractor
-
The
StopCondition
used when iterating over the rows in the sheet. - StopCondition - Interface in com.palantir.transforms.excel.table
-
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.
- structSchema() - Method in class com.palantir.transforms.excel.Schema
T
- TableParser - Interface in com.palantir.transforms.excel.table
-
A
Parser
for extracting tabular data from Excel. - TableParser.Builder - Class in com.palantir.transforms.excel.table
-
A builder for creating instances of
TableParser
. - toCol() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.Anchor
- toColDx() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.Anchor
- topLeftCellName() - Method in interface com.palantir.transforms.excel.table.MultilayerMergedHeaderExtractor
-
The top-left cell of the header.
- toRow() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.Anchor
- toRowDy() - Method in interface com.palantir.transforms.excel.form.checkboxvalue.Anchor
- TransformsExcelParser - Class in com.palantir.transforms.excel
-
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. - TransformsExcelParser() - Constructor for class com.palantir.transforms.excel.TransformsExcelParser
- TransformsExcelParser.Builder - Class in com.palantir.transforms.excel
-
A builder for constructing an instance of
TransformsExcelParser
with customized settings and/or multiple outputs.
V
- value() - Method in class com.palantir.transforms.excel.Field
- valueExtractor() - Method in interface com.palantir.transforms.excel.form.FieldSpec
-
Logic for extracting the value of the field.
- ValueExtractor - Interface in com.palantir.transforms.excel.form
-
Logic for extracting a value from a form-style Excel sheet, as used in a
FieldSpec
. - ValueExtractorParameters - Interface in com.palantir.transforms.excel.form
-
Information passed to
ValueExtractor.extractValue(ValueExtractorParameters)
. - ValueInAssertion - Class in com.palantir.transforms.excel.form.cellvalue
-
A
CellAssertion
that succeeds if the value in a cell is within a set of allowed values. - valueOf(String) - Static method in enum class com.palantir.transforms.excel.table.CaseNormalizationOption
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.palantir.transforms.excel.table.CaseNormalizationOption
-
Returns an array containing the constants of this enum class, in the order they are declared.
- visit(AssertionFailure) - Method in interface com.palantir.transforms.excel.form.assertion.AssertionResult.Visitor
- visit(AssertionSuccess) - Method in interface com.palantir.transforms.excel.form.assertion.AssertionResult.Visitor
- VmlShape - Interface in com.palantir.transforms.excel.form
- VmlShape.Builder - Class in com.palantir.transforms.excel.form
W
- withParquetCompatibleFieldNames() - Method in class com.palantir.transforms.excel.Schema
- workbook() - Method in interface com.palantir.transforms.excel.WorkbookWithMetadata
- WorkbookUtils - Class in com.palantir.transforms.excel.utils
-
Functions that are generally convenient when working with
Workbook
objects. - workbookWithMetadata() - Method in interface com.palantir.transforms.excel.form.ValueExtractorParameters
- WorkbookWithMetadata - Interface in com.palantir.transforms.excel
-
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. - WorkbookWithMetadata.Builder - Class in com.palantir.transforms.excel
- writeAppendingIfPossible(FilesModificationType, Dataset<Row>, FoundryOutput) - Static method in class com.palantir.transforms.excel.utils.IncrementalUtils
-
Write new data to the output, appending if possible.
All Classes and Interfaces|All Packages|Serialized Form