|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.repository.search.config.GenericDimensionService
public abstract class GenericDimensionService
Abstract base class to implement a dimension service. Provides the functionality to look up a resource bundle to get localised names for dimension values and for this dimension.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected java.lang.String |
mDimensionName
|
protected java.lang.String |
mDimensionValueKeyPrefix
|
protected boolean |
mDimensionValuesLocalized
|
protected boolean |
mDisabled
|
protected java.lang.String |
mDisplayNameKey
|
protected boolean |
mDisplayNameLocalized
|
protected atg.core.i18n.MultiBundleFormatter |
mFormatter
|
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
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 | |
---|---|
GenericDimensionService()
|
Method Summary | |
---|---|
boolean |
dimensionMatchesValue(DynamoHttpServletRequest pRequest,
java.lang.String pValue)
Checks whether or not a value matches this service. |
boolean |
dimensionMatchesValue(RepositoryItem pProfile,
java.lang.String pValue)
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. |
java.util.List |
getAllDimensionValues()
Returns list of dimension values + additional special element null. |
java.lang.String |
getDimensionName()
Gets the string name of this dimension, e.g. |
java.lang.String |
getDimensionValueDisplayName(java.lang.String pDimensionValue)
Method to get a localised display name for a dimension value. |
java.lang.String |
getDimensionValueKeyPrefix()
|
boolean |
getDimensionValuesLocalized()
|
java.lang.String |
getDisplayName()
Method to get a localised display name for this dimension. |
java.lang.String |
getDisplayNameKey()
|
boolean |
getDisplayNameLocalized()
|
atg.core.i18n.MultiBundleFormatter |
getFormatter()
|
boolean |
isDisabled()
|
void |
setDimensionName(java.lang.String pDimensionName)
|
void |
setDimensionValueKeyPrefix(java.lang.String pDimensionValueKeyPrefix)
|
void |
setDimensionValuesLocalized(boolean pDimensionValuesLocalized)
|
void |
setDisabled(boolean pDisabled)
|
void |
setDisplayNameKey(java.lang.String pDisplayNameKey)
|
void |
setDisplayNameLocalized(boolean pDisplayNameLocalized)
|
void |
setFormatter(atg.core.i18n.MultiBundleFormatter pFormatter)
|
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, toString, wait, wait, wait |
Methods inherited from interface atg.repository.search.config.SearchDimension |
---|
getDimensionValues, isProfileBased |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected java.lang.String mDimensionName
protected atg.core.i18n.MultiBundleFormatter mFormatter
protected java.lang.String mDimensionValueKeyPrefix
protected java.lang.String mDisplayNameKey
protected boolean mDisplayNameLocalized
protected boolean mDimensionValuesLocalized
protected boolean mDisabled
Constructor Detail |
---|
public GenericDimensionService()
Method Detail |
---|
public java.lang.String getDimensionName()
SearchDimension
getDimensionName
in interface SearchDimension
public void setDimensionName(java.lang.String pDimensionName)
public atg.core.i18n.MultiBundleFormatter getFormatter()
public void setFormatter(atg.core.i18n.MultiBundleFormatter pFormatter)
public java.lang.String getDimensionValueKeyPrefix()
public void setDimensionValueKeyPrefix(java.lang.String pDimensionValueKeyPrefix)
public java.lang.String getDisplayNameKey()
public void setDisplayNameKey(java.lang.String pDisplayNameKey)
public boolean getDisplayNameLocalized()
public void setDisplayNameLocalized(boolean pDisplayNameLocalized)
public boolean getDimensionValuesLocalized()
public void setDimensionValuesLocalized(boolean pDimensionValuesLocalized)
public boolean isDisabled()
isDisabled
in interface SearchDimension
public void setDisabled(boolean pDisabled)
public java.lang.String getDisplayName()
getDisplayName
in interface SearchDimension
java.util.MissingResourceException
- if resource can't be found.
java.lang.NullPointerException
- if locale or resource bundle name is null.public java.lang.String getDimensionValueDisplayName(java.lang.String pDimensionValue)
getDimensionValueDisplayName
in interface SearchDimension
pDimensionValue
- String dimension value
java.util.MissingResourceException
- if resource can't be found.
java.lang.NullPointerException
- if locale or resource bundle name is null.public boolean dimensionMatchesValue(java.lang.String pSourceValue, java.lang.String pTargetValue)
dimensionMatchesValue
in interface SearchDimension
pSourceValue
- String source value to checkpTargetValue
- String target value to check.
public boolean dimensionMatchesValue(DynamoHttpServletRequest pRequest, java.lang.String pValue)
dimensionMatchesValue
in interface SearchDimension
pRequest
- is the current customer DynamoHttpServletRequest request.pValue
- is the dimensionValue
property of the item being checked.
pValue
is matched with appropriate value from pRequest
.public boolean dimensionMatchesValue(RepositoryItem pProfile, java.lang.String pValue)
dimensionMatchesValue
in interface SearchDimension
pProfile
- RepositoryItem profile to usepValue
- String vlaue to check.
public java.util.List getAllDimensionValues()
getAllDimensionValues
in interface SearchDimension
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |