@Role
public interface XDOMOfficeDocumentSplitter
Modifier and Type | Method and Description |
---|---|
Map<TargetDocumentDescriptor,XDOMOfficeDocument> |
split(XDOMOfficeDocument xdomOfficeDocument,
int[] headingLevelsToSplit,
String namingCriterionHint,
org.xwiki.model.reference.DocumentReference baseDocumentReference)
Splits an
XDOMOfficeDocument into multiple XDOMOfficeDocument instances using the provided
heading levels as boundaries. |
Map<TargetDocumentDescriptor,XDOMOfficeDocument> split(XDOMOfficeDocument xdomOfficeDocument, int[] headingLevelsToSplit, String namingCriterionHint, org.xwiki.model.reference.DocumentReference baseDocumentReference) throws OfficeImporterException
XDOMOfficeDocument
into multiple XDOMOfficeDocument
instances using the provided
heading levels as boundaries. The naming Criterion and the base name determines the target wiki pages for the
newly split documents.xdomOfficeDocument
- XDOMOfficeDocument
to be splitheadingLevelsToSplit
- heading levels (1..6) to be used as boundaries. The split process is recursive, if
there are multiple heading levels specified, the original document will be split from the highest heading
level (lowest value >= 1
) first and then the resulting office documents will be re-split from the
next highest heading levelnamingCriterionHint
- naming criterion to be used when producing target page names for the newly split
documents. Currently three schemes are supported:
baseDocumentReference
- base (root) page name to be used when generating target page names for child (newly
split) documentsOfficeImporterException
- if an error occurs while splittingCopyright © 2004–2021 XWiki. All rights reserved.