public class CatalogSearchFormHandler extends SearchFormHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
DEFAULT_CATALOG_ITEMS_CATALOG_PROPERTY |
static java.lang.String |
DEFAULT_CATALOG_PROPERTY |
protected java.lang.String[] |
mCatalogs
Array of catalog IDs
|
INVALID_PRICE, mLastCatalogKey, PRICE_PROPERTY_NOT_SET
ALL_SITES_SCOPE, ANY_SITE_SCOPE, CURRENT_SITE_SCOPE, EMPTY_SEARCH_INPUT_DISALLOW, EMPTY_SEARCH_VALUES_DISALLOW, GENERATE_VALUES_BY_TYPE_FAILED, INVALID_ITEM_TYPE, INVALID_KEYWORD_SEARCH_STRING, INVALID_PROP_COMBINATION, INVALID_SEARCH_PROPERTY_NAMES, mEndIndex, mPreviouslySubmitted, mPreviousQuery, mSearchResults, mSearchResultsByItemType, mStartIndex, MULTIPLE_ITEM_TYPES_DISALLOW, NO_PROPERTY_NAMES_FOR_ITEM, NONE_SITE_SCOPE, QUERY_FAILURE, UNMATCHED_QUOTES
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
CatalogSearchFormHandler() |
Modifier and Type | Method and Description |
---|---|
protected Query |
generateCatalogQueryClause(QueryBuilder pQueryBuilder,
Query pQuery,
java.lang.Object pCatalog)
Adds clause to filter out items by single catalog.
|
protected Query |
generateCatalogsQueryClause(QueryBuilder pQueryBuilder,
Query pQuery,
java.lang.String[] pCatalogIds)
Adds clause to filter out items by catalogs.
|
protected Query |
generateSearchQuery(Repository pRepository,
java.lang.String pItemType,
QueryBuilder pQueryBuilder)
Return the query that should be executed on the Repository View.
|
java.lang.String |
getCatalogItemsCatalogProperty()
The name of the property for each catalog item that contains the
list of catalogs containing that item
|
java.lang.String |
getCatalogPropertyName()
The name of the profile property pointing to the catalog
|
java.lang.String[] |
getCatalogs()
Gets an array of catalog IDs to filter the search by
|
protected java.lang.Object |
getCurrentCatalog()
Get the current catalog from current user profile.
|
boolean |
isNullCatalogMeansNoResults()
If this is true, and the profile's catalog is null, no results
will be returned.
|
boolean |
isQueryByCatalog()
If this is true, search queries will be constrained by catalog.
|
void |
setCatalogItemsCatalogProperty(java.lang.String pCatalogItemsCatalogProperty) |
void |
setCatalogPropertyName(java.lang.String pCatalogPropertyName) |
void |
setCatalogs(java.lang.String[] pCatalogs)
Sets an array of catalog IDs to filter the search by
|
void |
setNullCatalogMeansNoResults(boolean pNullCatalogMeansNoResults) |
void |
setQueryByCatalog(boolean pQueryByCatalog) |
areSearchValuesEmpty, beforeGet, generatePriceQuery, generateSearchValues, generateSkuQuery, getAdvancedSearchPropertyNames, getAncestorCategoriesPropertyName, getCatalogKey, getCatalogTools, getChildSKUsPropertyName, getHierarchicalCategoryId, getKeywordInputSeparator, getKeywords, getKeywordsPropertyNames, getLoggingIdentifier, getMessage, getPrice, getPricePropertyName, getPriceRelation, getPropertyValues, getPropertyValuesByType, getRepositoryKey, getRepositoryKeyParamName, getRepositoryView, getSearchInput, getSku, getTextSearchPropertyNames, handleSearch, isSkuExactMatch, prepare, prepareRepository, setAdvancedSearchPropertyNames, setAncestorCategoriesPropertyName, setCatalogKey, setCatalogTools, setChildSKUsPropertyName, setHierarchicalCategoryId, setKeywordInputSeparator, setKeywordsPropertyNames, setLoggingIdentifier, setPrice, setPricePropertyName, setPriceRelation, setPropertyValues, setPropertyValuesByType, setRepositoryKeyParamName, setSearchInput, setSku, setSkuExactMatch, setTextSearchPropertyNames
beforeSet, filterSiteList, generateAdvancedSearchQuery, generateHierarchicalSearchQuery, generateKeywordSearchQuery, generateResultSet, generateSearchValues, generateSiteFilter, generateTextSearchQuery, getAdvancedSearchPropertyRanges, getAdvancedSearchPropertyValues, getAllowEmptySearch, getAllowRefine, getAllowWildcards, getAncestorId, getAncestorPropertyName, getClearQueryURL, getContextFilteringRulesForSites, getCurrentResultPageNum, getDisplayName, getEndCount, getEndIndex, getErrorURL, getItemTypes, getKeywordInput, getKeywordSearchPropertyNames, getMaxResultsPerPage, getMaxRowCount, getMinScore, getRepositories, getResultPageCount, getResultSetSize, getSearchResults, getSearchResultsByItemType, getSearchStringFormat, getSiteGroupManager, getSiteIds, getSiteManager, getSiteScope, getStartCount, getStartIndex, getSuccessURL, getTextInput, handleClearQuery, handleCurrentResultPageNum, isAdvancedSearchPropertyRangesEmpty, isAdvancedSearchPropertyValuesEmpty, isDoAdvancedSearch, isDoHierarchicalSearch, isDoKeywordSearch, isDoTextSearch, isEnableCountQuery, isIncludeDisabledSites, isIncludeInactiveSites, isPrepared, isPreviouslySubmitted, isToLowerCaseKeywords, isToUpperCaseKeywords, isUseIncludesForKeywordQueryOnMultiProperties, setAdvancedSearchPropertyRanges, setAdvancedSearchPropertyValues, setAllowEmptySearch, setAllowRefine, setAllowWildcards, setAncestorId, setAncestorPropertyName, setClearQueryURL, setCurrentResultPageNum, setDisplayName, setDoAdvancedSearch, setDoHierarchicalSearch, setDoKeywordSearch, setDoTextSearch, setEnableCountQuery, setEndIndex, setErrorURL, setIncludeDisabledSites, setIncludeInactiveSites, setItemTypes, setKeywordInput, setKeywords, setKeywordSearchPropertyNames, setMaxResultsPerPage, setMaxRowCount, setMinScore, setPrepared, setRepositories, setResultSetSize, setSearchStringFormat, setSiteGroupManager, setSiteIds, setSiteManager, setSiteScope, setStartIndex, setSuccessURL, setTextInput, setToLowerCaseKeywords, setToUpperCaseKeywords, setUseIncludesForKeywordQueryOnMultiProperties, splitPropertyNames, transformKeywords
addFormException, addUncheckedFormException, afterSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards
afterGet
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final java.lang.String DEFAULT_CATALOG_PROPERTY
public static final java.lang.String DEFAULT_CATALOG_ITEMS_CATALOG_PROPERTY
protected java.lang.String[] mCatalogs
public void setCatalogItemsCatalogProperty(java.lang.String pCatalogItemsCatalogProperty)
public java.lang.String getCatalogItemsCatalogProperty()
public void setCatalogPropertyName(java.lang.String pCatalogPropertyName)
public java.lang.String getCatalogPropertyName()
public void setNullCatalogMeansNoResults(boolean pNullCatalogMeansNoResults)
public boolean isNullCatalogMeansNoResults()
public void setQueryByCatalog(boolean pQueryByCatalog)
public boolean isQueryByCatalog()
public java.lang.String[] getCatalogs()
public void setCatalogs(java.lang.String[] pCatalogs)
pCatalogs
- the array of catalog IDsprotected Query generateSearchQuery(Repository pRepository, java.lang.String pItemType, QueryBuilder pQueryBuilder) throws DropletFormException, RepositoryException
generateSearchQuery
in class SearchFormHandler
pRepository
- The repository being searchpItemType
- the type of item to search for. Typically corresponds to an
item descriptor name in the catalog repositorypQueryBuilder
- the builder that should be used to construct the queryRepositoryException
- if an error occured while forming the queryDropletFormException
protected Query generateCatalogQueryClause(QueryBuilder pQueryBuilder, Query pQuery, java.lang.Object pCatalog) throws RepositoryException
pQueryBuilder
- query builderpQuery
- querypCatalog
- catalog objectRepositoryException
protected Query generateCatalogsQueryClause(QueryBuilder pQueryBuilder, Query pQuery, java.lang.String[] pCatalogIds) throws RepositoryException
pQueryBuilder
- query builderpQuery
- querypCatalogIds
- array of catalog IDs to filter byRepositoryException
protected java.lang.Object getCurrentCatalog()