Java Doc for AbstractFileProvider.java in » Wiki-Engine » JSPWiki » com » ecyrd » jspwiki » providers » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Wiki Engine » JSPWiki » com.ecyrd.jspwiki.providers

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

com.ecyrd.jspwiki.providers .AbstractFileProvider

All known Subclasses:   com.ecyrd.jspwiki.providers .VersioningFileProvider,  com.ecyrd.jspwiki.providers .FileSystemProvider,  com.ecyrd.jspwiki.providers .RCSFileProvider,
AbstractFileProvider
abstract public class AbstractFileProvider implements WikiPageProvider(Code)
Provides a simple directory based repository for Wiki pages.
All files have ".txt" appended to make life easier for those who insist on using Windows or other software which makes assumptions on the files contents based on its name.
This class functions as a superclass to all file based providers.
since:
   2.1.21.
author:
   Janne Jalkanen

Inner Class :public static class WikiFileFilter implements FilenameFilter

Field Summary
final public static String DEFAULT_ENCODING

final public static String FILE_EXT
     All files should have this extension to be recognized as JSPWiki files.
final public static String PROP_PAGEDIR
     Name of the property that defines where page directories are.
protected String m_encoding

protected WikiEngine m_engine


Method Summary
public void deletePage(String pageName)

public void deleteVersion(String pageName, int version)

protected File findPage(String page)
     Finds a Wiki page from the page repository.
public Collection findPages(QueryItem[] query)
     Iterates through all WikiPages, matches them against the given query, and returns a Collection of SearchResult objects.
public Collection getAllChangedSince(Date date)

public Collection getAllPages()

public int getPageCount()

String getPageDirectory()

public WikiPage getPageInfo(String page, int version)
     Always returns the latest version, since FileSystemProvider does not support versioning.
public String getPageText(String page, int version)
     This implementation just returns the current version, as filesystem does not provide versioning information for now.
public String getProviderInfo()

public List getVersionHistory(String page)
     The FileSystemProvider provides only one version.
public void initialize(WikiEngine engine, Properties properties)

protected String mangleName(String pagename)
     This makes sure that the queried page name is still readable by the file system.
public boolean pageExists(String page)

public void putPageText(WikiPage page, String text)

protected String unmangleName(String filename)
     This makes the reverse of mangleName.

Field Detail
DEFAULT_ENCODING
final public static String DEFAULT_ENCODING(Code)

FILE_EXT
final public static String FILE_EXT(Code)
All files should have this extension to be recognized as JSPWiki files. We default to .txt, because that is probably easiest for Windows users, and guarantees correct handling.

PROP_PAGEDIR
final public static String PROP_PAGEDIR(Code)
Name of the property that defines where page directories are.

m_encoding
protected String m_encoding(Code)

m_engine
protected WikiEngine m_engine(Code)

Method Detail
deletePage
public void deletePage(String pageName) throws ProviderException(Code)

deleteVersion
public void deleteVersion(String pageName, int version) throws ProviderException(Code)

findPage
protected File findPage(String page)(Code)
Finds a Wiki page from the page repository.

findPages
public Collection findPages(QueryItem[] query)(Code)
Iterates through all WikiPages, matches them against the given query, and returns a Collection of SearchResult objects.

getAllChangedSince
public Collection getAllChangedSince(Date date)(Code)

getAllPages
public Collection getAllPages() throws ProviderException(Code)

getPageCount
public int getPageCount()(Code)

getPageDirectory
String getPageDirectory()(Code)

getPageInfo
public WikiPage getPageInfo(String page, int version) throws ProviderException(Code)
Always returns the latest version, since FileSystemProvider does not support versioning.

getPageText
public String getPageText(String page, int version) throws ProviderException(Code)
This implementation just returns the current version, as filesystem does not provide versioning information for now.

getProviderInfo
public String getProviderInfo()(Code)

getVersionHistory
public List getVersionHistory(String page) throws ProviderException(Code)
The FileSystemProvider provides only one version.

initialize
public void initialize(WikiEngine engine, Properties properties) throws NoRequiredPropertyException, IOException(Code)

throws:
  FileNotFoundException - If the specified page directory does not exist.
throws:
  IOException - In case the specified page directory is a file, not a directory.

mangleName
protected String mangleName(String pagename)(Code)
This makes sure that the queried page name is still readable by the file system.

pageExists
public boolean pageExists(String page)(Code)

putPageText
public void putPageText(WikiPage page, String text) throws ProviderException(Code)

unmangleName
protected String unmangleName(String filename)(Code)
This makes the reverse of mangleName.

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.