com.aoindustries.website.framework.AutoSiteMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aoweb-framework Show documentation

Legacy servlet-based web framework, superfast and capable but tedious to use.

There is a newer version: 2.0.0

/*
 * aoweb-framework - Legacy servlet-based web framework, superfast and capable but tedious to use.
 * Copyright (C) 2000-2009, 2015, 2016  AO Industries, Inc.
 *     [email protected]
 *     7262 Bull Pen Cir
 *     Mobile, AL 36695
 *
 * This file is part of aoweb-framework.
 *
 * aoweb-framework is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * aoweb-framework is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with aoweb-framework.  If not, see .
 */
package com.aoindustries.website.framework;

import com.aoindustries.encoding.ChainWriter;
import java.io.IOException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import javax.servlet.http.HttpServletResponse;

/**
 * Automatically builds a site map of the entire site.
 *
 * @author  AO Industries, Inc.
 */
abstract public class AutoSiteMap extends TreePage {

	private static final long serialVersionUID = 1L;

	public AutoSiteMap(LoggerAccessor loggerAccessor) {
		super(loggerAccessor);
	}

	public AutoSiteMap(WebSiteRequest req) {
		super(req);
	}

	public AutoSiteMap(LoggerAccessor loggerAccessor, Object param) {
		super(loggerAccessor, param);
	}

	/**
	 * Recursively builds the list of all sites.
	 */
	private void buildData(String path, WebPage page, List data, WebSiteRequest req) throws IOException, SQLException {
		if(isVisible(page)) {
			if(path.length()>0) path=path+'/'+page.getShortTitle();
			else path=page.getShortTitle();
			WebPage[] pages=page.getCachedPages(req);
			int len=pages.length;
			data.add(
				new TreePageData(
					len>0 ? (path+'/') : path,
					req.getContextPath()+req.getURL(page),
					page.getDescription()
				)
			);
			for(int c=0; c getTree(WebSiteRequest req) throws IOException, SQLException {
		WebPage home=getRootPage();
		List data=new ArrayList<>();
		buildData("", home, data, req);
		//int size=data.size();
		return data;
	}

	/**
	 * Determines if a page should be visible in the generated maps.
	 */
	abstract protected boolean isVisible(WebPage page);
}