|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.avalon.framework.logger.AbstractLogEnabled
org.apache.cocoon.xml.AbstractXMLProducer
org.apache.cocoon.generation.AbstractGenerator
org.apache.cocoon.generation.ServiceableGenerator
org.apache.cocoon.template.JXTemplateGenerator
Field Summary | |
static String |
CACHE_KEY
|
static String |
NS
The namespace used by this generator |
static String |
VALIDITY
|
Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator |
manager |
Fields inherited from class org.apache.cocoon.generation.AbstractGenerator |
objectModel, parameters, resolver, source |
Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer |
contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer |
Fields inherited from interface org.apache.cocoon.generation.Generator |
ROLE |
Constructor Summary | |
JXTemplateGenerator()
|
Method Summary | |
void |
dispose()
Release all resources. |
void |
generate()
Generate the XML and stream it into the pipeline |
XMLConsumer |
getConsumer()
|
Serializable |
getKey()
Generate the unique key for the resource being rendered. |
SourceValidity |
getValidity()
Generate the validity object. |
void |
performGeneration(Event startEvent,
Event endEvent)
|
void |
recycle()
Recycle the generator by removing references |
void |
service(ServiceManager manager)
Set the current ServiceManager instance used by this
Serviceable . |
void |
setup(SourceResolver resolver,
Map objectModel,
String src,
Parameters parameters)
Set the SourceResolver , object model Map ,
the source and sitemap Parameters used to process the request. |
Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer |
setConsumer, setContentHandler, setLexicalHandler |
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled |
enableLogging, getLogger, setupLogger, setupLogger, setupLogger |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.cocoon.xml.XMLProducer |
setConsumer |
Field Detail |
public static final String NS
public static final String CACHE_KEY
public static final String VALIDITY
Constructor Detail |
public JXTemplateGenerator()
Method Detail |
public XMLConsumer getConsumer()
public void service(ServiceManager manager) throws ServiceException
ServiceableGenerator
ServiceManager
instance used by this
Serviceable
.
service
in interface Serviceable
service
in class ServiceableGenerator
ServiceException
public void dispose()
ServiceableGenerator
dispose
in interface Disposable
dispose
in class ServiceableGenerator
public void recycle()
AbstractGenerator
recycle
in interface Recyclable
recycle
in class AbstractGenerator
public void setup(SourceResolver resolver, Map objectModel, String src, Parameters parameters) throws ProcessingException, SAXException, IOException
AbstractGenerator
SourceResolver
, object model Map
,
the source and sitemap Parameters
used to process the request.
setup
in interface SitemapModelComponent
setup
in class AbstractGenerator
ProcessingException
SAXException
IOException
public void generate() throws IOException, SAXException, ProcessingException
Generator
generate
in interface Generator
IOException
SAXException
ProcessingException
public void performGeneration(Event startEvent, Event endEvent) throws SAXException
SAXException
public Serializable getKey()
CacheableProcessingComponent
The cache key is the single most important part of the caching implementation. If you don't get it right, you can introduce more load on the caching engine than is necessary. It is important that the cache key has the following attributes:
Thankfully there is a perfectly suitable object that satisfies these
obligations from Java's core: java.lang.String
. You can
also use your own specific key objects provided they respect the above
contracts.
Important:If the cache key is null
then
your component will not be cached at all. You can use this to your
advantage to cache some things but not others.
getKey
in interface CacheableProcessingComponent
null
if the component
is currently not cacheable.public SourceValidity getValidity()
CacheableProcessingComponent
getKey()
method.
The caching contracts use the Excalibur SourceValidity
interface to determine whether a resource is valid or not. The validity
can be a compound check that incorporates time since creation, parameter
values, etc. As long as the sitemap can determine whether the cached
resource is valid or not. More information is available on the
Apache
Excalibur site. Alternatively you can use the built in
CacheValidity
objects in the
org.apache.cocoon.caching
package and then use the
CacheValidityToSourceValidity
adaptor object.
getValidity
in interface CacheableProcessingComponent
null
if the
component is currently not cacheable.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |