org.xwiki.refactoring.splitter.criterion.naming

Class PageIndexNamingCriterion

java.lang.Object

org.xwiki.refactoring.splitter.criterion.naming.PageIndexNamingCriterion

All Implemented Interfaces:

NamingCriterion

public class PageIndexNamingCriterion
extends Object
implements NamingCriterion

A NamingCriterion based on the name of the main document being split.

Since:

1.9M1

Version:

$Id: d921937a154f881984c3d640c99de6d548a3905d $

Field Summary

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

INDEX_SEPERATOR

Constructor Summary

Constructors

Constructor and Description
PageIndexNamingCriterion(String baseDocumentName, DocumentAccessBridge docBridge) Constructs a new PageIndexNamingCriterion.

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

PageIndexNamingCriterion

public PageIndexNamingCriterion(String baseDocumentName,
                                DocumentAccessBridge docBridge)

Constructs a new PageIndexNamingCriterion.

Parameters:

baseDocumentName - base name to be used for generating new document names.

docBridge - DocumentAccessBridge used to lookup for documents.

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.