Class TextMetaDataExtractingProcessor
- java.lang.Object
-
- org.craftercms.core.processors.impl.TextMetaDataExtractingProcessor
-
- All Implemented Interfaces:
ItemProcessor
public class TextMetaDataExtractingProcessor extends Object implements ItemProcessor
ItemProcessor
that extracts single text values from descriptor XPath-selected nodes and sets them as the properties of the item. All XPath queries should only return single nodes. For extracting values for a list of nodes useTextMetaDataCollectionExtractingProcessor
.- Author:
- Sumer Jabri, Alfonso Vásquez
-
-
Field Summary
Fields Modifier and Type Field Description protected String[]
metaDataNodesXPathQueries
Array of XPath queries for the nodes whose values should be extracted.
-
Constructor Summary
Constructors Constructor Description TextMetaDataExtractingProcessor(String... metaDataNodesXPathQueries)
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
Returns true if the specifiedTextMetaDataExtractingProcessor
's and this instance'smetaDataNodesXPathQueries
are equal.int
hashCode()
Returns the hash code for this instance, which is basically hash code of the list of XPath queries.Item
process(Context context, CachingOptions cachingOptions, Item item)
For every XPath query provided inmetaDataNodesXPathQueries
, a single node is selected and its text value is extracted and put in the item's properties.String
toString()
-
-
-
Field Detail
-
metaDataNodesXPathQueries
protected String[] metaDataNodesXPathQueries
Array of XPath queries for the nodes whose values should be extracted.
-
-
Constructor Detail
-
TextMetaDataExtractingProcessor
@ConstructorProperties("metaDataNodesXPathQueries") public TextMetaDataExtractingProcessor(String... metaDataNodesXPathQueries)
Default constructor. Sets themetaDataNodesXPathQueries
to the provided argument.
-
-
Method Detail
-
process
public Item process(Context context, CachingOptions cachingOptions, Item item)
For every XPath query provided inmetaDataNodesXPathQueries
, a single node is selected and its text value is extracted and put in the item's properties.- Specified by:
process
in interfaceItemProcessor
- Parameters:
context
- the current contextcachingOptions
- caching options in case you need access to itemsitem
- the item to process- Returns:
- the modified item or a new item.
-
equals
public boolean equals(Object o)
Returns true if the specifiedTextMetaDataExtractingProcessor
's and this instance'smetaDataNodesXPathQueries
are equal.
-
hashCode
public int hashCode()
Returns the hash code for this instance, which is basically hash code of the list of XPath queries. As with any otherItemProcessor
, this method is defined because any processor which is passed in the method call of aContentStoreService
can be used as part of a key for caching.
-
-