atg.commerce.endeca.assembler.navigation.filter

Class CatalogFilterBuilder

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.endeca.assembler.navigation.filter.RecordFilterBuilderImpl

atg.commerce.endeca.assembler.navigation.filter.CatalogFilterBuilder

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, RecordFilterBuilder, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class CatalogFilterBuilder
extends RecordFilterBuilderImpl

Builds a record filter that filters by catalog.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.endeca.assembler.navigation.filter.RecordFilterBuilder

EMPTY_FILTER

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
CatalogFilterBuilder()

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildRecordFilter() Generates the record filter to filter the query based on the set of allowable catalogs.
java.lang.String[]	determineCatalogIds() This method calls CatalogTools.getCurrentCatalog to get the catalog that is appropriate for the current user.
java.lang.String	getCatalogIdPropertyName() Returns the name of catalogId property
CustomCatalogTools	getCatalogTools() Returns property catalogTools.
void	setCatalogIdPropertyName(java.lang.String pCatalogIdPropertyName) Sets name of catalogId property
void	setCatalogTools(CustomCatalogTools pCatalogTools) Sets property catalogTools.

Methods inherited from class atg.endeca.assembler.navigation.filter.RecordFilterBuilderImpl

isSecurityFilter, setSecurityFilter

Methods inherited from class atg.nucleus.GenericService

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, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

protected static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

CatalogFilterBuilder

public CatalogFilterBuilder()

Method Detail

setCatalogTools

public void setCatalogTools(CustomCatalogTools pCatalogTools)

Sets property catalogTools.

Parameters:

pCatalogTools - the property to store the global service catalog tools factory to obtain the catalog to search in.

getCatalogTools

public CustomCatalogTools getCatalogTools()

Returns property catalogTools.

Returns:

The value of the property catalogTools

getCatalogIdPropertyName

public java.lang.String getCatalogIdPropertyName()

Returns the name of catalogId property

setCatalogIdPropertyName

public void setCatalogIdPropertyName(java.lang.String pCatalogIdPropertyName)

Sets name of catalogId property

determineCatalogIds

public java.lang.String[] determineCatalogIds()

This method calls CatalogTools.getCurrentCatalog to get the catalog that is appropriate for the current user. Applications that need different logic to determine what catalog(s) to filter by should override this method.

buildRecordFilter

public java.lang.String buildRecordFilter()

Generates the record filter to filter the query based on the set of allowable catalogs. If no such catalogs are given, no filtering is done

Returns:

the record filter string.