Package org.xwiki.refactoring.splitter.criterion.naming

Class AbstractNamingCriterion

java.lang.Object

org.xwiki.refactoring.splitter.criterion.naming.AbstractNamingCriterion

All Implemented Interfaces:

NamingCriterion

Direct Known Subclasses:

HeadingNameNamingCriterion, PageIndexNamingCriterion

@Unstable
public abstract class AbstractNamingCriterion
extends Object
implements NamingCriterion

Base class for NamingCriterion implementations.

Since:

14.10.2, 15.0RC1

Version:

$Id: 4887132f5bbb00523540e82ed949d354f2e0e1a3 $

Field Summary

Fields

Modifier and Type	Field	Description
protected DocumentAccessBridge	docBridge	DocumentAccessBridge used to lookup for existing wiki pages and avoid name clashes.
protected org.slf4j.Logger	logger

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

INDEX_SEPERATOR

Constructor Summary

Constructors

Constructor	Description
AbstractNamingCriterion()

Method Summary

Modifier and Type	Method	Description
protected boolean	exists(org.xwiki.model.reference.DocumentReference documentReference)
protected String	getBasePageName()
protected String	getPageName(org.xwiki.model.reference.DocumentReference documentReference)
NamingCriterionParameters	getParameters()
protected org.xwiki.model.reference.DocumentReference	newDocumentReference(String pageName)

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, getDocumentReference

Field Detail

logger

@Inject
protected org.slf4j.Logger logger

docBridge

@Inject
protected DocumentAccessBridge docBridge

DocumentAccessBridge used to lookup for existing wiki pages and avoid name clashes.

Constructor Detail

AbstractNamingCriterion

public AbstractNamingCriterion()

Method Detail

getParameters

public NamingCriterionParameters getParameters()

Specified by:

getParameters in interface NamingCriterion

Returns:

the parameters that control how new document references are generated by NamingCriterion.getDocumentReference(XDOM)

exists

protected boolean exists(org.xwiki.model.reference.DocumentReference documentReference)

getBasePageName

protected String getBasePageName()

getPageName

protected String getPageName(org.xwiki.model.reference.DocumentReference documentReference)

newDocumentReference

protected org.xwiki.model.reference.DocumentReference newDocumentReference(String pageName)