Package com.softslate.commerce.businessobjects.product

Class BasicLuceneFacetHelper

java.lang.Object

com.softslate.commerce.businessobjects.core.BaseBusinessObject

com.softslate.commerce.businessobjects.core.BaseBusinessProcessor

com.softslate.commerce.businessobjects.product.BaseLuceneProcessor

com.softslate.commerce.businessobjects.product.BasicLuceneFacetHelper

All Implemented Interfaces:

BusinessObject, BusinessProcessor, LuceneFacetHelper

public class BasicLuceneFacetHelper
extends BaseLuceneProcessor
implements LuceneFacetHelper

Class responsible for searching on the Lucene index for facets.

Author:

David Tobey

Field Summary

Fields

Modifier and Type	Field	Description
static char	FACET_SEPARATOR
(package private) static org.apache.commons.logging.Log	log

Fields inherited from class com.softslate.commerce.businessobjects.product.BaseLuceneProcessor

facetIndexDir, indexDir, suggestionsIndexDir

Constructor Summary

Constructors

Constructor	Description
BasicLuceneFacetHelper()

Method Summary

Modifier and Type	Method	Description
protected Map	compileIncomingFacetsAsMap(String[] facets)
org.apache.lucene.search.BooleanQuery	createFacetsBooleanQuery(String[] facets)
org.apache.lucene.facet.search.FacetsCollector	createFacetsCollector(SearchList searchList)
private String	escapeXML(String text)
protected Map	loadFacetCategories(Collection facetResultCollection, Map categoryMap)
protected Map	loadFacetCategories(org.apache.lucene.facet.search.results.FacetResultNode frn, Map facetCategories, Map categoryMap)
SearchList	loadFacetCategoriesAndManufacturers(SearchList searchList)
Map	loadFacetManufacturersFromDatabase(Collection facetResultCollection)
void	logFacetResults(Collection facetResultCollection)
Collection	performFacetSearch(org.apache.lucene.search.Query query, SearchList searchList, org.apache.lucene.search.IndexSearcher searcher)
protected Map	simplifyFacetResultNode(org.apache.lucene.facet.search.results.FacetResultNode frn)
protected Map	simplifyFacetResultNodeAsMap(org.apache.lucene.facet.search.results.FacetResultNode frn)
Collection	simplifyFacetResults(Collection facetResults)
Map	simplifyFacetResultsAsMap(Collection facetResults)
protected Collection	simplifyFacetSubResults(Iterable facetSubResults)
protected Map	simplifyFacetSubResultsAsMap(Iterable facetSubResults)
protected String	sortByNaturalMatchedFromSetting(String facetGroupName)
protected String	sortByNumericMatchedFromSetting(String facetGroupName)
protected void	sortFacets(String facetName, Collection subResults)

Methods inherited from class com.softslate.commerce.businessobjects.product.BaseLuceneProcessor

closeReaders, closeSuggestionsReader, copyNewIndexFilesIntoPlace, createAnalyzer, createSuggestionsAnalyzer, getFacetIndexDir, getFacetReader, getIndexDir, getIndexSearcher, getSuggestionsIndexDir, getSuggestionsSearcher, initFacetIndexDir, initIndexDir, initSuggestionsIndexDir, isFactedSearchEnabled, isSuggestionsEnabled, pad, pad, pruneArticlesFromName, restoreBackedUpIndexFiles, textFormat

Methods inherited from class com.softslate.commerce.businessobjects.core.BaseBusinessProcessor

formatDateTime, formatPrice, getAppComponents, getAppSettings, getAttributeIDs, getBusinessObjectFactory, getDaoFactory, getEventBus, getInjector, getProductIDs, getSettings, getUser, initialize, isProcessorClassActive, loadMatchingSkus, parseDateTime, parseResponseData, prepareRequestData, sendHTTPGet, sendHTTPPost, sendHTTPPost, setAppComponents, setAppSettings, setBusinessObjectFactory, setDaoFactory, setEventBus, setInjector, setSettings, setUser, updateOrderTotals, updateOrderTotals, updateOrderTotals, utils

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.softslate.commerce.businessobjects.core.BusinessObject

