org.apache.cocoon.caching: public interface: CacheableProcessingComponent

org.apache.cocoon.caching
public interface: CacheableProcessingComponent [javadoc | source]

All Known Implementing Classes:
ServerPagesGenerator, EventAwareGenerator, ValidationReportTransformer, I18nTransformer, RoleFilterTransformer, XMLSerializer, TextGenerator, XMLDBCollectionGenerator, DirectoryGenerator, XMLDBGenerator, LuceneIndexTransformer, XPathTraversableGenerator, HTMLGenerator, DeliTransformer, XIncludeTransformer, TraversableSourceDescriptionGenerator, ResourceReader, RSSTransformer, AbstractServerPage, EncodeURLTransformer, AbstractTextSerializer, SWFGenerator, FOPSerializer, AsciiArtSVGGenerator, EventAwareReader, XMLDBTransformer, FilterTransformer, HTMLSerializer, StripNameSpacesTransformer, SlopGenerator, iTextSerializer, JXTemplateGenerator, XPathDirectoryGenerator, TextSerializer, SVGSerializer, ImageReader, MP3DirectoryGenerator, PythonGenerator, XSPGenerator, RTFSerializer, ImageDirectoryGenerator, CSVGenerator, HTMLRootTransformer, JSGenerator, EventCacheGenerator, LinkTranslator, IncludeTransformer, PortalToolsI18nTransformer, FragmentExtractorTransformer, ExtendedParserTransformer, TraxTransformer, NekoHTMLGenerator, WebDAVTransformer, DatabaseReader, PatternTransformer, TraversableGenerator, CleanupTransformer, CIncludeTransformer, FragmentExtractorGenerator, LinkGatherer, ImageOpReader, LexicalTransformer, ParserTransformer, ContentAggregator, IncludingHTMLSerializer, CalendarGenerator, DASLTransformer, Paginator, ValidatingTransformer, JXTemplateGenerator, FileGenerator

This marker interface declares a (sitemap) component as cacheable. This interface deprecates the org.apache.cocoon.caching.Cacheable interface!

since: 2.1 -

author: < - a href="mailto:cziegeler@apache.org">Carsten Ziegeler

version: CVS - $Id: CacheableProcessingComponent.java 433543 2006-08-22 06:22:54Z crossley $

Method from org.apache.cocoon.caching.CacheableProcessingComponent Summary:
getKey, getValidity

Method from org.apache.cocoon.caching.CacheableProcessingComponent Detail:
public Serializable getKey() Generate the unique key. This key must be unique inside the space of this component. This method must be invoked before the getValidity() method.
public SourceValidity getValidity() Generate the validity object. Before this method can be invoked the getKey() method must be invoked.

Method from org.apache.cocoon.caching.CacheableProcessingComponent Detail:

 public Serializable getKey()Generate the unique key.
This key must be unique inside the space of this component.
This method must be invoked before the getValidity() method.

 public SourceValidity getValidity()Generate the validity object.
Before this method can be invoked the getKey() method
must be invoked.