org.opencms.ade.configuration.formatters

类 CmsFormatterConfigurationCache

java.lang.Object

org.opencms.ade.configuration.formatters.CmsFormatterConfigurationCache

所有已实现的接口:

I_CmsGlobalConfigurationCache

public class CmsFormatterConfigurationCache
extends java.lang.Object
implements I_CmsGlobalConfigurationCache

A cache object which holds a collection of formatter configuration beans read from the VFS.

This class does not immediately update the cached formatter collection when changes in the VFS occur, but instead schedules an update action with a slight delay, so that if many formatters are changed in a short time, only one update operation is needed.

Two instances of this cache are needed, one for the Online project and one for Offline projects.

字段概要

字段

限定符和类型	字段和说明
static CmsUUID	RELOAD_MARKER A UUID which is used to mark the configuration cache for complete reloading.
static java.lang.String	TYPE_FORMATTER_CONFIG The resource type for formatter configurations.
protected static int	UPDATE_DELAY_SECONDS The delay to use for updating the formatter cache, in seconds.

构造器概要

构造器

构造器和说明
CmsFormatterConfigurationCache(CmsObject cms, java.lang.String name) Creates a new formatter configuration cache instance.

方法概要

方法

限定符和类型	方法和说明
void	clear() Clears the cache.
java.lang.String	getName() Gets the cache instance name.
CmsFormatterConfigurationCacheState	getState() Gets the collection of cached formatters.
void	performUpdate() The method called by the scheduled update action to update the cache.
protected CmsFormatterBean	readFormatter(CmsUUID structureId) Reads a formatter given its structure id and returns it, or null if the formatter couldn't be read.
void	reload() Reloads the formatter cache.
void	remove(CmsPublishedResource pubRes) Removes a published resource from the cache.
void	remove(CmsResource resource) Removes a resource from the cache.
void	update(CmsPublishedResource pubRes) Updates the cache entry for the given published resource.
void	update(CmsResource resource) Updates the cache entry for the given resource.
void	waitForUpdate() Waits until no update action is scheduled.

从类继承的方法 java.lang.Object

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

字段详细资料

RELOAD_MARKER

public static final CmsUUID RELOAD_MARKER

A UUID which is used to mark the configuration cache for complete reloading.

TYPE_FORMATTER_CONFIG

public static final java.lang.String TYPE_FORMATTER_CONFIG

The resource type for formatter configurations.

另请参阅:

常量字段值

UPDATE_DELAY_SECONDS

protected static int UPDATE_DELAY_SECONDS

The delay to use for updating the formatter cache, in seconds.

构造器详细资料

CmsFormatterConfigurationCache

public CmsFormatterConfigurationCache(CmsObject cms,
                              java.lang.String name)
                               throws CmsException

Creates a new formatter configuration cache instance.

参数:

cms - the CMS context to use

name - the cache name

抛出:

CmsException - if something goes wrong

方法详细资料

clear

public void clear()

从接口复制的说明: I_CmsGlobalConfigurationCache

Clears the cache.

指定者:

clear 在接口中 I_CmsGlobalConfigurationCache

另请参阅:

I_CmsGlobalConfigurationCache.clear()

getName

public java.lang.String getName()

Gets the cache instance name.

返回:

the cache instance name

getState

public CmsFormatterConfigurationCacheState getState()

Gets the collection of cached formatters.

返回:

the collection of cached formatters

performUpdate

public void performUpdate()

The method called by the scheduled update action to update the cache.

reload

public void reload()

Reloads the formatter cache.

remove

public void remove(CmsPublishedResource pubRes)

从接口复制的说明: I_CmsGlobalConfigurationCache

Removes a published resource from the cache.

指定者:

remove 在接口中 I_CmsGlobalConfigurationCache

参数:

pubRes - the published resource

另请参阅:

I_CmsGlobalConfigurationCache.remove(org.opencms.db.CmsPublishedResource)

remove

public void remove(CmsResource resource)

从接口复制的说明: I_CmsGlobalConfigurationCache

Removes a resource from the cache.

指定者:

remove 在接口中 I_CmsGlobalConfigurationCache

参数:

resource - the resource to remove

另请参阅:

I_CmsGlobalConfigurationCache.remove(org.opencms.file.CmsResource)

update

public void update(CmsPublishedResource pubRes)

从接口复制的说明: I_CmsGlobalConfigurationCache

Updates the cache entry for the given published resource.

NOTE: Cache implementations should not directly read the updated resource in this method because it might interfere with other caches. Instead, the resource should be marked as updated and read the next time the cache is queried.

指定者:

update 在接口中 I_CmsGlobalConfigurationCache

参数:

pubRes - a published resource

另请参阅:

I_CmsGlobalConfigurationCache.update(org.opencms.db.CmsPublishedResource)

update

public void update(CmsResource resource)

从接口复制的说明: I_CmsGlobalConfigurationCache

Updates the cache entry for the given resource.

NOTE: Cache implementations should not directly read the updated resource in this method because it might interfere with other caches. Instead, the resource should be marked as updated and read the next time the cache is queried.

指定者:

update 在接口中 I_CmsGlobalConfigurationCache

参数:

resource - the resource for which the cache entry should be updated

另请参阅:

I_CmsGlobalConfigurationCache.update(org.opencms.file.CmsResource)

waitForUpdate

public void waitForUpdate()

Waits until no update action is scheduled.

Should only be used in tests.

readFormatter

protected CmsFormatterBean readFormatter(CmsUUID structureId)

Reads a formatter given its structure id and returns it, or null if the formatter couldn't be read.

参数:

structureId - the structure id of the formatter configuration

返回:

the formatter bean, or null if no formatter could be read for some reason