com.aoindustries.website.framework
Class AutoSiteMap

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          com.aoindustries.website.framework.ErrorReportingServlet
              com.aoindustries.website.framework.WebPage
                  com.aoindustries.website.framework.TreePage
                      com.aoindustries.website.framework.AutoSiteMap

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public abstract class AutoSiteMap
extends TreePage

Automatically builds a site map of the entire site.

Author:

AO Industries, Inc.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.aoindustries.website.framework.TreePage

MODE_AUTO, MODE_GUI, MODE_TEXT, TREE_LINE_COLOR, TREEPAGE_MODE

Fields inherited from class com.aoindustries.website.framework.WebPage

emptyWebPageArray, reHTMLPattern

Fields inherited from class com.aoindustries.website.framework.ErrorReportingServlet

BUFFER_SIZE

Constructor Summary

AutoSiteMap(LoggerAccessor loggerAccessor)

AutoSiteMap(LoggerAccessor loggerAccessor, java.lang.Object param)

AutoSiteMap(WebSiteRequest req)

Method Summary

void	doGet(com.aoindustries.io.ChainWriter out, WebSiteRequest req, javax.servlet.http.HttpServletResponse resp) The content of this page will not be included in the interal search engine.
protected java.util.List<TreePageData>	getTree(WebSiteRequest req) Gets the tree to be displayed.
protected abstract boolean	isVisible(WebPage page) Determines if a page should be visible in the generated maps.

Methods inherited from class com.aoindustries.website.framework.TreePage

doGet, doPost, getLastModified, getSearchLastModified, replaceHTML, useCodeFont, useSmoothOutline

Methods inherited from class com.aoindustries.website.framework.WebPage

canAccess, doPost, doPostWithSearch, enforceEncryption, equals, equals, generateURLPath, getAdditionalHeaders, getAuthor, getCachedPages, getClassLastModified, getClassLoaderUptime, getContentVAlign, getCopyright, getDescription, getHTMLChainWriter, getHTMLOutputStream, getJavaScriptSrc, getKeywords, getLastModifiedRecursive, getLastModifiedRecursive, getNavImageAlt, getNavImageSuffix, getNavImageURL, getNextPage, getOnloadScript, getPageIndexInParent, getParent, getPreferredContentWidth, getPreviousPage, getRedirectURL, getRootPage, getServletContext, getShortTitle, getTitle, getURLParams, getURLPath, getURLPattern, getWebPage, getWebPage, getWebPage, getWebPage, getWebPageAndChildrenLastModified, getWebPageLayout, getWebPages, getWebSiteRequest, hashCode, includeNavImageAsParent, isHandler, isHandler, loadClass, printLoginForm, printUnauthorizedPage, reportingDoGet, reportingDoPost, reportingGetLastModified, search, showInLocationPath, standardSearch, useEncryption, useNavImage, useSiteMap

Methods inherited from class com.aoindustries.website.framework.ErrorReportingServlet

doGet, doPost, getGetCount, getLastModified, getLastModifiedCount, getLogger, getLogger, getLogger, getLoggerAccessor, getPostCount, getUptime, log, log

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletInfo, getServletName, init, init

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoSiteMap

public AutoSiteMap(LoggerAccessor loggerAccessor)

AutoSiteMap

public AutoSiteMap(WebSiteRequest req)

AutoSiteMap

public AutoSiteMap(LoggerAccessor loggerAccessor,
                   java.lang.Object param)

Method Detail

doGet

public void doGet(com.aoindustries.io.ChainWriter out,
                  WebSiteRequest req,
                  javax.servlet.http.HttpServletResponse resp)
           throws java.io.IOException,
                  java.sql.SQLException

The content of this page will not be included in the interal search engine.

Overrides:

doGet in class TreePage

Parameters:

out - the ChainWriter to send output to

req - the current WebSiteRequest

resp - the HttpServletResponse for this request, is null when searching

Throws:

java.io.IOException

java.sql.SQLException

getTree

protected final java.util.List<TreePageData> getTree(WebSiteRequest req)
                                              throws java.io.IOException,
                                                     java.sql.SQLException

Description copied from class: TreePage

Gets the tree to be displayed. Each row consists of three elements: path, href, description

Specified by:

getTree in class TreePage

Throws:

java.io.IOException

java.sql.SQLException

isVisible

protected abstract boolean isVisible(WebPage page)

Determines if a page should be visible in the generated maps.