Package org.craftercms.core.processors.impl

Class ItemUrlTransformingProcessor

java.lang.Object

org.craftercms.core.processors.impl.ItemUrlTransformingProcessor

All Implemented Interfaces:

ItemProcessor

public class ItemUrlTransformingProcessor
extends Object
implements ItemProcessor

ItemProcessor that takes the item url, transforms it by calling the transformation engine, and places the transformed url in the properties.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field	Description
protected String	transformedUrlPropName
protected String	transformerName
protected UrlTransformationEngine	urlTransformationEngine

Constructor Summary

Constructors

Constructor	Description
ItemUrlTransformingProcessor()

Method Summary

Modifier and Type	Method	Description
Item	process(Context context, CachingOptions cachingOptions, Item item)	Processes an Item.
void	setTransformedUrlPropName(String transformedUrlPropName)
void	setTransformerName(String transformerName)
void	setUrlTransformationEngine(UrlTransformationEngine urlTransformationEngine)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.craftercms.core.processors.ItemProcessor

isExclusive

Field Details

transformedUrlPropName

protected String transformedUrlPropName

transformerName

protected String transformerName

urlTransformationEngine

protected UrlTransformationEngine urlTransformationEngine

Constructor Details

ItemUrlTransformingProcessor

public ItemUrlTransformingProcessor()

Method Details

setTransformedUrlPropName

public void setTransformedUrlPropName(String transformedUrlPropName)

setTransformerName

public void setTransformerName(String transformerName)

setUrlTransformationEngine

public void setUrlTransformationEngine(UrlTransformationEngine urlTransformationEngine)

process

public Item process(Context context,
 CachingOptions cachingOptions,
 Item item)
             throws ItemProcessingException

Description copied from interface: ItemProcessor

Processes an Item.

Specified by:

process in interface ItemProcessor

Parameters:

context - the current context

cachingOptions - caching options in case you need access to items

item - the item to process

Returns:

the modified item or a new item.

Throws:

ItemProcessingException - if an error occurred while processing the item

toString

public String toString()

Overrides:

toString in class Object