public class RankConfigAdapter
extends atg.search.adapter.customization.CustomizationDataAdapterImpl
RankConfigItem
objects for each search configuration
in the refinement repository.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
PATH_SEPARATOR |
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 |
---|
RankConfigAdapter() |
Modifier and Type | Method and Description |
---|---|
java.util.List |
enumerateAutoApplyCustomizationItemsByTypeAndProject(atg.search.adapter.customization.CustomizationType pCustomizationType,
java.lang.String pProjectId)
Returns the ids of the auto-apply customization items for the
provided by this adapter for the given customization
type and project.
|
java.util.List |
enumerateCustomizationItems()
Returns the repository id's for all the search configuration repository items.
|
java.util.List |
enumerateCustomizationItemsByType(atg.search.adapter.customization.CustomizationType pCustomizationType)
Returns the repository id's for all the search configuration repository items
if the passed type is
CustomizationType.RANK_CONFIG . |
java.lang.String |
getApplicationName() |
atg.search.adapter.customization.CustomizationItem |
getCustomizationItem(atg.search.adapter.customization.CustomizationType pCustomizationType,
java.lang.String pCustomizationItemId)
If the passed in type isn't
CustomizationType.RANK_CONFIG
or a lookup of the repository item for the passed id pCustomizationItemId
isn't found then it throws the exception. |
java.lang.String |
getDisplayName()
Returns the string name for this adapter as defined in the configuration
for this adapter, default is "RankConfigAdapter".
|
Repository |
getRefinementRepository()
Returns refinement repository.
|
SearchConfigurationPropertyManager |
getSearchConfigurationPropertyManager() |
SearchConfigurationXMLGenerator |
getSearchConfigurationXMLGenerator()
Returns
SearchConfigurationXMLGenerator |
java.util.Collection |
getSupportedCustomizationTypes()
Returns a list only containing the CustomizationType.RANK_CONFIG item.
|
boolean |
isAutoApplyAll()
Whether to auto-apply all customization items.
|
void |
setApplicationName(java.lang.String pApplicationName) |
void |
setDisplayName(java.lang.String pDisplayName)
Sets name for this adapter.
|
void |
setRefinementRepository(Repository pRefinementRepository)
Sets refinement repository.
|
void |
setSearchConfigurationPropertyManager(SearchConfigurationPropertyManager pSearchConfigurationPropertyManager) |
void |
setSearchConfigurationXMLGenerator(SearchConfigurationXMLGenerator pSearchConfigurationXMLGenerator)
Sets
SearchConfigurationXMLGenerator |
getDisplayNameResource, getLocalizedDisplayName, getResourceBundleName, setDisplayNameResource, setResourceBundleName
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getName, getNameContext
nameContextElementBound, nameContextElementUnbound
public static final java.lang.String CLASS_VERSION
public static final java.lang.String PATH_SEPARATOR
public SearchConfigurationXMLGenerator getSearchConfigurationXMLGenerator()
SearchConfigurationXMLGenerator
public void setSearchConfigurationXMLGenerator(SearchConfigurationXMLGenerator pSearchConfigurationXMLGenerator)
SearchConfigurationXMLGenerator
pSearchConfigurationXMLGenerator
- SearchConfigurationXMLGeneratorpublic Repository getRefinementRepository()
public void setRefinementRepository(Repository pRefinementRepository)
pRefinementRepository
- refinement repositorypublic java.lang.String getDisplayName()
getDisplayName
in interface atg.search.adapter.customization.CustomizationDataAdapter
getDisplayName
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
public void setDisplayName(java.lang.String pDisplayName)
pDisplayName
- display namepublic java.lang.String getApplicationName()
public void setApplicationName(java.lang.String pApplicationName)
public SearchConfigurationPropertyManager getSearchConfigurationPropertyManager()
public void setSearchConfigurationPropertyManager(SearchConfigurationPropertyManager pSearchConfigurationPropertyManager)
public boolean isAutoApplyAll()
isAutoApplyAll
in interface atg.search.adapter.customization.CustomizationDataAdapter
isAutoApplyAll
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
public java.util.List enumerateCustomizationItems()
enumerateCustomizationItems
in interface atg.search.adapter.customization.CustomizationDataAdapter
enumerateCustomizationItems
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
public java.util.List enumerateCustomizationItemsByType(atg.search.adapter.customization.CustomizationType pCustomizationType)
CustomizationType.RANK_CONFIG
.
Otherwise an empty list is returned.enumerateCustomizationItemsByType
in interface atg.search.adapter.customization.CustomizationDataAdapter
enumerateCustomizationItemsByType
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
pCustomizationType
- customization typepublic java.util.List enumerateAutoApplyCustomizationItemsByTypeAndProject(atg.search.adapter.customization.CustomizationType pCustomizationType, java.lang.String pProjectId) throws atg.search.adapter.exception.CustomizationItemNotFoundException
enumerateAutoApplyCustomizationItemsByTypeAndProject
in interface atg.search.adapter.customization.CustomizationDataAdapter
enumerateAutoApplyCustomizationItemsByTypeAndProject
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
pCustomizationType
- The type of the customizationpProjectId
- String project nameatg.search.adapter.exception.CustomizationItemNotFoundException
public atg.search.adapter.customization.CustomizationItem getCustomizationItem(atg.search.adapter.customization.CustomizationType pCustomizationType, java.lang.String pCustomizationItemId) throws atg.search.adapter.exception.CustomizationItemNotFoundException
CustomizationType.RANK_CONFIG
or a lookup of the repository item for the passed id pCustomizationItemId
isn't found then it throws the exception. Otherwise it will create
a RankConfigItem
for it to return.getCustomizationItem
in interface atg.search.adapter.customization.CustomizationDataAdapter
getCustomizationItem
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
pCustomizationType
- customization typepCustomizationItemId
- repository item idatg.search.adapter.exception.CustomizationItemNotFoundException
- if repository item isn't foundpublic java.util.Collection getSupportedCustomizationTypes()
getSupportedCustomizationTypes
in interface atg.search.adapter.customization.CustomizationDataAdapter
getSupportedCustomizationTypes
in class atg.search.adapter.customization.CustomizationDataAdapterImpl
List
only containing the CustomizationType.RANK_CONFIG item.