org.xwiki.refactoring.splitter.criterion

Class HeadingLevelSplittingCriterion

java.lang.Object

org.xwiki.refactoring.splitter.criterion.HeadingLevelSplittingCriterion

All Implemented Interfaces:

SplittingCriterion

public class HeadingLevelSplittingCriterion
extends Object
implements SplittingCriterion

A SplittingCriterion based on the heading levels present in an xwiki document.

Since:

1.9M1

Version:

$Id: fd2e13e199969aa237ebc3a9c2befab2e3e74b7d $

Constructor Summary

Constructors

Constructor and Description
HeadingLevelSplittingCriterion(int[] headingLevels) Constructs a new HeadingLevelSplittingCriterion.

Method Summary

Modifier and Type	Method and Description
boolean	shouldIterate(org.xwiki.rendering.block.Block block, int depth) Limits the recursive tree traversal performed by the DocumentSplitter.
boolean	shouldSplit(org.xwiki.rendering.block.Block block, int depth) Indicates if the sub-tree rooted at the given block should be split into a separate document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeadingLevelSplittingCriterion

public HeadingLevelSplittingCriterion(int[] headingLevels)

Constructs a new HeadingLevelSplittingCriterion.

Parameters:

headingLevels - sorted array of heading levels (ascending)

Method Detail

shouldIterate

public boolean shouldIterate(org.xwiki.rendering.block.Block block,
                             int depth)

Description copied from interface: SplittingCriterion

Limits the recursive tree traversal performed by the DocumentSplitter.

Specified by:

shouldIterate in interface SplittingCriterion

Parameters:

block - current Block being traversed by the document splitter.

depth - depth of this block w.r.t root of the main xdom being split.

Returns:

true if the sub-tree rooted at this block should be traversed further.

shouldSplit

public boolean shouldSplit(org.xwiki.rendering.block.Block block,
                           int depth)

Description copied from interface: SplittingCriterion

Indicates if the sub-tree rooted at the given block should be split into a separate document.

Specified by:

shouldSplit in interface SplittingCriterion

Parameters:

block - current Block being traversed by the document splitter.

depth - depth of this block w.r.t root of the main xdom being split.

Returns:

true if the sub-tree rooted at this block should be split into a separate document.