info.magnolia.imaging.caching

Class AbstractNodeBasedCachingStrategy<P>

java.lang.Object

info.magnolia.imaging.caching.AbstractNodeBasedCachingStrategy<P>

Type Parameters:

P - type of ParameterProvider's parameter

All Implemented Interfaces:

CachingStrategy<P>

Direct Known Subclasses:

NodeBasedCachingStrategy

public abstract class AbstractNodeBasedCachingStrategy<P>
extends Object
implements CachingStrategy<P>

Superclass for Node-based CachingStrategy/ies.

Constructor Summary

Constructors

Constructor and Description
AbstractNodeBasedCachingStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
String	getCachePath(ImageGenerator<ParameterProvider<P>> generator, ParameterProvider<P> parameterProvider) Returns a unique path pertinent to the given generator and parameter to use for storing the generated image.
protected abstract javax.jcr.Node	getContent(P param)
protected abstract String	getPathOf(P param)
protected abstract String	getWorkspaceName(P param)
boolean	shouldRegenerate(info.magnolia.cms.core.NodeData cachedBinary, ParameterProvider<P> parameterProvider) The default implementation simply delegates this decision to ParameterProvider.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNodeBasedCachingStrategy

public AbstractNodeBasedCachingStrategy()

Method Detail

getCachePath

public String getCachePath(ImageGenerator<ParameterProvider<P>> generator,
                  ParameterProvider<P> parameterProvider)

Description copied from interface: CachingStrategy

Returns a unique path pertinent to the given generator and parameter to use for storing the generated image. Returns null if the implementation determines caching should not occur.

Specified by:

getCachePath in interface CachingStrategy<P>

shouldRegenerate

public boolean shouldRegenerate(info.magnolia.cms.core.NodeData cachedBinary,
                       ParameterProvider<P> parameterProvider)

The default implementation simply delegates this decision to ParameterProvider.

Specified by:

shouldRegenerate in interface CachingStrategy<P>

Returns:

true if the image should be regenerated.

getWorkspaceName

protected abstract String getWorkspaceName(P param)

getContent

protected abstract javax.jcr.Node getContent(P param)

getPathOf

protected abstract String getPathOf(P param)