A saved, reusable column-to-field mapping for a TableUploader, letting a user re-run the same spreadsheet import without re-selecting which source column feeds each destination field each time. Holds the column mappings, any extra import options (such as the starting row or task size), and the configured before/after and sanity check action handlers. Instances are persisted per organisation and uploader as XML, serialised via XStream as a "fieldMapping" element, and are loaded back by name when a saved import is run.

Group: Table Uploads


Properties

PropertyReturnsDescription
actionsList<ActionHandlerConfigBean>The before/after action handlers configured to run for imports using this mapping. May be null if none are configured.
mappingsMap<String,List<Integer>>The saved column mappings, keyed by destination field name, with each value the list of zero-based source column indexes mapped to that field. May be null if the mapping has no columns configured yet.
nameStringThe unique, path-safe identifier this mapping is saved and looked up under for its table uploader. Never null for a saved mapping.
optionsMap<String,String>Extra import options saved with this mapping, such as the starting row or task batch size, keyed by option name. May be null if no extra options were saved.
rowSanityCheckActionsList<ActionHandlerConfigBean>The row-level sanity check action handlers configured for imports using this mapping, run against each row before it is processed. May be null if none are configured.
titleStringThe user-facing display label for this saved mapping, shown when a user picks a saved mapping to re-use.
uploadSanityCheckActionsList<ActionHandlerConfigBean>The upload-level sanity check action handlers configured for imports using this mapping, run once against the whole upload before processing begins. May be null if none are configured.

Methods

getName()

Returns: String

The unique, path-safe identifier this mapping is saved and looked up under for its table uploader. Never null for a saved mapping.

getTitle()

Returns: String

The user-facing display label for this saved mapping, shown when a user picks a saved mapping to re-use.

getMappings()

Returns: Map<String,List<Integer>>

The saved column mappings, keyed by destination field name, with each value the list of zero-based source column indexes mapped to that field. May be null if the mapping has no columns configured yet.

getOptions()

Returns: Map<String,String>

Extra import options saved with this mapping, such as the starting row or task batch size, keyed by option name. May be null if no extra options were saved.

getActions()

Returns: List<ActionHandlerConfigBean>

The before/after action handlers configured to run for imports using this mapping. May be null if none are configured.

getRowSanityCheckActions()

Returns: List<ActionHandlerConfigBean>

The row-level sanity check action handlers configured for imports using this mapping, run against each row before it is processed. May be null if none are configured.

getUploadSanityCheckActions()

Returns: List<ActionHandlerConfigBean>

The upload-level sanity check action handlers configured for imports using this mapping, run once against the whole upload before processing begins. May be null if none are configured.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.