com.neurosys.products.service

Interface ProductService<T extends Product>

All Superinterfaces:

ChangeGenerator<Object[]>, FreeQuery, GenericDao<T>, HierarchyService<T>, ProductDao<T>, QueryableDao<T>

All Known Implementing Classes:

ProductServiceImpl

public interface ProductService<T extends Product>
extends ProductDao<T>, HierarchyService<T>

Added service methods over basic DAO ones

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PRODUCT_NAME For attributes common across Products, we need a Base type that can act as a template for all Products that dont wish to override base Product values.
static String	PRODUCT_LOOKUP_CACHE_NAME Cache for looking up Categories, top level Products that are called often in the project On save the cache is updated (ideally, check admin code Key: Product.getId() or HierarchialDomainObject.getParentId() or Product.getName()
static String	PRODUCT_SEARCH_CACHE_NAME Cache results of recently Search results. For instance Home page default catalog results etc.

Fields inherited from interface com.neurosys.products.dao.ProductDao

FILTER_PARENTS, FILTER_PARENTS_IMMEDIATE

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clear all Product related Cache
T	convertToCategory(T product) Converts an existing Product in the hierarchy to a Category
org.springframework.cache.Cache	getCache()
<PD extends ProductDao<T>> PD	getDao()
List<T>	getParents(T product, boolean includeDefault, boolean includeThis) Get all parents for product, where immediate parent is first node, and last node is either top most or the DEFAULT product.
T	getProduct(T queryObject) A Convenience method that can identify a Product uniquely by any unique key.
Collection<T>	getProducts(Collection<String> productNames) For a given list of Product Names produce a Collection of Products matching those Names.
ProductIndexSearch<T>	getSearchService(String indexName)
void	index() Re-Index all the Products using Spider
List	loadHierarchy(ProductReference rootNode, boolean loadLeaves) Same as #loadHierarchy(Product, boolean), but supports ProductReference version
Map<String,String>	locateResourceForProduct(T productCategory, String... resourceTypeAttributesIds) A product may have associated resources; this tells us where one can find the resources for that product
T	prepareNewProduct(T product, Integer sequence) Prepares a new product entity for sequence, hierarchy etc based on the parent set Persistence depends on the implementation.
List	search(String indexName, com.neurosys.spider.domain.SearchParams searchParams, PageInfo pageInfo, String... categoryNames) Perform indexed/lucene based searches
int	searchCount(String indexName, com.neurosys.spider.domain.SearchParams searchParams, String... categoryNames) Perform indexed/lucene based searches

Methods inherited from interface com.neurosys.products.dao.ProductDao

convert, countFilterParents, delete, deleteSubHierarchy, filterParents, getAliasForProduct, getLastChildHierarchyCode, getParents, isExistsAsParent, loadPage, makeSpaceForNodeInParent, move, save, save

Methods inherited from interface com.neurosys.dao.jpa.QueryableDao

count, getEntityInstance, query, query, queryPage, queryPage

Methods inherited from interface com.neurosys.dao.GenericDao

delete, delete, load, load, save

Methods inherited from interface com.neurosys.dao.FreeQuery

query, query, update

Methods inherited from interface com.neurosys.common.hierarchy.HierarchyService

convert, deleteSubHierarchy, getLastChildHierarchyCode, loadHierarchy, loadHierarchyFlat, move

Methods inherited from interface com.neurosys.events.ChangeGenerator

addChangeListener, getListeners, notifyAllListeners, setListeners

Field Detail

PRODUCT_LOOKUP_CACHE_NAME

static final String PRODUCT_LOOKUP_CACHE_NAME

Cache for looking up Categories, top level Products that are called often in the project
On save the cache is updated (ideally, check admin code

Key: Product.getId() or HierarchialDomainObject.getParentId() or Product.getName()

See Also:

ProductServiceImpl#save(Product)}), Constant Field Values

PRODUCT_SEARCH_CACHE_NAME

static final String PRODUCT_SEARCH_CACHE_NAME

Cache results of recently Search results.
For instance Home page default catalog results etc. Or for a small site cache the entire catalog

See Also:

Constant Field Values

DEFAULT_PRODUCT_NAME

static final String DEFAULT_PRODUCT_NAME

For attributes common across Products, we need a Base type that can act as a template for all Products that dont wish to override base Product values.

See Also:

Constant Field Values

Method Detail

loadHierarchy

List loadHierarchy(ProductReference rootNode,
                   boolean loadLeaves)

Same as #loadHierarchy(Product, boolean), but supports ProductReference version

Parameters:

rootNode - this

loadLeaves -

Returns:

prepareNewProduct

T prepareNewProduct(T product,
                    Integer sequence)

Prepares a new product entity for sequence, hierarchy etc based on the parent set
Persistence depends on the implementation.

Parameters:

product - as Product @nullable false ;if HierarchialDomainObject.getParentId() is null then it will assume root

sequence - as Integer, an alternate order within the parent where this content will be created @nullable true

Returns:

saved Product object

convertToCategory

T convertToCategory(T product)

Converts an existing Product in the hierarchy to a Category

Parameters:

product -

Returns:

category

locateResourceForProduct

Map<String,String> locateResourceForProduct(T productCategory,
                                            String... resourceTypeAttributesIds)

A product may have associated resources; this tells us where one can find the resources for that product

Parameters:

productCategory - as T. Resources are common for siblings under a category/parent, hence productCategory is request for.

resourceTypeAttributesIds(s) - as String (ProductAttribute name)

Returns:

Map map each of the input parameter and its value

getProduct

T getProduct(T queryObject)
      throws Exception

A Convenience method that can identify a Product uniquely by any unique key. Results from this may also be eligible for Caching
Like Product.getId(), Product.getName(), HierarchialDomainObject.getHierarchy() and any unique identifiers added to the base Entity

Parameters:

criteria -

Returns:

T

Throws:

Exception

getParents

List<T> getParents(T product,
                   boolean includeDefault,
                   boolean includeThis)

Get all parents for product, where immediate parent is first node, and last node is either top most or the DEFAULT product.
This does not factor ProductAlias (multiple categories); only primary parents are considered.

Parameters:

product - as T

includeDefault - as boolean, if true will append the "DEFAULT" product @ the end of the output List (if it exists)

includeThis - as boolean, if true will include this product in the list (first position = 0th index)

Returns:

List of parent Products T @nullable true

search

List search(String indexName,
            com.neurosys.spider.domain.SearchParams searchParams,
            PageInfo pageInfo,
            String... categoryNames)
     throws Exception

Perform indexed/lucene based searches

Parameters:

indexName - as String @Nuallble true implies the default index wilt be searched

searchParams - as SearchParams @nullable false

pageInfo - as PageIngo @nullable true

categoryNames - @nullable true

Returns:

Throws:

Exception

getProducts

Collection<T> getProducts(Collection<String> productNames)

For a given list of Product Names produce a Collection of Products matching those Names. Note: The result may or may not preserve duplicates from the input. Say input contained "Product A Name" twice; the result may contain one instance of "Product A".
Note: The order may or may not match

Parameters:

productNames - as List of String

Returns:

searchCount

int searchCount(String indexName,
                com.neurosys.spider.domain.SearchParams searchParams,
                String... categoryNames)
         throws Exception

Perform indexed/lucene based searches

Parameters:

indexName - as String @Nuallble true implies the default index wilt be searched

searchParams - as SearchParams @nullable false

categoryNames - @nullable true

Returns:

Throws:

Exception

index

void index()
    throws Exception

Re-Index all the Products using Spider

Throws:

Exception

getCache

org.springframework.cache.Cache getCache()

clearCache

void clearCache()
         throws Exception

Clear all Product related Cache

Throws:

Exception

getDao

<PD extends ProductDao<T>> PD getDao()

getSearchService

ProductIndexSearch<T> getSearchService(String indexName)