Java Doc for WikiBase.java in  » Wiki-Engine » VeryQuickWiki » vqwiki » 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 Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net 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 » VeryQuickWiki » vqwiki   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    vqwiki.WikiBase WikiBase public class WikiBase (Code) Base class for Wiki. Handles all basic Viki stuff. author:    $author$ version:    $Revision: 685 $ Field Summary final public static  int DATABASE      final public static  String DEFAULT_VWIKI      final public static  int FILE      final public static  int LDAP      final public static  String PLUGINS_DIR      protected  Handler handler      Method Summary public  void addReadOnlyTopic(String virtualWiki, String topicName)      public  void addTopicListener(TopicListener listener)      public  void addVirtualWiki(String virtualWiki)      public synchronized  String cook(BufferedReader in, String virtualWiki)      public synchronized  String cook(BufferedReader in, String virtualWiki, String formatLexClass, String layoutLexClass, String linkLexClass, boolean export)      public synchronized  boolean exists(String virtualWiki, String topicName)      protected  String fileBase()      public  ChangeLog getChangeLogInstance()      public  Handler getHandler()      public static  WikiBase getInstance()      Get a reference of this class. public  Notify getNotifyInstance(String virtualWiki, String topic)      public  Collection getOrphanedTopics(String virtualWiki)      public  Collection getReadOnlyTopics(String virtualWiki)      public  SearchEngine getSearchEngineInstance()      Get an instance to the search enginge. public  String getTemplate(String virtualWiki, String name)      public  Collection getTemplates(String virtualWiki)      public  Collection getToDoWikiTopics(String virtualWiki)      public  Usergroup getUsergroupInstance()      public  VersionManager getVersionManagerInstance()      public  int getVirtualWikiCount()      public  Collection getVirtualWikiList()      public  WikiMembers getWikiMembersInstance(String virtualWiki)      public synchronized  boolean holdsLock(String virtualWiki, String topicName, String key)      public static  void initialise()      public  boolean isAdminOnlyTopic(Locale locale, String virtualWiki, String topicName)      Return true if the given topic is marked as "admin only", i.e. protected  boolean isTopicReadOnly(String virtualWiki, String topicName)      public  Collection listRecentChanges(String virtualWiki, int numDays)      public synchronized  boolean lockTopic(String virtualWiki, String topicName, String key)      public  void panic()      public  Collection purgeDeletes(String virtualWiki)      public  void purgeVersionsOlderThan(String virtualWiki, DBDate date)      public synchronized  String readCooked(String virtualWiki, String topicName)      Returns a topic's content that has been formatted to Wiki conventions. public synchronized  String readCooked(String virtualWiki, String topicName, String formatLexClass, String layoutLexClass, String linkLexClass, boolean export)      public static  String readDefaultTopic(String topicName)      public synchronized  String readRaw(String virtualWiki, String topicName)      Reads a file and returns the raw contents. public  void removeReadOnlyTopic(String virtualWiki, String topicName)      public  void saveAsTemplate(String virtualWiki, String templateName, String contents)      public synchronized  void unlockTopic(String virtualWiki, String topicName)      public synchronized  void write(String virtualWiki, String contents, boolean convertTabs, String topicName, String user)      Field Detail DATABASE final public static int DATABASE(Code) The topics are stored in a database DEFAULT_VWIKI final public static String DEFAULT_VWIKI(Code) Name of the default wiki FILE final public static int FILE(Code) The topics are stored in a flat file LDAP final public static int LDAP(Code) Members are retrieved from LDAP PLUGINS_DIR final public static String PLUGINS_DIR(Code) Name of the Plugins-Directory handler protected Handler handler(Code) The handler that looks after read/write operations for a persitence type Method Detail addReadOnlyTopic public void addReadOnlyTopic(String virtualWiki, String topicName) throws Exception(Code) TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! Parameters:   topicName - TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! addTopicListener public void addTopicListener(TopicListener listener)(Code) Register a topic listener Parameters:   listener - listener addVirtualWiki public void addVirtualWiki(String virtualWiki) throws Exception(Code) Add virtual wiki cook public synchronized String cook(BufferedReader in, String virtualWiki) throws ClassNotFoundException, NoSuchMethodException, InstantiationException, IllegalAccessException, InvocationTargetException, IOException(Code) TODO: DOCUMENT ME! Parameters:   in - TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! TODO: DOCUMENT ME! throws:   ClassNotFoundException - TODO: DOCUMENT ME! throws:   NoSuchMethodException - TODO: DOCUMENT ME! throws:   InstantiationException - TODO: DOCUMENT ME! throws:   IllegalAccessException - TODO: DOCUMENT ME! throws:   InvocationTargetException - TODO: DOCUMENT ME! throws:   IOException - TODO: DOCUMENT ME! cook public synchronized String cook(BufferedReader in, String virtualWiki, String formatLexClass, String layoutLexClass, String linkLexClass, boolean export) throws ClassNotFoundException, NoSuchMethodException, InstantiationException, IllegalAccessException, InvocationTargetException, IOException(Code) TODO: DOCUMENT ME! Parameters:   in - TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! Parameters:   formatLexClass - TODO: DOCUMENT ME! Parameters:   layoutLexClass - TODO: DOCUMENT ME! Parameters:   linkLexClass - TODO: DOCUMENT ME! TODO: DOCUMENT ME! throws:   ClassNotFoundException - TODO: DOCUMENT ME! throws:   NoSuchMethodException - TODO: DOCUMENT ME! throws:   InstantiationException - TODO: DOCUMENT ME! throws:   IllegalAccessException - TODO: DOCUMENT ME! throws:   InvocationTargetException - TODO: DOCUMENT ME! throws:   IOException - TODO: DOCUMENT ME! exists public synchronized boolean exists(String virtualWiki, String topicName) throws Exception(Code) TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! Parameters:   topicName - TODO: DOCUMENT ME! TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! fileBase protected String fileBase()(Code) TODO: DOCUMENT ME! TODO: DOCUMENT ME! getChangeLogInstance public ChangeLog getChangeLogInstance() throws Exception(Code) TODO: DOCUMENT ME! TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! getHandler public Handler getHandler()(Code) return the current handler instance the current handler instance getInstance public static WikiBase getInstance() throws Exception(Code) Get a reference of this class. Implements singleton pattern. Instance of this class throws:   Exception - If the storage produces errors getNotifyInstance public Notify getNotifyInstance(String virtualWiki, String topic) throws Exception(Code) TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! Parameters:   topic - TODO: DOCUMENT ME! TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! getOrphanedTopics public Collection getOrphanedTopics(String virtualWiki) throws Exception(Code) Find all topics without links to them getReadOnlyTopics public Collection getReadOnlyTopics(String virtualWiki) throws Exception(Code) TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! getSearchEngineInstance public SearchEngine getSearchEngineInstance() throws Exception(Code) Get an instance to the search enginge. Reference to the SearchEngine throws:   Exception - the current search engine getTemplate public String getTemplate(String virtualWiki, String name) throws Exception(Code) Return a given template getTemplates public Collection getTemplates(String virtualWiki) throws Exception(Code) Return a list of available templates getToDoWikiTopics public Collection getToDoWikiTopics(String virtualWiki) throws Exception(Code) Find all topics that haven't been written but are linked to getUsergroupInstance public Usergroup getUsergroupInstance() throws Exception(Code) Get an instance of the user group Reference to the SearchEngine throws:   Exception - the current search engine getVersionManagerInstance public VersionManager getVersionManagerInstance() throws Exception(Code) TODO: DOCUMENT ME! TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! getVirtualWikiCount public int getVirtualWikiCount()(Code) get a count of the number of virtual wikis in the system the number of virtual wikis getVirtualWikiList public Collection getVirtualWikiList() throws Exception(Code) Return a list of all virtual wikis on the server getWikiMembersInstance public WikiMembers getWikiMembersInstance(String virtualWiki) throws Exception(Code) TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! holdsLock public synchronized boolean holdsLock(String virtualWiki, String topicName, String key) throws Exception(Code) TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! Parameters:   topicName - TODO: DOCUMENT ME! Parameters:   key - TODO: DOCUMENT ME! TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! initialise public static void initialise() throws Exception(Code) TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! isAdminOnlyTopic public boolean isAdminOnlyTopic(Locale locale, String virtualWiki, String topicName) throws Exception(Code) Return true if the given topic is marked as "admin only", i.e. it is present in the admin only topics topic Parameters:   virtualWiki - Parameters:   topicName - isTopicReadOnly protected boolean isTopicReadOnly(String virtualWiki, String topicName) throws Exception(Code) TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! Parameters:   topicName - TODO: DOCUMENT ME! TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! listRecentChanges public Collection listRecentChanges(String virtualWiki, int numDays) throws Exception(Code) Get recent changes for a given number of days lockTopic public synchronized boolean lockTopic(String virtualWiki, String topicName, String key) throws Exception(Code) TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! Parameters:   topicName - TODO: DOCUMENT ME! Parameters:   key - TODO: DOCUMENT ME! TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! panic public void panic()(Code) Do emergency repairs by clearing all locks and deleting recent changes files purgeDeletes public Collection purgeDeletes(String virtualWiki) throws Exception(Code) Purge deleted files a collection of strings that are the deleted topic names purgeVersionsOlderThan public void purgeVersionsOlderThan(String virtualWiki, DBDate date) throws Exception(Code) purge versions older than a certain date readCooked public synchronized String readCooked(String virtualWiki, String topicName) throws Exception(Code) Returns a topic's content that has been formatted to Wiki conventions. Parameters:   virtualWiki - the virtual wiki to use Parameters:   topicName - the topic readCooked public synchronized String readCooked(String virtualWiki, String topicName, String formatLexClass, String layoutLexClass, String linkLexClass, boolean export) throws Exception(Code) TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! Parameters:   topicName - TODO: DOCUMENT ME! Parameters:   formatLexClass - TODO: DOCUMENT ME! Parameters:   layoutLexClass - TODO: DOCUMENT ME! Parameters:   linkLexClass - TODO: DOCUMENT ME! TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! readDefaultTopic public static String readDefaultTopic(String topicName) throws Exception(Code) Finds a default topic file and returns the contents readRaw public synchronized String readRaw(String virtualWiki, String topicName) throws Exception(Code) Reads a file and returns the raw contents. Used for the editing version. removeReadOnlyTopic public void removeReadOnlyTopic(String virtualWiki, String topicName) throws Exception(Code) TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! Parameters:   topicName - TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! saveAsTemplate public void saveAsTemplate(String virtualWiki, String templateName, String contents) throws Exception(Code) save the contents as a template unlockTopic public synchronized void unlockTopic(String virtualWiki, String topicName) throws Exception(Code) TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! Parameters:   topicName - TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! write public synchronized void write(String virtualWiki, String contents, boolean convertTabs, String topicName, String user) throws Exception(Code) TODO: DOCUMENT ME! Parameters:   virtualWiki - TODO: DOCUMENT ME! Parameters:   contents - TODO: DOCUMENT ME! Parameters:   convertTabs - TODO: DOCUMENT ME! Parameters:   topicName - TODO: DOCUMENT ME! throws:   Exception - TODO: DOCUMENT ME! 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)