com.neurosys.products.service

Class ProductIndexSearch<P extends Product>

java.lang.Object

com.neurosys.spider.indexer.service.AbstractIndexSearch<P>

com.neurosys.products.service.ProductIndexSearch<P>

All Implemented Interfaces:

com.neurosys.spider.indexer.service.CategoryIndexSearch<P,IHierarchialReference>, com.neurosys.spider.indexer.service.IndexSearch<P>

public class ProductIndexSearch<P extends Product>
extends com.neurosys.spider.indexer.service.AbstractIndexSearch<P>
implements com.neurosys.spider.indexer.service.CategoryIndexSearch<P,IHierarchialReference>

A Service API wrapper for Indexing and Searching Product
TODO: Map Attributes for indexing without DUPLICATING the row data in the query

Will search across all searchable fields (defined in search config)

Author:

Arjun Dhar

Field Summary

Fields inherited from class com.neurosys.spider.indexer.service.AbstractIndexSearch

analyzersList, dbReadProcessor, termModifiersMap, termQueryTemplate

Constructor Summary

Constructors

Constructor and Description
ProductIndexSearch()

Method Summary

Modifier and Type	Method and Description
protected Page<P>	_search(PageInfo pageInfo, com.neurosys.spider.domain.SearchParams searchParams, org.apache.lucene.facet.params.FacetSearchParams facetSearchParams)
protected List<P>	_search(com.neurosys.spider.domain.SearchParams searchParams, org.apache.lucene.facet.params.FacetSearchParams facetSearchParams)
protected int	_searchResultSize(com.neurosys.spider.domain.SearchParams searchParams, org.apache.lucene.facet.params.FacetSearchParams facetSearchParams)
protected org.apache.lucene.facet.params.FacetSearchParams	deriveFacetParams(IHierarchialReference... categories) TODO: Add unit Test case.
protected org.apache.lucene.facet.search.FacetRequest	deriveFacetRequest(IHierarchialReference category) By default this method will use the IHierarchialReference.getHierarchy() code to derive all the paths; hence its important each time any change in Hierarchy a Re-Index is done. The strategy to create/derive the CategoryPaths should match DefaultHierarchyBasedCategoryBuilder.getCategoryPaths(java.util.List<H>) TODO: Needs to be reviewed and upgraded
protected List<P>	fetchEntities(List<org.apache.lucene.document.Document> docs, List<com.neurosys.spider.domain.SearchParams.SortParam> sortParams)
com.neurosys.spider.indexer.DefaultHierarchyBasedCategoryBuilder	getCategoryBuilder()
ProductDao<P>	getDao()
String[]	getDocumentFieldsToQuery() The document fields to query, should be same or a SubSet of the fields specified in the Indexing Query The name should also match that of the alias specified in the Query (for indexing)
org.apache.commons.collections.Transformer	getDocumentToIdTransformer() For a Document in an index identify the Id
QueryOptimizer	getQueryOptimizer() Uses a QueryOptimizer to limit the joins and fields required for hierarchical records
void	index()
Page<P>	search(PageInfo pageInfo, com.neurosys.spider.domain.SearchParams searchParams)
Page<P>	search(PageInfo pageInfo, com.neurosys.spider.domain.SearchParams searchParams, IHierarchialReference... categories)
List<P>	search(com.neurosys.spider.domain.SearchParams searchParams)
List<P>	search(com.neurosys.spider.domain.SearchParams searchParams, IHierarchialReference... categories)
int	searchResultSize(com.neurosys.spider.domain.SearchParams searchParams)
int	searchResultSize(com.neurosys.spider.domain.SearchParams searchParams, IHierarchialReference... categories)
void	setCategoryBuilder(com.neurosys.spider.indexer.DefaultHierarchyBasedCategoryBuilder categoryBuilder)
void	setDao(ProductDao<P> dao)
void	setDocumentFieldsToQuery(String[] documentFieldsToQuery) The document fields to query, should be same or a SubSet of the fields specified in the Indexing Query The name should also match that of the alias specified in the Query (for indexing)
void	setDocumentToIdTransformer(org.apache.commons.collections.Transformer documentToIdTransformer) For a Document in an index identify the Id
void	setQueryOptimizer(QueryOptimizer queryOptimizer) Uses a QueryOptimizer to limit the joins and fields required for hierarchical records
protected com.neurosys.spider.query.TermQueryTemplate	setupQueryFromContext(com.neurosys.spider.domain.SearchParams searchParams, org.apache.lucene.facet.params.FacetSearchParams facetSearchParams) Setup all context params for the TermQueryTemplate; into a new instance.
void	updateIndex(String sql)

