org.olat.modules.wiki
Class Wiki

java.lang.Object
  org.olat.modules.wiki.Wiki

All Implemented Interfaces:

java.io.Serializable, WikiContainer

public class Wiki
extends java.lang.Object
implements WikiContainer, java.io.Serializable

Description:
Abstract model of a single Wiki where a wikiWord is unique and used as a key to get it's content. The pages are hold in an map where the key is an base64 (excluding the "/" of the base64 transformation) id of the wiki name. The base64 key is in the wikiManager used for persisting an single page to an fileSystem. Normal viewing operations are performed by the map where all pages are accessible, writing actions are handled by the wikiManager.

Initial Date: May 7, 2006

Author:

guido schnider

See Also:

Serialized Form

Field Summary

static java.lang.String

CSS_CLASS_WIKI_ICON

Fields inherited from interface org.olat.modules.wiki.WikiContainer

MEDIA_FOLDER_NAME

Method Summary

static WikiPage	assignPropertiesToPage(VFSLeaf leaf)
java.lang.String	generatePageId(java.lang.String pageName)
java.lang.String	getAllPageNamesSorted()
java.util.List<WikiPage>	getAllPagesWithContent()
java.util.List<WikiPage>	getAllPagesWithContent(boolean includeSpecialPages)
boolean	mediaFileExists(java.lang.String imageName) FIXME:gs increase performance
boolean	pageExists(java.lang.String pageId) pass the page name string to the wikiImpl so a lookup can be done

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CSS_CLASS_WIKI_ICON

public static final java.lang.String CSS_CLASS_WIKI_ICON

See Also:

Constant Field Values

Method Detail

pageExists

public boolean pageExists(java.lang.String pageId)

Description copied from interface: WikiContainer

pass the page name string to the wikiImpl so a lookup can be done

Specified by:

pageExists in interface WikiContainer

Parameters:

pageId, - or filename for media and image files

Returns:

See Also:

as pages are stored by pageId

assignPropertiesToPage

public static WikiPage assignPropertiesToPage(VFSLeaf leaf)

getAllPageNamesSorted

public java.lang.String getAllPageNamesSorted()

generatePageId

public java.lang.String generatePageId(java.lang.String pageName)

Specified by:

generatePageId in interface WikiContainer

Returns:

an encoded base64 name which is save to use as unique filename.

See Also:

org.olat.core.commons.modules.wiki.WikiContainer#generatePageId(java.lang.String)

getAllPagesWithContent

public java.util.List<WikiPage> getAllPagesWithContent()

Returns:

a List of all pages in a wiki

getAllPagesWithContent

public java.util.List<WikiPage> getAllPagesWithContent(boolean includeSpecialPages)

mediaFileExists

public boolean mediaFileExists(java.lang.String imageName)

FIXME:gs increase performance

Parameters:

imageName -

Returns: