doc.transformers.se_tpb_dtbMerger.html Maven / Gradle / Ivy
se_tpb_dtbSplitterMerger.merge
Transformer documentation: se_tpb_dtbSplitterMerger.merge
Transformer Purpose
The purpose of this transformer is to merge Daisy multivolume DTB file sets.
In its current version the transformer supports merging Daisy 2.02, Z39.86-2002 and Z39.86-2005 multivolume DTB file sets.
The programmatic flow of this transformer in summary:
- Try to retrieve a collection with NCC or OPF files using the input directory path.
- Try to retrieve Daisy version using one of the NCC or OPF files.
- Depending on the Daisy version instantiate an appropriate extension of the abstarct class
se_tpb_dtbSplitterMerger.merge.DtbMerger:
se_tpb_dtbSplitterMerger.merge.DtbMerger202 for Daisy 2.02se_tpb_dtbSplitterMerger.merge.DtbMerger3 for Z39.86
and initialize merging.
- When merging a Daisy 2.02 multivolume DTB file set, merged navigation files (NCC and full text) are being built using the respective subvolume navigation files.
- All files from the subvolumes except for prompt and distribution information files are copied to the target directory.
Input Requirements
This transformer is meant for merging Daisy 2.02, Z39.86-2002 or Z39.86-2005 multivolume DTB file sets.
If a collection with NCC or OPF files or Daisy version cannot be retrieved, an exception will be thrown.
Output
On success
In the output directory there will be a merged version of the Daisy multivolume DTB file set.
On error
On error, this transformer will send a fatal message, then throw an exception and abort.
See further Parameters.
Configuration/Customization
Parameters (tdf)
- multiVolumeDTBPath
- A path to a Daisy multivolume DTB file set's main directory. The directory should contain subdirectories with the book's subvolumes.
- outDirPath
- An output directory where the book's merged version will be saved.
- userPrompt
- Standard output prompts, e.g. file overwriting approval.
- keepInput
- Specifies whether the input files should be kept.
- keepRedundant
- Specifies whether files such as prompt files or distInfo.dinf should be kept.
Extended configurability
None.
Further development
The abstract class se_tpb_dtbSplitterMerger.merge.DtbMerger implements base functionality needed for merging multivolume DTB Daisy file sets, that can be used or overridden by its subclasses. Current extensions are:
se_tpb_dtbSplitterMerger.merge.DtbMerger202se_tpb_dtbSplitterMerger.merge.DtbMerger3
The abstract class se_tpb_dtbSplitterMerger.merge.DtbMerger may be extended to support new types of Daisy DTB file sets when they come up.
Dependencies
- none
Author
Piotr Kiernicki, TPB
Licensing
LGPL