Package org.opencms.jsp.util

Class CmsJspCategoryAccessBean

java.lang.Object

org.opencms.jsp.util.CmsJspCategoryAccessBean

public class CmsJspCategoryAccessBean
extends Object

Bean for easy access to categories of a resource in JSPs.

Constructor Summary

Constructors

Constructor	Description
CmsJspCategoryAccessBean(CmsObject cms, CmsResource resource)	Default constructor.

Method Summary

Modifier and Type	Method	Description
boolean	contains(String categoryPath)	Checks if the wrapped categories contain a given category.
boolean	containsAll(Collection<String> categoryPaths)	Checks if the wrapped categories contain all given categories.
boolean	containsAny(Collection<String> categoryPaths)	Checks if the wrapped categories contain at lease one of the given categories.
List<CmsCategory>	getAllItems()	Returns all wrapped categories.
boolean	getIsEmpty()	Returns true if there is no category wrapped, otherwise false.
List<CmsCategory>	getLeafItems()	Returns only the leaf categories of the wrapped categories.
Map<String,CmsJspCategoryAccessBean>	getSubCategories()	Returns a map from a category path to the wrapper of all the sub-categories of the category with the path given as key.
List<CmsCategory>	getTopItems()	Returns all categories that are direct children of the current main category.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsJspCategoryAccessBean

public CmsJspCategoryAccessBean(CmsObject cms,
 CmsResource resource)

Default constructor.

Parameters:

cms - the current CmsObject.

resource - the resource for which the categories should be read.

Method Details

contains

public boolean contains(String categoryPath)

Checks if the wrapped categories contain a given category.

Parameters:

categoryPath - the complete path of the category to check, e.g. "location/africa/"

Returns:

true iff the wrapped categories contain a category with the provided categoryPath.

containsAll

public boolean containsAll(Collection<String> categoryPaths)

Checks if the wrapped categories contain all given categories.

Parameters:

categoryPaths - the complete paths of the categories to check, e.g. ["location/africa/", "news/"]

Returns:

true iff for each of the provided categoryPaths, the wrapped categories contain a category with this path.

containsAny

public boolean containsAny(Collection<String> categoryPaths)

Checks if the wrapped categories contain at lease one of the given categories.

Parameters:

categoryPaths - the complete paths of the categories to check, e.g. ["location/africa/", "news/"]

Returns:

true iff for at least one of the provided categoryPaths, the wrapped categories contain a category with this path.

getAllItems

public List<CmsCategory> getAllItems()

Returns all wrapped categories.

Returns:

all wrapped categories.

getIsEmpty

public boolean getIsEmpty()

Returns true if there is no category wrapped, otherwise false.

Returns:

true if there is no category wrapped, otherwise false.

getLeafItems

public List<CmsCategory> getLeafItems()

Returns only the leaf categories of the wrapped categories. The method assumes that categories are ordered in the list, i.e., parents are directly followed by their children. NOTE: In the complete category tree a leaf of the wrapped tree part may not be a leaf.

Returns:

only the leaf categories of the wrapped categories.

getSubCategories

public Map<String,CmsJspCategoryAccessBean> getSubCategories()

Returns a map from a category path to the wrapper of all the sub-categories of the category with the path given as key.

Returns:

a map from a category path to all sub-categories of the path's category.

getTopItems

public List<CmsCategory> getTopItems()

Returns all categories that are direct children of the current main category.

Returns:

all categories that are direct children of the current main category.