com.neurosys.content.service.extractors

Class QueryBasedContentExtractor

java.lang.Object

com.neurosys.content.service.extractors.QueryBasedContentExtractor

All Implemented Interfaces:

ContentExtractor<Map,Object>, CacheLookups

public class QueryBasedContentExtractor
extends Object
implements ContentExtractor<Map,Object>

A ContentExtractor to extract Content using any custom definition Query with input as params

Some queries may not require any parameters; however as per ContentExtractor we need a reliable key for the toString() on the location parameter. In such cases one may provide a default "toString" key/value to identify this for the Cache. "toString" is removed before sending it to the underlying query Transformer.
This is useful when we wish to extract individual content and structure it in a custom way rather than just getting the entire HTML dump using an alternative like ResourceContentExtractor.

Example Usage: Extract Lists for listing pages, where we need to show only a particular ContentFacet. The expected return type would be a List of Content.

Author:

Arjun Dhar

Field Summary

Fields inherited from interface com.neurosys.lookups.CacheLookups

CONTENT_PUBLISH_CACHE_NAME, PRODUCT_LOOKUP_CACHE_NAME, PRODUCT_SEARCH_CACHE_NAME, TEMPLATEPAGE_MAPPING_CACHE_NAME

Constructor Summary

Constructors

Constructor and Description
QueryBasedContentExtractor()

Method Summary

Modifier and Type	Method and Description
Object	getContent(Map location, ContentContext context) Get Content.
org.apache.commons.collections.Transformer	getContentTransformer() Apply this Transformer over the extracted content, before passing it back
org.apache.commons.collections.Transformer	getQueryTransformer()
void	setContentTransformer(org.apache.commons.collections.Transformer contentTransformer) Apply this Transformer over the extracted content, before passing it back
void	setQueryTransformer(org.apache.commons.collections.Transformer queryTransformer)
protected Object	transformContent(Object rawContent) Using contentTransformer Transform the Content values, be it in a Map, List or raw String type format

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryBasedContentExtractor

public QueryBasedContentExtractor()

Method Detail

getContent

@Cacheable(key="#location.toString()",
           condition="(#location!=null and #context!=null and T(com.neurosys.content.domain.Status).PUBLISH == #context.status)",
           value="publishContent")
public Object getContent(Map location,
                                                                                                                                                                                                                                     ContentContext context)

Description copied from interface: ContentExtractor

Get Content. PUBLISHED Content is cached. Can also throw a ExecutionPreventedException if for some environmental reason publishing was explicitly prevented.

Specified by:

getContent in interface ContentExtractor<Map,Object>

Returns:

String @nullable true (if could not get content it should return null not blank)

See Also:

Cacheable}(key="#location.toString()",
condition="(#location!=null and #context!=null and T(com.neurosys.content.domain.Status).PUBLISH == #context.status)",
value="publishContent")

getQueryTransformer

public org.apache.commons.collections.Transformer getQueryTransformer()

setQueryTransformer

public void setQueryTransformer(org.apache.commons.collections.Transformer queryTransformer)

transformContent

protected Object transformContent(Object rawContent)

Using contentTransformer Transform the Content values, be it in a Map, List or raw String type format

Returns:

getContentTransformer

public org.apache.commons.collections.Transformer getContentTransformer()

Apply this Transformer over the extracted content, before passing it back

setContentTransformer

public void setContentTransformer(org.apache.commons.collections.Transformer contentTransformer)

Apply this Transformer over the extracted content, before passing it back