org.xwiki.refactoring.splitter.criterion.naming

Interface NamingCriterion

All Known Implementing Classes:

HeadingNameNamingCriterion, PageIndexNamingCriterion

public interface NamingCriterion

Interface for defining various criteria for naming new documents generated while splitting.

Since:

1.9M1

Version:

$Id: d5bcb1bd44a37622b1e3796596127ff4bb1e993d $

Field Summary

Fields

Modifier and Type	Field and Description
static String	INDEX_SEPERATOR Marker used to separate page indexes.

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.

Field Detail

INDEX_SEPERATOR

static final String INDEX_SEPERATOR

Marker used to separate page indexes.

See Also:

Constant Field Values

Method Detail

getDocumentName

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.

Parameters:

newDoc - the XDOM representing the newly split document.

Returns:

the name generated for the new document.