org.craftercms.core.processors

Interface ItemProcessor

All Known Implementing Classes:

AbstractTaggingProcessor, AttributeAddingProcessor, FieldRenamingProcessor, IncludeDescriptorsProcessor, ItemProcessorPipeline, ItemUrlTransformingProcessor, TaggingByFieldValueProcessor, TaggingByPathProcessor, TemplateProcessor, TextMetaDataCollectionExtractingProcessor, TextMetaDataExtractingProcessor

public interface ItemProcessor

Processes an Item, by applying any needed modification to it.

Author:

Sumer Jabri, Alfonso Vásquez

Method Summary

Modifier and Type	Method and Description
Item	process(Context context, CachingOptions cachingOptions, Item item) Processes an Item.

Method Detail

process

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

Processes an Item.

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