org.jboss.wiki
Interface WikiPageDictionary

public interface WikiPageDictionary

Author:

Tomasz Szymanski

Method Summary

java.lang.String	getRealName(java.lang.String uid) Return RealName of given UID - this is what will be shown on the page (what user gets)
java.lang.String	getUid(java.lang.String realName) Return UID of RealName (uid is what JBoss Wiki uses for unique recognition of a page)
boolean	realNameInDictionary(java.lang.String realName)
void	removeDictForPage(java.lang.String uid) Removes mapping for given page.
void	rename(java.lang.String uid, java.lang.String newName) Function that adds renaming for current page.
void	setWikiEngine(org.jboss.wiki.WikiEngine wikiEngine) Sets wikiEngine reference
boolean	uidInDictionary(java.lang.String uid)

Method Detail

getRealName

java.lang.String getRealName(java.lang.String uid)

Return RealName of given UID - this is what will be shown on the page (what user gets)

Parameters:

uid - uid to translate

Returns:

apropriate UID

getUid

java.lang.String getUid(java.lang.String realName)

Return UID of RealName (uid is what JBoss Wiki uses for unique recognition of a page)

Parameters:

realName - realName to translate

Returns:

apropriate RealName

rename

void rename(java.lang.String uid,
            java.lang.String newName)
            throws org.jboss.wiki.exceptions.PageRenamingException

Function that adds renaming for current page. You have to remember about all the consequences.

Parameters:

uid - Uid of a page.

newName - New name of a page

Throws:

org.jboss.wiki.exceptions.PageRenamingException - If there is page with "newName" etc.

uidInDictionary

boolean uidInDictionary(java.lang.String uid)

Parameters:

uid -

Returns:

True if there is mapping for given uid.

realNameInDictionary

boolean realNameInDictionary(java.lang.String realName)

Parameters:

realName -

Returns:

True if there is mapping for given realName

removeDictForPage

void removeDictForPage(java.lang.String uid)
                       throws org.jboss.wiki.exceptions.PageRenamingException

Removes mapping for given page. If there is no mapping for a page UID = RealName.

Parameters:

uid -

Throws:

org.jboss.wiki.exceptions.PageRenamingException

setWikiEngine

void setWikiEngine(org.jboss.wiki.WikiEngine wikiEngine)

Sets wikiEngine reference

Parameters:

wikiEngine -