initialize

Methods inherited from interface com.softslate.commerce.businessobjects.core.BusinessProcessor

getAppComponents, getAppSettings, getBusinessObjectFactory, getDaoFactory, getEventBus, getInjector, getSettings, getUser, setAppComponents, setAppSettings, setBusinessObjectFactory, setDaoFactory, setEventBus, setInjector, setSettings, setUser, utils

Field Details

log

static org.apache.commons.logging.Log log

FACET_SEPARATOR

public static char FACET_SEPARATOR

Constructor Details

BasicLuceneFacetHelper

public BasicLuceneFacetHelper()

Method Details

performFacetSearch

public Collection performFacetSearch(org.apache.lucene.search.Query query,
 SearchList searchList,
 org.apache.lucene.search.IndexSearcher searcher)
                              throws Exception

Specified by:

performFacetSearch in interface LuceneFacetHelper

Throws:

Exception

simplifyFacetResults

public Collection simplifyFacetResults(Collection facetResults)

Specified by:

simplifyFacetResults in interface LuceneFacetHelper

simplifyFacetResultNode

protected Map simplifyFacetResultNode(org.apache.lucene.facet.search.results.FacetResultNode frn)

sortFacets

protected void sortFacets(String facetName,
 Collection subResults)

sortByNumericMatchedFromSetting

protected String sortByNumericMatchedFromSetting(String facetGroupName)

sortByNaturalMatchedFromSetting

protected String sortByNaturalMatchedFromSetting(String facetGroupName)

simplifyFacetSubResults

protected Collection simplifyFacetSubResults(Iterable facetSubResults)

simplifyFacetResultsAsMap

public Map simplifyFacetResultsAsMap(Collection facetResults)

Specified by:

simplifyFacetResultsAsMap in interface LuceneFacetHelper

simplifyFacetResultNodeAsMap

protected Map simplifyFacetResultNodeAsMap(org.apache.lucene.facet.search.results.FacetResultNode frn)

simplifyFacetSubResultsAsMap

protected Map simplifyFacetSubResultsAsMap(Iterable facetSubResults)

createFacetsBooleanQuery

public org.apache.lucene.search.BooleanQuery createFacetsBooleanQuery(String[] facets)

Specified by:

createFacetsBooleanQuery in interface LuceneFacetHelper

compileIncomingFacetsAsMap

protected Map compileIncomingFacetsAsMap(String[] facets)

createFacetsCollector

public org.apache.lucene.facet.search.FacetsCollector createFacetsCollector(SearchList searchList)
                                                                     throws Exception

Specified by:

createFacetsCollector in interface LuceneFacetHelper

Throws:

Exception

loadFacetCategoriesAndManufacturers

public SearchList loadFacetCategoriesAndManufacturers(SearchList searchList)
                                               throws Exception

Specified by:

loadFacetCategoriesAndManufacturers in interface LuceneFacetHelper

Throws:

Exception

loadFacetCategories

protected Map loadFacetCategories(Collection facetResultCollection,
 Map categoryMap)
                           throws Exception

Throws:

Exception

loadFacetCategories

protected Map loadFacetCategories(org.apache.lucene.facet.search.results.FacetResultNode frn,
 Map facetCategories,
 Map categoryMap)
                           throws Exception

Throws:

Exception

loadFacetManufacturersFromDatabase

public Map loadFacetManufacturersFromDatabase(Collection facetResultCollection)
                                       throws Exception

Specified by:

loadFacetManufacturersFromDatabase in interface LuceneFacetHelper

Throws:

Exception

logFacetResults

public void logFacetResults(Collection facetResultCollection)

Specified by:

logFacetResults in interface LuceneFacetHelper

escapeXML

private String escapeXML(String text)