atg.endeca.assembler.navigation.filter

Class LanguageFilterBuilder

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.endeca.assembler.navigation.filter.RecordFilterBuilderImpl

atg.endeca.assembler.navigation.filter.LanguageFilterBuilder

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 LanguageFilterBuilder
extends RecordFilterBuilderImpl

Builds a record filter that filters by language.

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
LanguageFilterBuilder()

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildRecordFilter() Generates the record filter to filter the query based on language.
atg.endeca.configuration.ApplicationConfiguration<?>	getApplicationConfiguration() Returns Endeca application configuration component
protected java.util.Locale	getCurrentLocale() This method can be overridden to use another approach for retrieving current locale.
java.lang.String	getLanguagePropertyName() Returns the name of the language property in Endeca records.
void	setApplicationConfiguration(atg.endeca.configuration.ApplicationConfiguration<?> pApplicationConfiguration) Sets Endeca application configuration component
void	setLanguagePropertyName(java.lang.String pLanguagePropertyName) Sets the name of the language property in Endeca records.

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

LanguageFilterBuilder

public LanguageFilterBuilder()

Method Detail

getLanguagePropertyName

public java.lang.String getLanguagePropertyName()

Returns the name of the language property in Endeca records.

Returns:

the languagePropertyName language property name

setLanguagePropertyName

public void setLanguagePropertyName(java.lang.String pLanguagePropertyName)

Sets the name of the language property in Endeca records.

Parameters:

pLanguagePropertyName - the languagePropertyName to set

getApplicationConfiguration

public atg.endeca.configuration.ApplicationConfiguration<?> getApplicationConfiguration()

Returns Endeca application configuration component

Returns:

Endeca application configuration component

setApplicationConfiguration

public void setApplicationConfiguration(atg.endeca.configuration.ApplicationConfiguration<?> pApplicationConfiguration)

Sets Endeca application configuration component

Parameters:

pApplicationConfiguration - Endeca application configuration component

buildRecordFilter

public java.lang.String buildRecordFilter()

Generates the record filter to filter the query based on language.

Returns:

the record filter string.

getCurrentLocale

protected java.util.Locale getCurrentLocale()

This method can be overridden to use another approach for retrieving current locale.

Returns:

current user's locale. If null is returned, Configuration.defaultLocale will be used.