Home >> All >> com >> opencms >> [ template Javadoc ]

•	com.opencms.template.cache.* (17)

• com.opencms.template: Javadoc index of package com.opencms.template.


Package Samples:

• com.opencms.template.cache: The OpenCms XMLTemplate mechanism is implemented in this package.  

Classes:

• A_CmsXmlContent: Abstract class for OpenCms files with XML content. This class implements basic functionality for OpenCms XML files. For each XML file content type (e.g. XML template files, XML control files, XML news article files, ...) a customized class extending this abstract class has to be implemented. The functionality of this class is: control the XML parser recognize and handle special XML tags used in OpenCms environment cache parsed documents, so that that they can be re-used provide methods to access XML data After creating a new instance of the children of this class it has to be initialized by calling ...
• I_CmsXmlTemplate: Interface for OpenCms XML template classes. All methods extending the functionality of the common template class interface to the special behaviour of XML template classes may be defined here. Primarily, this interface is important for the launcher, NOT for the template engine. The CmsXmlLauncher can launch all templates that implement the I_CmsXmlTemplate interface. For subtemplates, the I_CmsTemplate interface is all that must be implemented, so you can load all kind of templates (eg. type I_CmsDumpTemplate) as subtemplate.
• CmsElementCache: This is the starting class for OpenCms element cache. Element cache was implemented for performance issues. The idea is to create a flat hirarchie of elements that can be accessed fast and efficient for the frontend users in the online project. On publishing-time the data in the element cache area will be created or updated. All inefficiant XML-files are changed to the efficient element cache data structure. For createing the content no XML-parsing and DOM-accessing is neccessairy.
• CmsProcessedString: Special class for String results returned in template engine. Template objects should use this class instead of String if they have written their results to the response output stream theirselves (if the system is in streaming mode). If an object doesn't care about HTTP streaming and simply generates a String for returning to the template engine, it really shouldn't make use of this class and return the original String.
• CmsLruCache: This class implements a LRU cache. It uses a Hashtable algorithm with the chaining method for collision handling. The sequence of the Objects is stored in an extra chain. Each object has a pointer to the previous and next object in this chain. If an object is inserted or used it is set to the tail of the chain. If an object has to be remouved it will be the head object. Only works with more than one element.
• CmsElementDump: An instance of CmsElementDump represents an requestable dump 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. This special case of an element doesn't point to other depending elements. It may only be used for dumping plain text or binary data.
• I_CmsDumpTemplate: Interface for OpenCms dump template classes. All methods extending the functionality of the common template class interface to the special behaviour of dump template classes may be defined here. Primarily, this interface is important for the launcher, NOT for the template engine. The CmsDumpLauncher can launch all templates that implement the I_CmsDumpTemplate interface.
• A_CmsElement: An instance of A_CmsElement 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 may point to other depending elements. Theses elements are called to generate their content on generation-time.
• CmsElementXml: 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.
• CmsTimeout: This class is used in the CmsCacheDirectives. If an element can be cached for a specific time, a CmsTimeout must be set. It is planned to have diffrent modi for this Class. In this moment we have only one mode: 0: use the constructor with int x. It means the element has to be new generated at 00:00 and then every x minutes.
• CmsUri: An instance of CmsUri represents an requestable ressource in the OpenCms element cache area. It points to the starting element and handles the access- checks to this ressource in a simple way. If access is granted for the current user it starts the startingElement to process the content of this ressource.
• CmsElementLocator: The ElementLocator is used to receive CmsElement-Objects. It is the Cache for these CmsElement-Objects. The CmsElement-Objects are stored in memory or - if they are notc used a long time - written to an external database. The locator manages all the reading, writing and management of the CmsElement's.
• CmsUriLocator: The UriLocator is used to receive CmsUri-Objects. It is the Cache for these CmsUri-Objects. The CmsUri-Objects are stored in memory or - if they are not used a long time written to an external database. The locator manages all the reading, writing and management of the CmsUri's.
• CmsElementDefinition: An instance of CmsElementDefinitions represents an "pointer" to other elements. This pointers are stored in CmsElement's. An ElementDfinitions stores information about an element, like the name, className, templateName and parameters for the pointed element.
• CmsMethodElement: An instance of CmsMethodElement represents an special method Element in the OpenCms element cache area. It contains all informations to generate the output of this method. It also stores the variants of once generated content to speed up performance.
• CmsElementVariant: An instance of CmsElementVariant stores a single cached variant for an element. This is the generated output (content) of an element. This cache stores all generated strings of this element and all links to other elements.
• CmsElementLink: An instance of CmsElementLink is a link to another element. The link contains only the name of the linked element. Which element is linked will be determinded during the runtime of the content-creation (getContent-method).
• CmsRootTemplate: Represents an "empty" page or screen that should be filled with the content of a master template. Every launcher uses this canonical root the invoke the output generation of the master template class to be used.
• CmsTemplateClassManager: Class for managing of the instances of all OpenCms template classes. This class provides methods for getting the instance of a class. Once a instance of a template class is build, it is be cached and re-used.
• CmsDumpTemplate: Template class for dumping files to the output without further interpreting or processing. This can be used for plain text files or files containing graphics.
• I_CmsTemplate: Common interface for OpenCms template classes. Classes and interfaces for each customized template type have to be implemtented.
• I_CmsContent: Common interface for OpenCms content classes. Almost empty. Classes for each customized content type have to be implemetented.
• CmsXmlTemplate: Template class for displaying the processed contents of hierachical XML template files that can include other subtemplates.
• CmsElementDefinitionCollection: Used to collect a set of element definitions. Two CmsElementDefinitionCollections can be merged using the join constructor.
• I_CmsXmlParser: Common interface for OpenCms XML parsers. Classes and interfaces for each customized parser type have to be implemtented.

Home | Contact Us | Privacy Policy | Terms of Service