com.ecyrd.jspwiki.providers
Class WikiVersioningFileProvider

java.lang.Object
  com.ecyrd.jspwiki.providers.AbstractFileProvider
      com.ecyrd.jspwiki.providers.WikiVersioningFileProvider

All Implemented Interfaces:

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

public class WikiVersioningFileProvider
extends com.ecyrd.jspwiki.providers.AbstractFileProvider
implements com.ecyrd.jspwiki.providers.VersioningProvider

Author:

Ludovic Bertin

Nested Class Summary

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

com.ecyrd.jspwiki.providers.AbstractFileProvider.WikiFileFilter

Field Summary

static String	ID
static String	PAGEDIR
static String	PROPERTYFILE

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

WikiVersioningFileProvider()

Method Summary

void	deletePage(String page) Removes the relevant page directory under "OLD" -directory as well, but does not remove any extra subdirectories from it.
void	deleteVersion(String page, int version)
protected File	findPage(String page) Finds a Wiki page from the page repository.
Collection	findPages(com.ecyrd.jspwiki.QueryItem[] query) Iterates through all WikiPages, matches them against the given query, and returns a Collection of SearchResult objects.
Collection<?>	getAllPages()
int	getPageCount()
com.ecyrd.jspwiki.WikiPage	getPageInfo(String page, int version)
String	getPageText(String page, int version)
String	getProviderInfo()
List<?>	getVersionHistory(String page) FIXME: Does not get user information.
void	initialize(com.ecyrd.jspwiki.WikiEngine engine, Properties properties)
Collection<?>	internalGetAllPages()
void	movePage(String from, String to)
boolean	pageExists(String pageName, int version)
void	putPageText(com.ecyrd.jspwiki.WikiPage page, String text)

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

getAllChangedSince, mangleName, pageExists, unmangleName

Methods inherited from class java.lang.Object

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

Field Detail

PAGEDIR

public static final String PAGEDIR

See Also:

Constant Field Values

PROPERTYFILE

public static final String PROPERTYFILE

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

Constructor Detail

WikiVersioningFileProvider

public WikiVersioningFileProvider()

Method Detail

initialize

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

Specified by:

initialize in interface com.ecyrd.jspwiki.WikiProvider

Overrides:

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

Throws:

com.ecyrd.jspwiki.NoRequiredPropertyException

IOException

getPageText

public String getPageText(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

putPageText

public void putPageText(com.ecyrd.jspwiki.WikiPage page,
                        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.AbstractFileProvider

Throws:

com.ecyrd.jspwiki.providers.ProviderException

getPageInfo

public com.ecyrd.jspwiki.WikiPage getPageInfo(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.AbstractFileProvider

Throws:

com.ecyrd.jspwiki.providers.ProviderException

pageExists

public boolean pageExists(String pageName,
                          int version)

Specified by:

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

getVersionHistory

public List<?> getVersionHistory(String page)
                          throws com.ecyrd.jspwiki.providers.ProviderException

FIXME: Does not get user information.

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

deletePage

public void deletePage(String page)
                throws com.ecyrd.jspwiki.providers.ProviderException

Removes the relevant page directory under "OLD" -directory as well, but does not remove any extra subdirectories from it. It will only touch those files that it thinks to be WikiPages.

Specified by:

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

Overrides:

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

Parameters:

page -

Throws:

ProviderException

deleteVersion

public void deleteVersion(String page,
                          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

getAllPages

public 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

getProviderInfo

public String getProviderInfo()

Specified by:

getProviderInfo in interface com.ecyrd.jspwiki.WikiProvider

Overrides:

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

movePage

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

Specified by:

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

Throws:

com.ecyrd.jspwiki.providers.ProviderException

findPage

protected File findPage(String page)

Finds a Wiki page from the page repository.

Overrides:

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

Parameters:

page -

Returns:

internalGetAllPages

public Collection<?> internalGetAllPages()
                                  throws com.ecyrd.jspwiki.providers.ProviderException

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

findPages

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

Iterates through all WikiPages, matches them against the given query, and returns a Collection of SearchResult objects.

Specified by:

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

Overrides:

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

Parameters:

query -

Returns: