Uses of Class
org.craftercms.core.service.Item

Packages that use Item

Package	Description
org.craftercms.core.controller.rest
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
org.craftercms.core.store
org.craftercms.core.store.impl

Uses of Item in org.craftercms.core.controller.rest

Methods in org.craftercms.core.controller.rest that return Item

Modifier and Type	Method	Description
Item	ContentStoreRestController.getItem(org.springframework.web.context.request.WebRequest request, javax.servlet.http.HttpServletResponse response, String contextId, String url, boolean flatten)

Methods in org.craftercms.core.controller.rest that return types with arguments of type Item

Modifier and Type	Method	Description
List<Item>	ContentStoreRestController.getChildren(org.springframework.web.context.request.WebRequest request, javax.servlet.http.HttpServletResponse response, String contextId, String url, boolean flatten)

Uses of Item in org.craftercms.core.processors

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

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

Methods in org.craftercms.core.processors with parameters of type Item

Modifier and Type	Method	Description
ItemProcessor	ItemProcessorResolver.getProcessor(Item item)	Returns a ItemProcessor for a given Item.
Item	ItemProcessor.process(Context context, CachingOptions cachingOptions, Item item)	Processes an Item.

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

Methods in org.craftercms.core.processors.impl that return Item

Modifier and Type	Method	Description
protected Item	IncludeDescriptorsProcessor.getItemToInclude(Context context, CachingOptions cachingOptions, String includeSrcPath)
Item	AbstractTaggingProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	AttributeAddingProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	FieldRenamingProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	IncludeDescriptorsProcessor.process(Context context, CachingOptions cachingOptions, Item item)	Replaces special include tags found in a descriptor document with the document tree of descriptors specified in these include tags.
Item	ItemProcessorPipeline.process(Context context, CachingOptions cachingOptions, Item item)	Processes the given Item, by calling a pipeline of processors.
Item	ItemUrlTransformingProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	SkipAllItemProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	TextMetaDataCollectionExtractingProcessor.process(Context context, CachingOptions cachingOptions, Item item)	For every XPath query provided in metaDataNodesXPathQueries, a list of nodes is selected and for each one of these nodes its text value is extracted and added to a list that is later put in the item's properties.
Item	TextMetaDataExtractingProcessor.process(Context context, CachingOptions cachingOptions, Item item)	For every XPath query provided in metaDataNodesXPathQueries, a single node is selected and its text value is extracted and put in the item's properties.

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

Modifier and Type	Method	Description
protected void	AbstractTaggingProcessor.addNewField(Item item, String values)	Tags the item adding the new field with the specified values.
protected void	IncludeDescriptorsProcessor.doInclude(Item item, org.dom4j.Element includeElement, Item itemToInclude)
protected abstract String	AbstractTaggingProcessor.getTagValues(Item item)	If this method returns null or an empty string the item will not be tagged.
protected String	TaggingByFieldValueProcessor.getTagValues(Item item)
protected String	TaggingByPathProcessor.getTagValues(Item item)
protected void	IncludeDescriptorsProcessor.includeDescriptors(Context context, CachingOptions cachingOptions, Item item)
Item	AbstractTaggingProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	AttributeAddingProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	FieldRenamingProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	IncludeDescriptorsProcessor.process(Context context, CachingOptions cachingOptions, Item item)	Replaces special include tags found in a descriptor document with the document tree of descriptors specified in these include tags.
Item	ItemProcessorPipeline.process(Context context, CachingOptions cachingOptions, Item item)	Processes the given Item, by calling a pipeline of processors.
Item	ItemUrlTransformingProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	SkipAllItemProcessor.process(Context context, CachingOptions cachingOptions, Item item)
Item	TextMetaDataCollectionExtractingProcessor.process(Context context, CachingOptions cachingOptions, Item item)	For every XPath query provided in metaDataNodesXPathQueries, a list of nodes is selected and for each one of these nodes its text value is extracted and added to a list that is later put in the item's properties.
Item	TextMetaDataExtractingProcessor.process(Context context, CachingOptions cachingOptions, Item item)	For every XPath query provided in metaDataNodesXPathQueries, a single node is selected and its text value is extracted and put in the item's properties.

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

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

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.

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

Methods in org.craftercms.core.processors.impl.template that return Item

Modifier and Type	Method	Description
Item	TemplateProcessor.process(Context context, CachingOptions cachingOptions, Item item)	Processes the content of certain nodes (found by the NodeScanner in the item's descriptor as templates, by compiling the node text templates through the templateCompiler and then processing the compiled template with a model returned by modelFactory.

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

Modifier and Type	Method	Description
Object	BeanFactoryModelFactory.getModel(Item item, org.dom4j.Node node, String template)	Returns always the BeanFactory of the current Spring application context as the model.
Object	NodeTemplateModelFactory.getModel(Item item, org.dom4j.Node node, String template)	Returns the model for a given template of a given node.
Item	TemplateProcessor.process(Context context, CachingOptions cachingOptions, Item item)	Processes the content of certain nodes (found by the NodeScanner in the item's descriptor as templates, by compiling the node text templates through the templateCompiler and then processing the compiled template with a model returned by modelFactory.

Uses of Item in org.craftercms.core.service

Subclasses of Item in org.craftercms.core.service

Modifier and Type	Class	Description
class	Tree	Folder Item that also contains it's children.

Fields in org.craftercms.core.service with type parameters of type Item

Modifier and Type	Field	Description
protected List<Item>	Tree.children	The folder's children.

Methods in org.craftercms.core.service that return Item

Modifier and Type	Method	Description
default Item	ContentStoreService.findItem(Context context, String url)	Returns the content store item for the given url, returning null if not 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 Item	ContentStoreService.getItem(Context context, String url)	Returns the content store item for 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.

Methods in org.craftercms.core.service that return types with arguments of type Item

Modifier and Type	Method	Description
default List<Item>	ContentStoreService.findChildren(Context context, String url)	Returns the children of the folder at the given url, returning null if the folder can't be found.
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 List<Item>	ContentStoreService.getChildren(Context context, String url)	Returns the children of the folder at the given url.
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.
List<Item>	Tree.getChildren()	Returns the tree's children.

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

Modifier and Type	Method	Description
boolean	ItemFilter.accepts(Item item, List<Item> acceptedItems, List<Item> rejectedItems, boolean runningBeforeProcessing)	Return true if the given item is accepted by the filter.
void	Tree.addChild(Item child)	Adds a child.
boolean	Tree.removeChild(Item child)	Removes a child.

Method parameters in org.craftercms.core.service with type arguments of type Item

Modifier and Type	Method	Description
boolean	ItemFilter.accepts(Item item, List<Item> acceptedItems, List<Item> rejectedItems, boolean runningBeforeProcessing)	Return true if the given item is accepted by the filter.
void	Tree.setChildren(List<Item> children)	Sets the tree's children.

Constructors in org.craftercms.core.service with parameters of type Item

Modifier	Constructor	Description
	Item(Item item)	Copy constructor.
	Item(Item item, boolean deepCopy)	Copy constructor.
	Tree(Item item)	Copy constructor that takes an item and calls the Item(Item).
	Tree(Item item, boolean deepCopy)	Copy constructor that takes an item and calls the Item(Item, boolean).

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

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

Modifier and Type	Method	Description
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 Item	ContentStoreServiceImpl.doMerging(Context context, CachingOptions cachingOptions, Item item)	Executes merging for the specified Item: Gets the DescriptorMergeStrategy for the item's descriptor from the DescriptorMergeStrategyResolver. Gets the actual descriptors to merge from the returned merge strategy. Retrieves the descriptor documents from the underlying repository. Merges the descriptor documents. Returns the item with the merged descriptor document.
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.
Item	AbstractCachedContentStoreService.findItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor, boolean flatten)
Item	AbstractCachedContentStoreService.getItem(Context context, CachingOptions cachingOptions, String url, ItemProcessor processor, boolean flatten)

Methods in org.craftercms.core.service.impl that return types with arguments of type Item

Modifier and Type	Method	Description
protected List<Item>	ContentStoreServiceImpl.doFilter(List<Item> items, ItemFilter filter, boolean runningBeforeProcessing)	Filters the given list of items by using the specified filter.
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)
List<Item>	AbstractCachedContentStoreService.findChildren(Context context, CachingOptions cachingOptions, String url, 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

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

Modifier and Type	Method	Description
boolean	CompositeItemFilter.accepts(Item item, List<Item> acceptedItems, List<Item> rejectedItems, boolean runningBeforeProcessing)	If runningBeforeProcessing is true, calls all filters that need to be run before processing.
boolean	ExcludeByUrlItemFilter.accepts(Item item, List<Item> acceptedItems, List<Item> rejectedItems, boolean runningBeforeProcessing)
boolean	IncludeByUrlItemFilter.accepts(Item item, List<Item> acceptedItems, List<Item> rejectedItems, boolean runningBeforeProcessing)
protected Item	ContentStoreServiceImpl.doMerging(Context context, CachingOptions cachingOptions, Item item)	Executes merging for the specified Item: Gets the DescriptorMergeStrategy for the item's descriptor from the DescriptorMergeStrategyResolver. Gets the actual descriptors to merge from the returned merge strategy. Retrieves the descriptor documents from the underlying repository. Merges the descriptor documents. Returns the item with the merged descriptor document.
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.

Method parameters in org.craftercms.core.service.impl with type arguments of type Item

Modifier and Type	Method	Description
boolean	CompositeItemFilter.accepts(Item item, List<Item> acceptedItems, List<Item> rejectedItems, boolean runningBeforeProcessing)	If runningBeforeProcessing is true, calls all filters that need to be run before processing.
boolean	ExcludeByUrlItemFilter.accepts(Item item, List<Item> acceptedItems, List<Item> rejectedItems, boolean runningBeforeProcessing)
boolean	IncludeByUrlItemFilter.accepts(Item item, List<Item> acceptedItems, List<Item> rejectedItems, boolean runningBeforeProcessing)
protected List<Item>	ContentStoreServiceImpl.doFilter(List<Item> items, ItemFilter filter, boolean runningBeforeProcessing)	Filters the given list of items by using the specified filter.

Uses of Item in org.craftercms.core.store

Methods in org.craftercms.core.store that return Item

Modifier and Type	Method	Description
Item	ContentStoreAdapter.findItem(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor)

Methods in org.craftercms.core.store that return types with arguments of type Item

Modifier and Type	Method	Description
List<Item>	ContentStoreAdapter.findItems(Context context, CachingOptions cachingOptions, String path)

Uses of Item in org.craftercms.core.store.impl

Methods in org.craftercms.core.store.impl that return Item

Modifier and Type	Method	Description
protected abstract Item	AbstractCachedContentStoreAdapter.doFindItem(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor)
protected Item	AbstractFileBasedContentStoreAdapter.doFindItem(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor)
Item	AbstractCachedContentStoreAdapter.findItem(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor)

Methods in org.craftercms.core.store.impl that return types with arguments of type Item

Modifier and Type	Method	Description
protected abstract List<Item>	AbstractCachedContentStoreAdapter.doFindItems(Context context, CachingOptions cachingOptions, String path)
protected List<Item>	AbstractFileBasedContentStoreAdapter.doFindItems(Context context, CachingOptions cachingOptions, String path)
List<Item>	AbstractCachedContentStoreAdapter.findItems(Context context, CachingOptions cachingOptions, String path)