atg.repository.search.indexing.config
Class RankConfigAdapter

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.search.adapter.customization.CustomizationDataAdapterImpl
              atg.repository.search.indexing.config.RankConfigAdapter

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, atg.search.adapter.customization.CustomizationDataAdapter, java.util.EventListener

public class RankConfigAdapter
extends atg.search.adapter.customization.CustomizationDataAdapterImpl

This adapter should be registered with the search engine and will return RankConfigItem objects for each search configuration in the refinement repository.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	PATH_SEPARATOR

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

RankConfigAdapter()

Method Summary

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

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, 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, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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.naming.NameContextElement

getName, getNameContext

Methods inherited from interface atg.naming.NameContextBindingListener

nameContextElementBound, nameContextElementUnbound

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

PATH_SEPARATOR

public static final java.lang.String PATH_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

RankConfigAdapter

public RankConfigAdapter()

Method Detail

getSearchConfigurationXMLGenerator

public SearchConfigurationXMLGenerator getSearchConfigurationXMLGenerator()

Returns SearchConfigurationXMLGenerator

Returns:

SearchConfigurationXMLGenerator

setSearchConfigurationXMLGenerator

public void setSearchConfigurationXMLGenerator(SearchConfigurationXMLGenerator pSearchConfigurationXMLGenerator)

Sets SearchConfigurationXMLGenerator

Parameters:

pSearchConfigurationXMLGenerator - SearchConfigurationXMLGenerator

getRefinementRepository

public Repository getRefinementRepository()

Returns refinement repository.

Returns:

refinement repository

setRefinementRepository

public void setRefinementRepository(Repository pRefinementRepository)

Sets refinement repository.

Parameters:

pRefinementRepository - refinement repository

getDisplayName

public java.lang.String getDisplayName()

Returns the string name for this adapter as defined in the configuration for this adapter, default is "RankConfigAdapter".

Specified by:

getDisplayName in interface atg.search.adapter.customization.CustomizationDataAdapter

Specified by:

getDisplayName in class atg.search.adapter.customization.CustomizationDataAdapterImpl

Returns:

string name for this adapter

setDisplayName

public void setDisplayName(java.lang.String pDisplayName)

Sets name for this adapter.

Parameters:

pDisplayName - display name

getApplicationName

public java.lang.String getApplicationName()

setApplicationName

public void setApplicationName(java.lang.String pApplicationName)

getSearchConfigurationPropertyManager

public SearchConfigurationPropertyManager getSearchConfigurationPropertyManager()

setSearchConfigurationPropertyManager

public void setSearchConfigurationPropertyManager(SearchConfigurationPropertyManager pSearchConfigurationPropertyManager)

isAutoApplyAll

public boolean isAutoApplyAll()

Whether to auto-apply all customization items. This also hides the customization items from enumerateCustomizationItemsByType, and enumerateCustomizationItems methods from the CustomizationDataAdapter interface.

Specified by:

isAutoApplyAll in interface atg.search.adapter.customization.CustomizationDataAdapter

Overrides:

isAutoApplyAll in class atg.search.adapter.customization.CustomizationDataAdapterImpl

enumerateCustomizationItems

public java.util.List enumerateCustomizationItems()

Returns the repository id's for all the search configuration repository items.

Specified by:

enumerateCustomizationItems in interface atg.search.adapter.customization.CustomizationDataAdapter

Specified by:

enumerateCustomizationItems in class atg.search.adapter.customization.CustomizationDataAdapterImpl

Returns:

List of id's

enumerateCustomizationItemsByType

public 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. Otherwise an empty list is returned.

Specified by:

enumerateCustomizationItemsByType in interface atg.search.adapter.customization.CustomizationDataAdapter

Specified by:

enumerateCustomizationItemsByType in class atg.search.adapter.customization.CustomizationDataAdapterImpl

Parameters:

pCustomizationType - customization type

Returns:

List of id's

enumerateAutoApplyCustomizationItemsByTypeAndProject

public java.util.List enumerateAutoApplyCustomizationItemsByTypeAndProject(atg.search.adapter.customization.CustomizationType pCustomizationType,
                                                                           java.lang.String pProjectId)
                                                                    throws atg.search.adapter.exception.CustomizationItemNotFoundException

Returns the ids of the auto-apply customization items for the provided by this adapter for the given customization type and project.

Specified by:

enumerateAutoApplyCustomizationItemsByTypeAndProject in interface atg.search.adapter.customization.CustomizationDataAdapter

Overrides:

enumerateAutoApplyCustomizationItemsByTypeAndProject in class atg.search.adapter.customization.CustomizationDataAdapterImpl

Parameters:

pCustomizationType - The type of the customization

pProjectId - String project name

Returns:

List of String representing the customization items defined by this adapter. Returns an empty list if no customization items are defined for this adapter.

Throws:

atg.search.adapter.exception.CustomizationItemNotFoundException

getCustomizationItem

public atg.search.adapter.customization.CustomizationItem getCustomizationItem(atg.search.adapter.customization.CustomizationType pCustomizationType,
                                                                               java.lang.String pCustomizationItemId)
                                                                        throws atg.search.adapter.exception.CustomizationItemNotFoundException

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. Otherwise it will create a RankConfigItem for it to return.

Specified by:

getCustomizationItem in interface atg.search.adapter.customization.CustomizationDataAdapter

Specified by:

getCustomizationItem in class atg.search.adapter.customization.CustomizationDataAdapterImpl

Parameters:

pCustomizationType - customization type

pCustomizationItemId - repository item id

Returns:

RankConfigItem object

Throws:

atg.search.adapter.exception.CustomizationItemNotFoundException - if repository item isn't found

getSupportedCustomizationTypes

public java.util.Collection getSupportedCustomizationTypes()

Returns a list only containing the CustomizationType.RANK_CONFIG item.

Specified by:

getSupportedCustomizationTypes in interface atg.search.adapter.customization.CustomizationDataAdapter

Specified by:

getSupportedCustomizationTypes in class atg.search.adapter.customization.CustomizationDataAdapterImpl

Returns:

List only containing the CustomizationType.RANK_CONFIG item.