org.orbeon.oxf.processor
Class ProcessorImpl.CacheableTransformerOutputImpl

java.lang.Object
  extended by org.orbeon.oxf.processor.ProcessorImpl.ProcessorOutputImpl
      extended by org.orbeon.oxf.processor.ProcessorImpl.CacheableTransformerOutputImpl
All Implemented Interfaces:
org.orbeon.oxf.cache.Cacheable, org.orbeon.oxf.processor.ProcessorInputOutput, org.orbeon.oxf.processor.ProcessorOutput, org.orbeon.oxf.processor.ProcessorReader
Direct Known Subclasses:
ProcessorImpl.DigestTransformerOutputImpl
Enclosing class:
ProcessorImpl

public abstract class ProcessorImpl.CacheableTransformerOutputImpl
extends ProcessorImpl.ProcessorOutputImpl

Implementation of a caching transformer output that assumes that an output simply depends on all the inputs plus optional local information. It is possible to implement local key and validity information as well, that represent data not coming from an XML input. If any input is connected to an output that is not cacheable, a null key is returned. Use DigestTransformerOutputImpl whenever possible.


Constructor Summary
ProcessorImpl.CacheableTransformerOutputImpl(Class clazz, String name)
           
 
Method Summary
 org.orbeon.oxf.cache.OutputCacheKey getKeyImpl(PipelineContext pipelineContext)
           
protected  org.orbeon.oxf.cache.CacheKey getLocalKey(PipelineContext pipelineContext)
           
protected  Object getLocalValidity(PipelineContext pipelineContext)
           
 Object getValidityImpl(PipelineContext pipelineContext)
           
protected  boolean supportsLocalKeyValidity()
          Processor outputs that use the local key/validity feature must override this method and return true.
 
Methods inherited from class org.orbeon.oxf.processor.ProcessorImpl.ProcessorOutputImpl
getDebugMessage, getId, getInput, getKey, getKeyValidityImpl, getLocationData, getName, getProcessorClass, getSchema, getValidity, read, readImpl, setBreakpointKey, setDebug, setId, setInput, setLocationData, setSchema
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProcessorImpl.CacheableTransformerOutputImpl

public ProcessorImpl.CacheableTransformerOutputImpl(Class clazz,
                                                    String name)
Method Detail

supportsLocalKeyValidity

protected boolean supportsLocalKeyValidity()
Processor outputs that use the local key/validity feature must override this method and return true.


getLocalKey

protected org.orbeon.oxf.cache.CacheKey getLocalKey(PipelineContext pipelineContext)

getLocalValidity

protected Object getLocalValidity(PipelineContext pipelineContext)

getKeyImpl

public org.orbeon.oxf.cache.OutputCacheKey getKeyImpl(PipelineContext pipelineContext)
Overrides:
getKeyImpl in class ProcessorImpl.ProcessorOutputImpl

getValidityImpl

public Object getValidityImpl(PipelineContext pipelineContext)
Overrides:
getValidityImpl in class ProcessorImpl.ProcessorOutputImpl