PageIndexNamingCriterion (XWiki Platform - Refactoring - API 15.4 API)

java.lang.Object
- org.xwiki.refactoring.splitter.criterion.naming.AbstractNamingCriterion
- - org.xwiki.refactoring.splitter.criterion.naming.PageIndexNamingCriterion

All Implemented Interfaces:

NamingCriterion
```
@Component
@Named("mainPageNameAndNumbering")
@InstantiationStrategy(PER_LOOKUP)
public class PageIndexNamingCriterion
extends AbstractNamingCriterion
```
A NamingCriterion based on the name of the main document being split.

Since:

1.9M1

Version:

$Id: dae3d90d790aa761ef7ab9d19acdfb3719df523b $

Field Summary
- Fields inherited from class org.xwiki.refactoring.splitter.criterion.naming.AbstractNamingCriterion
  docBridge, logger
- Fields inherited from interface org.xwiki.refactoring.splitter.criterion.naming.NamingCriterion
  INDEX_SEPERATOR

Constructor Summary

Constructors
Constructor	Description
`PageIndexNamingCriterion()`	Implicit constructor.
`PageIndexNamingCriterion(String baseDocumentName, DocumentAccessBridge docBridge)`	Deprecated. since 14.10.2, 15.0RC1 inject this as a component instead and set the base reference through `AbstractNamingCriterion.getParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.xwiki.model.reference.DocumentReference`	`getDocumentReference(org.xwiki.rendering.block.XDOM newDoc)`	Generates a suitable reference for the new document represented by 'newDoc' which is a result of the splitting operation.

Methods inherited from class org.xwiki.refactoring.splitter.criterion.naming.AbstractNamingCriterion
exists, getBasePageName, getPageName, getParameters, newDocumentReference

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xwiki.refactoring.splitter.criterion.naming.NamingCriterion
getDocumentName

- Constructor Detail
  - PageIndexNamingCriterion
```
@Deprecated
public PageIndexNamingCriterion(String baseDocumentName,
                                DocumentAccessBridge docBridge)
```
    Deprecated.
    since 14.10.2, 15.0RC1 inject this as a component instead and set the base reference through AbstractNamingCriterion.getParameters()
    
    Constructs a new PageIndexNamingCriterion.
    
    Parameters:
    
    baseDocumentName - base name to be used for generating new document names.
    
    docBridge - DocumentAccessBridge used to lookup for documents.
  - PageIndexNamingCriterion
```
@Unstable
public PageIndexNamingCriterion()
```
    Implicit constructor. Don't use it directly. Use the component manager instead (e.g. through injection).
    
    Since:
    
    14.10.2, 15.0RC1
- Method Detail
  - getDocumentReference
```
public org.xwiki.model.reference.DocumentReference getDocumentReference(org.xwiki.rendering.block.XDOM newDoc)
```
    Description copied from interface: NamingCriterion
    
    Generates a suitable reference 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 reference generated for the new document