org.xwiki.refactoring.splitter.criterion.naming

Class HeadingNameNamingCriterion

java.lang.Object

org.xwiki.refactoring.splitter.criterion.naming.HeadingNameNamingCriterion

All Implemented Interfaces:

NamingCriterion

public class HeadingNameNamingCriterion
extends Object
implements NamingCriterion

A NamingCriterion based on the opening heading (if present) of the document.

Since:

1.9M1

Version:

$Id: ffada972dabd2d7cd2588bf96589de4bbdcbc9a0 $

Field Summary

Fields inherited from interface org.xwiki.refactoring.splitter.criterion.naming.NamingCriterion

INDEX_SEPERATOR

Constructor Summary

Constructors

Constructor and Description
HeadingNameNamingCriterion(String baseDocumentName, DocumentAccessBridge docBridge, org.xwiki.rendering.renderer.BlockRenderer plainSyntaxRenderer, boolean prependBasePageName) Constructs a new HeadingNameNamingCriterion.

Method Summary

Modifier and Type	Method and Description
String	getDocumentName(org.xwiki.rendering.block.XDOM newDoc) Generates a suitable name for the new document represented by 'newDoc' which is a result of the splitting operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeadingNameNamingCriterion

public HeadingNameNamingCriterion(String baseDocumentName,
                                  DocumentAccessBridge docBridge,
                                  org.xwiki.rendering.renderer.BlockRenderer plainSyntaxRenderer,
                                  boolean prependBasePageName)

Constructs a new HeadingNameNamingCriterion.

Parameters:

baseDocumentName - name of the document that is being split.

docBridge - DocumentAccessBridge used to lookup for documents.

plainSyntaxRenderer - the renderer to convert to plain text

prependBasePageName - a flag indicating if each generated page name should be prepended with base page name.

Method Detail

getDocumentName

public String getDocumentName(org.xwiki.rendering.block.XDOM newDoc)

Description copied from interface: NamingCriterion

Generates a suitable name for the new document represented by 'newDoc' which is a result of the splitting operation.

Specified by:

getDocumentName in interface NamingCriterion

Parameters:

newDoc - the XDOM representing the newly split document.

Returns:

the name generated for the new document.