com.rshtech.jspwiki
Class LocalPageProvider

java.lang.Object
  com.ecyrd.jspwiki.providers.AbstractFileProvider
      com.ecyrd.jspwiki.providers.FileSystemProvider
          com.rshtech.jspwiki.LocalPageProvider

All Implemented Interfaces:

com.ecyrd.jspwiki.providers.WikiPageProvider, com.ecyrd.jspwiki.WikiProvider

public class LocalPageProvider
extends com.ecyrd.jspwiki.providers.FileSystemProvider

TODO Class summary sentence. Class documentation.

Version:

$Revision: 3175 $

Author:

$Author: kostya $

Nested Class Summary

class

LocalPageProvider.LocalFileFilter

Nested classes/interfaces inherited from class com.ecyrd.jspwiki.providers.AbstractFileProvider

com.ecyrd.jspwiki.providers.AbstractFileProvider.WikiFileFilter

Field Summary

static java.lang.String

LOCAL_FILE_EXT

Fields inherited from class com.ecyrd.jspwiki.providers.FileSystemProvider

PROP_EXT

Fields inherited from class com.ecyrd.jspwiki.providers.AbstractFileProvider

DEFAULT_ENCODING, FILE_EXT, m_encoding, m_engine, PROP_PAGEDIR

Fields inherited from interface com.ecyrd.jspwiki.WikiProvider

LATEST_VERSION

Constructor Summary

LocalPageProvider()

Method Summary

void	deletePage(java.lang.String pageName)
void	deleteVersion(java.lang.String pageName, int version)
protected java.io.File	findPage(java.lang.String page)
java.util.Collection	findPages(com.ecyrd.jspwiki.QueryItem[] query)
java.util.Collection	getAllChangedSince(java.util.Date date)
java.util.Collection	getAllPages()
int	getPageCount()
com.ecyrd.jspwiki.WikiPage	getPageInfo(java.lang.String page, int version)
java.lang.String	getPageText(java.lang.String page, int version)
java.lang.String	getProviderInfo()
java.util.List	getVersionHistory(java.lang.String page)
void	initialize(com.ecyrd.jspwiki.WikiEngine engine, java.util.Properties properties)
protected java.lang.String	mangleName(java.lang.String pagename)
void	movePage(java.lang.String from, java.lang.String to)
boolean	pageExists(java.lang.String page)
void	putPageText(com.ecyrd.jspwiki.WikiPage page, java.lang.String text)
protected java.lang.String	unmangleName(java.lang.String filename)

Methods inherited from class java.lang.Object

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

Field Detail

LOCAL_FILE_EXT

public static final java.lang.String LOCAL_FILE_EXT

See Also:

Constant Field Values

Constructor Detail

LocalPageProvider

public LocalPageProvider()

Method Detail

initialize

public void initialize(com.ecyrd.jspwiki.WikiEngine engine,
                       java.util.Properties properties)
                throws com.ecyrd.jspwiki.NoRequiredPropertyException,
                       java.io.IOException

Specified by:

initialize in interface com.ecyrd.jspwiki.WikiProvider

Overrides:

initialize in class com.ecyrd.jspwiki.providers.AbstractFileProvider

Throws:

com.ecyrd.jspwiki.NoRequiredPropertyException

java.io.IOException

getPageInfo

public com.ecyrd.jspwiki.WikiPage getPageInfo(java.lang.String page,
                                              int version)
                                       throws com.ecyrd.jspwiki.providers.ProviderException

Specified by:

getPageInfo in interface com.ecyrd.jspwiki.providers.WikiPageProvider

Overrides:

getPageInfo in class com.ecyrd.jspwiki.providers.FileSystemProvider

Throws:

com.ecyrd.jspwiki.providers.ProviderException

movePage

public void movePage(java.lang.String from,
                     java.lang.String to)
              throws com.ecyrd.jspwiki.providers.ProviderException

Specified by:

movePage in interface com.ecyrd.jspwiki.providers.WikiPageProvider

Overrides:

movePage in class com.ecyrd.jspwiki.providers.FileSystemProvider

Throws:

com.ecyrd.jspwiki.providers.ProviderException

putPageText

public void putPageText(com.ecyrd.jspwiki.WikiPage page,
                        java.lang.String text)
                 throws com.ecyrd.jspwiki.providers.ProviderException

