public class LanguageDimensionService extends GenericDimensionService
atg.search.query.config.SearchDimension
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
mDimensionName, mDimensionValueKeyPrefix, mDimensionValuesLocalized, mDisabled, mDisplayNameKey, mDisplayNameLocalized, mFormatter
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 |
---|
LanguageDimensionService() |
Modifier and Type | Method and Description |
---|---|
boolean |
dimensionMatchesValue(DynamoHttpServletRequest pRequest,
java.lang.String pValue)
Checks the request locale against a passed in string locale for a match.
|
boolean |
dimensionMatchesValue(RepositoryItem pProfile,
java.lang.String pTargetValue)
Checks whether or not a value extracted from the given profile matches the given value.
|
boolean |
dimensionMatchesValue(java.lang.String pSourceValue,
java.lang.String pTargetValue)
Checks whether or not a given source value matches the given target value.
|
protected boolean |
doesLanguageMatchLocale(java.util.Locale pLocale,
java.lang.String pLanguage)
Utility method to check a language against a locale.
|
void |
doStartService()
This is called after a Service has been created, placed into the
naming hierarchy, and initialized with its configured property
values.
|
void |
doStopService()
This is called when a Service is required to shut down.
|
java.lang.String |
getDefaultLocale() |
java.lang.String |
getDimensionValueDisplayName(java.lang.String pDimensionValue)
Method to get a localised display name for a dimension value.
|
java.util.List |
getDimensionValues()
Returns a list of string dimension values that are valid for this dimension.
|
java.util.Map |
getLanguageLocaleMap()
Returns the map of language String to java.util.Locale objects.
|
java.util.Map |
getLanguageMap() |
java.lang.String |
getLocale(java.lang.String pLanguage)
Returns the locale string for the given language string.
|
java.lang.String |
getLocaleDisplayName(java.lang.String pLocaleString)
Method to get a localised display name for a language of the
locale string.
|
java.util.Locale |
getLocaleFromProfile(RepositoryItem pProfile)
Method to retrieve Locale from user profile.
|
java.util.List |
getLocales()
Returns the list of locales.
|
java.lang.String |
getTestProfileLocaleProperty() |
boolean |
isProfileBased() |
void |
setDefaultLocale(java.lang.String pDefaultLocale) |
void |
setDimensionValues(java.util.List pDimensionValues) |
void |
setLanguageLocaleMap(java.util.Map pLanguageLocaleMap)
Sets the mapping of language String to java.util.Locale
|
void |
setLanguageMap(java.util.Map pLanguageMap) |
void |
setLocales(java.util.List pLocales) |
void |
setTestProfileLocaleProperty(java.lang.String pTestProfileLocaleProperty) |
protected boolean |
validateLocale(java.lang.String pLocale)
Validates the locale conforms to a java locale and has a language part.
|
protected boolean |
validateLocales(java.util.List pLocales)
Validates the list of locale strings.
|
protected boolean |
validateLocales(java.util.Map pMap)
Validates the map of language to locale strings.
|
getAllDimensionValues, getDimensionName, getDimensionValueKeyPrefix, getDimensionValuesLocalized, getDisplayName, getDisplayNameKey, getDisplayNameLocalized, getFormatter, isDisabled, setDimensionName, setDimensionValueKeyPrefix, setDimensionValuesLocalized, setDisabled, setDisplayNameKey, setDisplayNameLocalized, setFormatter
addLogListener, createAdminServlet, 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 java.util.Map getLanguageMap()
public void setLanguageMap(java.util.Map pLanguageMap)
public java.util.List getLocales()
List
of localespublic void setLocales(java.util.List pLocales)
public java.lang.String getDefaultLocale()
public void setDefaultLocale(java.lang.String pDefaultLocale)
public java.lang.String getTestProfileLocaleProperty()
public void setTestProfileLocaleProperty(java.lang.String pTestProfileLocaleProperty)
public void doStartService() throws ServiceException
GenericService
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic void doStopService() throws ServiceException
GenericService
doStopService
in class GenericService
ServiceException
- if the Service had a problem shutting downpublic java.util.Map getLanguageLocaleMap()
public void setLanguageLocaleMap(java.util.Map pLanguageLocaleMap)
pLanguageLocaleMap
- Map of String language to Localepublic java.util.List getDimensionValues()
SearchDimension
Returns the language dimension values.
public java.lang.String getDimensionValueDisplayName(java.lang.String pDimensionValue)
getDimensionValueDisplayName
in interface SearchDimension
getDimensionValueDisplayName
in class GenericDimensionService
pDimensionValue
- String dimension valuejava.util.MissingResourceException
- if resource can't be found.java.lang.NullPointerException
- if locale or resource bundle name is null.public void setDimensionValues(java.util.List pDimensionValues)
public java.lang.String getLocale(java.lang.String pLanguage)
pLanguage
- language string to map to localepublic boolean dimensionMatchesValue(DynamoHttpServletRequest pRequest, java.lang.String pValue)
dimensionMatchesValue
in interface SearchDimension
dimensionMatchesValue
in class GenericDimensionService
pRequest
- DynamoHttpServletRequest.pValue
- locale string.public boolean dimensionMatchesValue(java.lang.String pSourceValue, java.lang.String pTargetValue)
dimensionMatchesValue
in interface SearchDimension
dimensionMatchesValue
in class GenericDimensionService
pSourceValue
- String source value to checkpTargetValue
- String target value to check.public boolean dimensionMatchesValue(RepositoryItem pProfile, java.lang.String pTargetValue)
GenericDimensionService
dimensionMatchesValue
in interface SearchDimension
dimensionMatchesValue
in class GenericDimensionService
pProfile
- RepositoryItem profile to usepTargetValue
- String vlaue to check.public java.util.Locale getLocaleFromProfile(RepositoryItem pProfile)
pProfile
- RepositoryItem profile to usepublic java.lang.String getLocaleDisplayName(java.lang.String pLocaleString)
pLocaleString
- String localejava.lang.NullPointerException
- if locale or resource bundle name is null.public boolean isProfileBased()
protected boolean doesLanguageMatchLocale(java.util.Locale pLocale, java.lang.String pLanguage)
pLocale
- Locale to checkpLanguage
- String language to checkprotected boolean validateLocales(java.util.List pLocales)
pLocales
- List of String locale, e.g. "en_US"protected boolean validateLocales(java.util.Map pMap)
pMap
- Map of String language to String locale, e.g. "english=en_US"protected boolean validateLocale(java.lang.String pLocale)
pLocale
- String locale, e.g. "en_US"