net.sf.tacos.services
Interface SiteMap

All Known Implementing Classes:

SiteMapImpl

public interface SiteMap

This class reads the sitemap configuration, and provides access to basic relationship information, such as page categories, bread crumbs, and other information, that the application may need to ease navigation.

Author:

Gabriel Handford

Method Summary

boolean	contains(String parent, String pageName) Check if page name is contained in the page element tree.
List	getBreadCrumbs(String pageName) Get bread crumbs.
List	getCategories() Get list of named categories.
CategoryInfo	getCategoryFromPage(String pageName) Get the category info for the page name.
CategoryInfo	getCategoryInfo(String name) Get category info for named category.
List	getCategoryPages(String pageName) Get pages for a specific page names category.
PageInfo	getDefaultPage(String category) Get the default page.
String	getDefaultPageDesc(String category) Get the default page description.
PageInfo	getPageInfo(String name) Get page information.
boolean	inCategory(String pageName, String category) Check if page name is in the specified category.

Method Detail

getCategories

List getCategories()

Get list of named categories.

Returns:

The category listing

getCategoryInfo

CategoryInfo getCategoryInfo(String name)

Get category info for named category.

Parameters:

name - The category name

Returns:

The category info

getPageInfo

PageInfo getPageInfo(String name)

Get page information.

Parameters:

name - The page name

Returns:

The page descriptor

getCategoryFromPage

CategoryInfo getCategoryFromPage(String pageName)

Get the category info for the page name.

Parameters:

pageName - The page name.

Returns:

The first category associated with this page.

inCategory

boolean inCategory(String pageName,
                   String category)

Check if page name is in the specified category.

Parameters:

pageName - Page name

category - Category

Returns:

True if in the specified category

getDefaultPageDesc

String getDefaultPageDesc(String category)

Get the default page description.

Parameters:

category - Category

Returns:

Category default page description

getCategoryPages

List getCategoryPages(String pageName)

Get pages for a specific page names category.

Parameters:

pageName - Page name

Returns:

Pages

getDefaultPage

PageInfo getDefaultPage(String category)

Get the default page.

Parameters:

category - Category

Returns:

Default page

contains

boolean contains(String parent,
                 String pageName)

Check if page name is contained in the page element tree.

Parameters:

parent - The page to start at.

pageName - The page to find.

Returns:

True if the parent contains the page in its tree.

getBreadCrumbs

List getBreadCrumbs(String pageName)

Get bread crumbs.

Parameters:

pageName - The page name.

Returns:

The bread crumbs (page name list).