Methods inherited from class com.neurosys.spider.indexer.service.AbstractIndexSearch

getAnalyzer, getAnalyzersList, getCurrentWriteIndex, getDbReadProcessor, getTermModifiersMap, getTermQueryTemplate, getWriteSize, prepareQuery, prepareQueryString, prepareSort, prepareTermForQuery, setAnalyzersList, setDbReadProcessor, setTermModifiersMap, setTermQueryTemplate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neurosys.spider.indexer.service.IndexSearch

getCurrentWriteIndex, getWriteSize

Constructor Detail

ProductIndexSearch

public ProductIndexSearch()

Method Detail

index

public void index()
           throws Exception

Specified by:

index in interface com.neurosys.spider.indexer.service.IndexSearch<P extends Product>

Overrides:

index in class com.neurosys.spider.indexer.service.AbstractIndexSearch<P extends Product>

Throws:

Exception

updateIndex

public void updateIndex(String sql)
                 throws Exception

Specified by:

updateIndex in interface com.neurosys.spider.indexer.service.IndexSearch<P extends Product>

Overrides:

updateIndex in class com.neurosys.spider.indexer.service.AbstractIndexSearch<P extends Product>

Throws:

Exception

fetchEntities

protected List<P> fetchEntities(List<org.apache.lucene.document.Document> docs,
                                List<com.neurosys.spider.domain.SearchParams.SortParam> sortParams)

Parameters:

docs - as List of Documents

sortParams - as List of SearchParams.SortParam

Returns:

List of Products

setupQueryFromContext

protected com.neurosys.spider.query.TermQueryTemplate setupQueryFromContext(com.neurosys.spider.domain.SearchParams searchParams,
                                                                            org.apache.lucene.facet.params.FacetSearchParams facetSearchParams)
                                                                     throws org.apache.lucene.queryparser.classic.ParseException,
                                                                            IOException

Setup all context params for the TermQueryTemplate; into a new instance.
To avoid concurrency issues, have to ensure each Thread (context) generates its own object from the template.

Throws:

org.apache.lucene.queryparser.classic.ParseException

IOException

_search

@Transactional(readOnly=true)
protected final Page<P> _search(PageInfo pageInfo,
                                                              com.neurosys.spider.domain.SearchParams searchParams,
                                                              org.apache.lucene.facet.params.FacetSearchParams facetSearchParams)
                                                       throws org.apache.lucene.queryparser.classic.ParseException,
                                                              IOException

Throws:

org.apache.lucene.queryparser.classic.ParseException

IOException

search

@Transactional(readOnly=true)
public Page<P> search(PageInfo pageInfo,
                                                    com.neurosys.spider.domain.SearchParams searchParams)
                                             throws org.apache.lucene.queryparser.classic.ParseException,
                                                    IOException

Specified by:

search in interface com.neurosys.spider.indexer.service.IndexSearch<P extends Product>

Throws:

org.apache.lucene.queryparser.classic.ParseException

IOException

_search

@Transactional(readOnly=true)
protected final List<P> _search(com.neurosys.spider.domain.SearchParams searchParams,
                                                              org.apache.lucene.facet.params.FacetSearchParams facetSearchParams)
                                                       throws org.apache.lucene.queryparser.classic.ParseException,
                                                              IOException

Throws:

org.apache.lucene.queryparser.classic.ParseException

IOException

search

@Transactional(readOnly=true)
public List<P> search(com.neurosys.spider.domain.SearchParams searchParams)
                                             throws org.apache.lucene.queryparser.classic.ParseException,
                                                    IOException

Specified by:

search in interface com.neurosys.spider.indexer.service.IndexSearch<P extends Product>

Throws:

org.apache.lucene.queryparser.classic.ParseException

IOException

_searchResultSize

@Transactional(readOnly=true)
protected final int _searchResultSize(com.neurosys.spider.domain.SearchParams searchParams,
                                                                    org.apache.lucene.facet.params.FacetSearchParams facetSearchParams)
                                                             throws org.apache.lucene.queryparser.classic.ParseException,
                                                                    IOException

Throws:

org.apache.lucene.queryparser.classic.ParseException

IOException

searchResultSize

@Transactional(readOnly=true)
public int searchResultSize(com.neurosys.spider.domain.SearchParams searchParams)
                                                   throws org.apache.lucene.queryparser.classic.ParseException,
                                                          IOException

Specified by:

searchResultSize in interface com.neurosys.spider.indexer.service.IndexSearch<P extends Product>

Throws:

org.apache.lucene.queryparser.classic.ParseException

IOException

deriveFacetRequest

protected org.apache.lucene.facet.search.FacetRequest deriveFacetRequest(IHierarchialReference category)

By default this method will use the IHierarchialReference.getHierarchy() code to derive all the paths; hence its important each time any change in Hierarchy a Re-Index is done.
The strategy to create/derive the CategoryPaths should match DefaultHierarchyBasedCategoryBuilder.getCategoryPaths(java.util.List<H>) TODO: Needs to be reviewed and upgraded

Parameters:

category - as IHierarchialReference

Returns:

@

deriveFacetParams

protected org.apache.lucene.facet.params.FacetSearchParams deriveFacetParams(IHierarchialReference... categories)

TODO: Add unit Test case. Sensitive to zero category and zero facetRequest scenarios

search

public Page<P> search(PageInfo pageInfo,
                      com.neurosys.spider.domain.SearchParams searchParams,
                      IHierarchialReference... categories)
               throws Exception

Specified by:

search in interface com.neurosys.spider.indexer.service.CategoryIndexSearch<P extends Product,IHierarchialReference>

Throws:

Exception

search

public List<P> search(com.neurosys.spider.domain.SearchParams searchParams,
                      IHierarchialReference... categories)
               throws Exception

Specified by:

search in interface com.neurosys.spider.indexer.service.CategoryIndexSearch<P extends Product,IHierarchialReference>

Throws:

Exception

searchResultSize

public int searchResultSize(com.neurosys.spider.domain.SearchParams searchParams,
                            IHierarchialReference... categories)
                     throws Exception

Specified by:

searchResultSize in interface com.neurosys.spider.indexer.service.CategoryIndexSearch<P extends Product,IHierarchialReference>

Throws:

Exception

getDao

public ProductDao<P> getDao()

setDao

public void setDao(ProductDao<P> dao)

getDocumentFieldsToQuery

public String[] getDocumentFieldsToQuery()

The document fields to query, should be same or a SubSet of the fields specified in the Indexing Query
The name should also match that of the alias specified in the Query (for indexing)

setDocumentFieldsToQuery

public void setDocumentFieldsToQuery(String[] documentFieldsToQuery)

The document fields to query, should be same or a SubSet of the fields specified in the Indexing Query
The name should also match that of the alias specified in the Query (for indexing)

getCategoryBuilder

public com.neurosys.spider.indexer.DefaultHierarchyBasedCategoryBuilder getCategoryBuilder()

setCategoryBuilder

public void setCategoryBuilder(com.neurosys.spider.indexer.DefaultHierarchyBasedCategoryBuilder categoryBuilder)

getDocumentToIdTransformer

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

For a Document in an index identify the Id

Default value:

Transformer

setDocumentToIdTransformer

public void setDocumentToIdTransformer(org.apache.commons.collections.Transformer documentToIdTransformer)

For a Document in an index identify the Id

Default value:

Transformer

getQueryOptimizer

public QueryOptimizer getQueryOptimizer()

Uses a QueryOptimizer to limit the joins and fields required for hierarchical records

setQueryOptimizer

public void setQueryOptimizer(QueryOptimizer queryOptimizer)

Uses a QueryOptimizer to limit the joins and fields required for hierarchical records