Uses of Interface
org.craftercms.core.processors.ItemProcessor

Packages that use ItemProcessor

Package	Description
org.craftercms.core.processors
org.craftercms.core.processors.impl
org.craftercms.core.processors.impl.resolvers
org.craftercms.core.processors.impl.template
org.craftercms.core.service
org.craftercms.core.service.impl

Uses of ItemProcessor in org.craftercms.core.processors

Methods in org.craftercms.core.processors that return ItemProcessor

Modifier and Type	Method	Description
ItemProcessor	ItemProcessorResolver.getProcessor(Item item)	Returns a ItemProcessor for a given Item.

Uses of ItemProcessor in org.craftercms.core.processors.impl

Classes in org.craftercms.core.processors.impl that implement ItemProcessor

Modifier and Type	Class	Description
class	AbstractTaggingProcessor	Base ItemProcessor to add a new field to documents.
class	AttributeAddingProcessor	Created by alfonso on 2/21/17.
class	FieldRenamingProcessor	Created by alfonso on 2/21/17.
class	IncludeDescriptorsProcessor	ItemProcessor that finds special "include" tags found in a descriptor document and inserts there the document tree of descriptors specified in these "include" tags.
class	ItemProcessorPipeline	Pipeline of ItemProcessors.
class	ItemUrlTransformingProcessor	ItemProcessor that takes the item url, transforms it by calling the transformation engine, and places the transformed url in the properties.
class	PageAwareIncludeDescriptorsProcessor	Extension of IncludeDescriptorsProcessor that prevents pages from being included when disablePageInclusion is true.
class	SkipAllItemProcessor	No-op ItemProcessor exclusive implementation.
class	TaggingByFieldValueProcessor	ItemProcessor that adds a new tag or field to items that have a certain tag/field and value.
class	TaggingByPathProcessor	ItemProcessor that adds a new tag or field to items on specific paths.
class	TextMetaDataCollectionExtractingProcessor	ItemProcessor that extracts a list of text values from descriptor XPath-selected nodes and sets them as the properties of the item.
class	TextMetaDataExtractingProcessor	ItemProcessor that extracts single text values from descriptor XPath-selected nodes and sets them as the properties of the item.

Fields in org.craftercms.core.processors.impl declared as ItemProcessor

Modifier and Type	Field	Description
protected ItemProcessor	IncludeDescriptorsProcessor.includedItemsProcessor	Processor to use for included items.

Fields in org.craftercms.core.processors.impl with type parameters of type ItemProcessor

Modifier and Type	Field	Description
protected List<ItemProcessor>	ItemProcessorPipeline.processors	List of processors which conforms the pipeline

Methods in org.craftercms.core.processors.impl with parameters of type ItemProcessor

Modifier and Type	Method	Description
void	ItemProcessorPipeline.addProcessor(ItemProcessor processor)	Adds a processor to the pipeline of processors.
boolean	ItemProcessorPipeline.removeProcessor(ItemProcessor processor)	Removes a processor from the pipeline of processors.
void	IncludeDescriptorsProcessor.setIncludedItemsProcessor(ItemProcessor includedItemsProcessor)	Sets the processor to use for included items.

Method parameters in org.craftercms.core.processors.impl with type arguments of type ItemProcessor

Modifier and Type	Method	Description
void	ItemProcessorPipeline.addProcessors(Collection<ItemProcessor> processors)	Adds several processors to the pipeline of processors.
void	ItemProcessorPipeline.setProcessors(List<ItemProcessor> processors)	Sets the list of processors.

Constructors in org.craftercms.core.processors.impl with parameters of type ItemProcessor

Modifier	Constructor	Description
	ItemProcessorPipeline(ItemProcessor... processors)	Constructor that receives the list of processors (as an array) which conform the pipeline.

Constructor parameters in org.craftercms.core.processors.impl with type arguments of type ItemProcessor

Modifier	Constructor	Description
	ItemProcessorPipeline(List<ItemProcessor> processors)	Constructor that receives the list of processors which conform the pipeline.

Uses of ItemProcessor in org.craftercms.core.processors.impl.resolvers

Fields in org.craftercms.core.processors.impl.resolvers declared as ItemProcessor

Modifier and Type	Field	Description
protected ItemProcessor	ItemProcessorResolverChain.defaultProcessor	The default processor to use if no resolver returns a processor.

Fields in org.craftercms.core.processors.impl.resolvers with type parameters of type ItemProcessor

Modifier and Type	Field	Description
protected Map<String,ItemProcessor>	MetaDataProcessorResolver.elementValueToProcessorMappings	Mappings of processor element values to processor names.
protected Map<String,ItemProcessor>	UrlPatternProcessorResolver.patternToProcessorMappings	Mappings of url patterns to processor names.

Methods in org.craftercms.core.processors.impl.resolvers that return ItemProcessor

Modifier and Type	Method	Description
ItemProcessor	ItemProcessorResolverChain.getProcessor(Item item)	Returns the ItemProcessor to use for the given item.
ItemProcessor	MetaDataProcessorResolver.getProcessor(Item item)	Looks for the processor element (by querying it with the processorElementXPathQuery) in the item's descriptor.
ItemProcessor	SingleProcessorResolver.getProcessor(Item item)	Returns the same processor for any item.
ItemProcessor	UrlPatternProcessorResolver.getProcessor(Item item)	If the item url matches one of the patterns defined in patternToProcessorMappings, the processor mapped to that pattern is returned.

Methods in org.craftercms.core.processors.impl.resolvers with parameters of type ItemProcessor

