Package org.opencms.ade.sitemap.shared

Class CmsSitemapCategoryData

java.lang.Object

org.opencms.ade.sitemap.shared.CmsSitemapCategoryData

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class CmsSitemapCategoryData
extends Object
implements com.google.gwt.user.client.rpc.IsSerializable

The category data for the current sitemap.

Constructor Summary

Constructors

Constructor	Description
CmsSitemapCategoryData()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	add(CmsCategoryTreeEntry item)	Adds a new category entry.
com.google.common.collect.Multimap<Boolean,CmsCategoryTreeEntry>	getEntriesIndexedByLocality()	Gets a multimap of the top-level entries, indexed by whether they are local categories or not.
CmsCategoryTreeEntry	getEntryById(CmsUUID id)	Gets the category bean by id.
void	setBasePath(String basePath)	Sets the base path.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsSitemapCategoryData

public CmsSitemapCategoryData()

Default constructor.

Method Details

add

public void add(CmsCategoryTreeEntry item)

Adds a new category entry.

Parameters:

item - the category entry

getEntriesIndexedByLocality

public com.google.common.collect.Multimap<Boolean,CmsCategoryTreeEntry> getEntriesIndexedByLocality()

Gets a multimap of the top-level entries, indexed by whether they are local categories or not.

A category counts as local if all of its parent categories are defined in the current sitemap.

Returns:

the multimap of entries

getEntryById

public CmsCategoryTreeEntry getEntryById(CmsUUID id)

Gets the category bean by id.

Parameters:

id - a structure id

Returns:

the entry with the given id, or null if no such entry was found

setBasePath

public void setBasePath(String basePath)

Sets the base path.

Parameters:

basePath - the base path