fr.paris.lutece.portal.web.xpages
Class SiteMapApp

java.lang.Object
  extended by fr.paris.lutece.portal.web.xpages.SiteMapApp
All Implemented Interfaces:
CacheableService, LuteceService, XPageApplication

public class SiteMapApp
extends java.lang.Object
implements XPageApplication, CacheableService

This class provides the map of the pages on the site


Constructor Summary
SiteMapApp()
          Creates a new SiteMapPage object
 
Method Summary
 int getCacheSize()
          Returns the number of objects stored in the cache
 java.lang.String getName()
          Returns the service name
 java.lang.String getName(java.util.Locale locale)
          Returns the localized service name
 XPage getPage(javax.servlet.http.HttpServletRequest request, int nMode, Plugin plugin)
          Build or get in the cache the page which contains the site map depending on the mode
 boolean isCacheEnable()
          Tells if the cache is enabled
 void resetCache()
          Clear the cache
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SiteMapApp

public SiteMapApp()
Creates a new SiteMapPage object

Method Detail

getPage

public XPage getPage(javax.servlet.http.HttpServletRequest request,
                     int nMode,
                     Plugin plugin)
Build or get in the cache the page which contains the site map depending on the mode

Specified by:
getPage in interface XPageApplication
Parameters:
request - The Http request
nMode - The selected mode
plugin - The plugin
Returns:
The content of the site map

getCacheSize

public int getCacheSize()
Returns the number of objects stored in the cache

Specified by:
getCacheSize in interface CacheableService
Returns:
The number objects in the cache

isCacheEnable

public boolean isCacheEnable()
Tells if the cache is enabled

Specified by:
isCacheEnable in interface CacheableService
Returns:
true if enable, otherwise false

resetCache

public void resetCache()
Clear the cache

Specified by:
resetCache in interface CacheableService

getName

public java.lang.String getName()
Returns the service name

Specified by:
getName in interface LuteceService
Returns:
The service name

getName

public java.lang.String getName(java.util.Locale locale)
Returns the localized service name

Parameters:
locale - The locale
Returns:
The localized service name


Copyright © 2010 Mairie de Paris. All Rights Reserved.