Modifier and Type	Method	Description
void	ItemProcessorResolverChain.setDefaultProcessor(ItemProcessor defaultProcessor)	Sets the default to use if no resolver returns a processor.
void	SingleProcessorResolver.setProcessor(ItemProcessor processor)	Sets the processor to always return.

Method parameters in org.craftercms.core.processors.impl.resolvers with type arguments of type ItemProcessor

Modifier and Type	Method	Description
void	MetaDataProcessorResolver.setElementValueToProcessorMappings(Map<String,ItemProcessor> elementValueToProcessorMappings)	Sets the mappings of processor element values to processor names.
void	UrlPatternProcessorResolver.setPatternToProcessorMappings(Map<String,ItemProcessor> patternToProcessorMappings)	Sets the mappings of url patterns to processor names.

Uses of ItemProcessor in org.craftercms.core.processors.impl.template

Classes in org.craftercms.core.processors.impl.template that implement ItemProcessor

Modifier and Type	Class	Description
class	TemplateProcessor	ItemProcessor that processes the content of certain XML nodes in item descriptors as templates.

Uses of ItemProcessor in org.craftercms.core.service

Methods in org.craftercms.core.service with parameters of type ItemProcessor

Modifier and Type	Method	Description
default List<Item>	ContentStoreService.findChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor)	Returns the children of the folder at the given url, returning null if the folder can't be found.
List<Item>	ContentStoreService.findChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor, boolean flatten)	Returns the children of the folder at the given url, returning null if the folder can't be found.
default Item	ContentStoreService.findItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor)	Returns the content store item for the given url, returning null if not found.
Item	ContentStoreService.findItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor, boolean flatten)	Returns the content store item for the given url, returning null if not found.
default Tree	ContentStoreService.findTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor)	Returns the folder at the given url as a tree, or null if the folder wasn't found.
Tree	ContentStoreService.findTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor, boolean flatten)	Returns the folder at the given url as a tree, or null if the folder wasn't found.
default List<Item>	ContentStoreService.getChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor)	Returns the children of the folder at the given url.
List<Item>	ContentStoreService.getChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor, boolean flatten)	Returns the children of the folder at the given url.
default Item	ContentStoreService.getItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor)	Returns the content store item for the given url.
Item	ContentStoreService.getItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor, boolean flatten)	Returns the content store item for the given url.
default Tree	ContentStoreService.getTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor)	Returns the folder at the given url as a tree.
Tree	ContentStoreService.getTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor, boolean flatten)	Returns the folder at the given url as a tree.

Uses of ItemProcessor in org.craftercms.core.service.impl

Fields in org.craftercms.core.service.impl declared as ItemProcessor

Modifier and Type	Field	Description
protected ItemProcessor	AbstractCachedContentStoreService.flatteningProcessor	Item processor used for flattening descriptors

Methods in org.craftercms.core.service.impl that return ItemProcessor

Modifier and Type	Method	Description
protected ItemProcessor	AbstractCachedContentStoreService.getProcessor(ItemProcessor processor, boolean flatten)

Methods in org.craftercms.core.service.impl with parameters of type ItemProcessor

Modifier and Type	Method	Description
protected abstract List<Item>	AbstractCachedContentStoreService.doFindChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor, boolean flatten)
protected List<Item>	ContentStoreServiceImpl.doFindChildren(Context context, CachingOptions cachingOptions, String url, Integer depth, ItemFilter filter, ItemProcessor processor, boolean flatten)	Does the following: Retrieves the children from the underlying repository (without their descriptors). Filters the returned list if ItemFilter.runBeforeProcessing() returns true. Calls ContentStoreService.getTree(Context, String) or ContentStoreService.getItem(Context, String) for each item in the list (depending on whether the item is a folder or not, and if depth is not null), to obtain the merged and processed version of each item. Filters the processed list if ItemFilter.runAfterProcessing() returns true. Returns the final list of processed items.
protected List<Item>	ContentStoreServiceImpl.doFindChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor, boolean flatten)
protected abstract Item	AbstractCachedContentStoreService.doFindItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor)
protected Item	ContentStoreServiceImpl.doFindItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor)	Returns the content store item for the given url, returning null if not found.
protected abstract Tree	AbstractCachedContentStoreService.doFindTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor, boolean flatten)
protected Tree	ContentStoreServiceImpl.doFindTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor, boolean flatten)
protected Item	ContentStoreServiceImpl.doProcessing(Context context, CachingOptions cachingOptions, Item item, ItemProcessor additionalProcessor)	Executes processing for the specified Item: Gets the main ItemProcessor for the item from the ItemProcessorResolver. Calls the main processor's process method to process the item. If an additional processor was passed to this method, the additional processor is also called. Returns the processed item.
List<Item>	AbstractCachedContentStoreService.findChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor, boolean flatten)
Item	AbstractCachedContentStoreService.findItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor, boolean flatten)
Tree	AbstractCachedContentStoreService.findTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor, boolean flatten)
List<Item>	AbstractCachedContentStoreService.getChildren(Context context, CachingOptions cachingOptions, String url, ItemFilter filter, ItemProcessor processor, boolean flatten)
protected List<Item>	ContentStoreServiceImpl.getChildrenInternal(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor, boolean flatten)	This method is meant to be overridden when the children need to be further processed/filtered
Item	AbstractCachedContentStoreService.getItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor, boolean flatten)
protected ItemProcessor	AbstractCachedContentStoreService.getProcessor(ItemProcessor processor, boolean flatten)
Tree	AbstractCachedContentStoreService.getTree(Context context, CachingOptions cachingOptions, String url, int depth, ItemFilter filter, ItemProcessor processor, boolean flatten)
void	AbstractCachedContentStoreService.setFlatteningProcessor(ItemProcessor flatteningProcessor)