Specified by:

putPageText in interface com.ecyrd.jspwiki.providers.WikiPageProvider

Overrides:

putPageText in class com.ecyrd.jspwiki.providers.FileSystemProvider

Throws:

com.ecyrd.jspwiki.providers.ProviderException

deletePage

public void deletePage(java.lang.String pageName)
                throws com.ecyrd.jspwiki.providers.ProviderException

Specified by:

deletePage in interface com.ecyrd.jspwiki.providers.WikiPageProvider

Overrides:

deletePage in class com.ecyrd.jspwiki.providers.FileSystemProvider

Throws:

com.ecyrd.jspwiki.providers.ProviderException

deleteVersion

public void deleteVersion(java.lang.String pageName,
                          int version)
                   throws com.ecyrd.jspwiki.providers.ProviderException

Specified by:

deleteVersion in interface com.ecyrd.jspwiki.providers.WikiPageProvider

Overrides:

deleteVersion in class com.ecyrd.jspwiki.providers.AbstractFileProvider

Throws:

com.ecyrd.jspwiki.providers.ProviderException

findPages

public java.util.Collection findPages(com.ecyrd.jspwiki.QueryItem[] query)

Specified by:

findPages in interface com.ecyrd.jspwiki.providers.WikiPageProvider

Overrides:

findPages in class com.ecyrd.jspwiki.providers.AbstractFileProvider

getAllChangedSince

public java.util.Collection getAllChangedSince(java.util.Date date)

Specified by:

getAllChangedSince in interface com.ecyrd.jspwiki.providers.WikiPageProvider

Overrides:

getAllChangedSince in class com.ecyrd.jspwiki.providers.AbstractFileProvider

getAllPages

public java.util.Collection getAllPages()
                                 throws com.ecyrd.jspwiki.providers.ProviderException

Specified by:

getAllPages in interface com.ecyrd.jspwiki.providers.WikiPageProvider

Overrides:

getAllPages in class com.ecyrd.jspwiki.providers.AbstractFileProvider

Throws:

com.ecyrd.jspwiki.providers.ProviderException

getPageCount

public int getPageCount()

Specified by:

getPageCount in interface com.ecyrd.jspwiki.providers.WikiPageProvider

Overrides:

getPageCount in class com.ecyrd.jspwiki.providers.AbstractFileProvider

getPageText

public java.lang.String getPageText(java.lang.String page,
                                    int version)
                             throws com.ecyrd.jspwiki.providers.ProviderException

Specified by:

getPageText in interface com.ecyrd.jspwiki.providers.WikiPageProvider

Overrides:

getPageText in class com.ecyrd.jspwiki.providers.AbstractFileProvider

Throws:

com.ecyrd.jspwiki.providers.ProviderException

getProviderInfo

public java.lang.String getProviderInfo()

Specified by:

getProviderInfo in interface com.ecyrd.jspwiki.WikiProvider

Overrides:

getProviderInfo in class com.ecyrd.jspwiki.providers.AbstractFileProvider

getVersionHistory

public java.util.List getVersionHistory(java.lang.String page)
                                 throws com.ecyrd.jspwiki.providers.ProviderException

Specified by:

getVersionHistory in interface com.ecyrd.jspwiki.providers.WikiPageProvider

Overrides:

getVersionHistory in class com.ecyrd.jspwiki.providers.AbstractFileProvider

Throws:

com.ecyrd.jspwiki.providers.ProviderException

pageExists

public boolean pageExists(java.lang.String page)

Specified by:

pageExists in interface com.ecyrd.jspwiki.providers.WikiPageProvider

Overrides:

pageExists in class com.ecyrd.jspwiki.providers.AbstractFileProvider

findPage

protected java.io.File findPage(java.lang.String page)

Overrides:

findPage in class com.ecyrd.jspwiki.providers.AbstractFileProvider

mangleName

protected java.lang.String mangleName(java.lang.String pagename)

Overrides:

mangleName in class com.ecyrd.jspwiki.providers.AbstractFileProvider

unmangleName

protected java.lang.String unmangleName(java.lang.String filename)

Overrides:

unmangleName in class com.ecyrd.jspwiki.providers.AbstractFileProvider