Package org.xwiki.refactoring.splitter
Interface DocumentSplitter
-
@Role public interface DocumentSplitter
Component interface for splitting aWikiDocument
into multiple documents.- Since:
- 1.9M1
- Version:
- $Id: ffd5a90501d53ce065092a501c4123a4b980fd5b $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<WikiDocument>
split(WikiDocument rootDoc, SplittingCriterion splittingCriterion, NamingCriterion namingCriterion)
Splits the document represented by rootDoc into multiple documents.
-
-
-
Method Detail
-
split
List<WikiDocument> split(WikiDocument rootDoc, SplittingCriterion splittingCriterion, NamingCriterion namingCriterion)
Splits the document represented by rootDoc into multiple documents.- Parameters:
rootDoc
- the rootWikiDocument
which is being split.splittingCriterion
- theSplittingCriterion
to be used for splitting operation.namingCriterion
- theNamingCriterion
to be used to generate document names.- Returns:
- a list of documents representing all the resulting documents. Note that rootDoc will be altered by this method and it will be included in the list of returned documents.
-
-