Interface WikiEngine

All Known Implementing Classes:
BaseWikiEngine

public interface WikiEngine
  • Method Details

    • convert

      String convert(WikiPage page, javax.portlet.PortletURL viewPageURL, javax.portlet.PortletURL editPageURL, String attachmentURLPrefix) throws PageContentException
      Returns the content of the given page converted to HTML using the view and edit URLs to build links.
      Parameters:
      page - the wiki page
      viewPageURL - the URL to view the page
      editPageURL - the URL to edit the page
      attachmentURLPrefix - the URL prefix to use for attachments to the page
      Returns:
      the content of the given page converted to HTML
      Throws:
      PageContentException
    • getFormat

      String getFormat()
    • getFormatLabel

      String getFormatLabel(Locale locale)
    • getOutgoingLinks

      Map<String,Boolean> getOutgoingLinks(WikiPage page) throws PageContentException
      Returns a map of the links included in the given page. The key of each map entry is the title of the linked page. The value is a Boolean object that indicates if the linked page exists or not.
      Parameters:
      page - the page
      Returns:
      a map of links included in the given page
      Throws:
      PageContentException
    • getToolbarSet

      String getToolbarSet()
    • renderEditPage

      void renderEditPage(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, WikiNode node, WikiPage page) throws IOException, javax.servlet.ServletException
      Throws:
      IOException
      javax.servlet.ServletException
    • validate

      boolean validate(long nodeId, String content)
      Returns true if the content of a wiki page for this engine is valid.
      Parameters:
      nodeId - the ID of the wiki page node
      content - the page content
      Returns:
      true if the content of a wiki page for this engine is valid; false otherwise