com.opencms.template.cache
Class CmsElementXml

java.lang.Object
  |
  +--com.opencms.template.cache.A_CmsElement
        |
        +--com.opencms.template.cache.CmsElementXml

All Implemented Interfaces:

I_CmsLogChannels

public class CmsElementXml

extends A_CmsElement

implements I_CmsLogChannels

An instance of CmsElementXML represents an requestable Element in the OpenCms element cache area. It contains all informations to generate the content of this element. It also stores the variants of once generated content to speed up performance. It points to other depending elements. Theses elements are called to generate their content on generation-time.

Author:

Alexander Lucas

Field Summary

Fields inherited from class com.opencms.template.cache.A_CmsElement

m_cacheDirectives, m_className, m_elementDefinitions, m_hasDepVariants, m_readAccessGroup, m_templateName, m_timestamp

Fields inherited from interface com.opencms.boot.I_CmsLogChannels

C_FLEX_CACHE, C_FLEX_LOADER, C_LOGGING, C_MODULE_CRITICAL, C_MODULE_DEBUG, C_MODULE_INFO, C_OPENCMS_CACHE, C_OPENCMS_CRITICAL, C_OPENCMS_CRONSCHEDULER, C_OPENCMS_DEBUG, C_OPENCMS_ELEMENTCACHE, C_OPENCMS_INFO, C_OPENCMS_INIT, C_OPENCMS_POOL, C_OPENCMS_STATICEXPORT, C_OPENCMS_STREAMING, C_PREPROCESSOR_IS_LOGGING

Constructor Summary

CmsElementXml(String className, String templateName, String readAccessGroup, CmsCacheDirectives cd, CmsElementDefinitionCollection defs, int variantCachesize)
A construcor which creates an element with the given element definitions.

CmsElementXml(String className, String templateName, String readAccessGroup, CmsCacheDirectives cd, int variantCachesize)
Constructor for an element with the given class and template name.

Method Summary

byte[]

getContent(CmsElementCache elementCache, CmsObject cms, CmsElementDefinitionCollection elDefs, String elementName, Hashtable parameters, String methodParameter) Get the content of this element.

Methods inherited from class com.opencms.template.cache.A_CmsElement

addDefinition, addVariant, checkProxySettings, checkReadAccess, clearVariantCache, getAllDefinitions, getAllVariantKeys, getCacheDirectives, getElementDefinition, getTemplateClass, getVariant, hasDependenciesVariants, init, init, removeVariant, resolveVariant, thisElementHasDepVariants, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsElementXml

public CmsElementXml(String className,
                     String templateName,
                     String readAccessGroup,
                     CmsCacheDirectives cd,
                     int variantCachesize)

Constructor for an element with the given class and template name.

CmsElementXml

public CmsElementXml(String className,
                     String templateName,
                     String readAccessGroup,
                     CmsCacheDirectives cd,
                     CmsElementDefinitionCollection defs,
                     int variantCachesize)

A construcor which creates an element with the given element definitions.

Parameters:

className - the classname of this element-definition.

readAccessGroup - The group that may read the element.

cd - Cache directives for this element

defs - CmsElementDefinitionCollection for this element.

Method Detail

getContent

public byte[] getContent(CmsElementCache elementCache,
                         CmsObject cms,
                         CmsElementDefinitionCollection elDefs,
                         String elementName,
                         Hashtable parameters,
                         String methodParameter)
                  throws CmsException

Get the content of this element.

Specified by:

getContent in class A_CmsElement

Parameters:

elementCache - Entry point for the element cache

cms - CmsObject for accessing system resources

elDefs - Definitions of this element's subelements

parameters - All parameters of this request

methodParameter - not used here, only methodelemets need it.

Returns:

Byte array with the processed content of this element.

Throws:

CmsException