atg.repository.search.refinement

Class FacetManager

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.repository.search.refinement.FacetManager

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, 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

Direct Known Subclasses:

CommerceFacetManager

public class FacetManager
extends GenericService

Manager class to get and set items in the refinement repository.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected RefinementConfigurationPropertyManager	mRefinementConfigurationPropertyManager
protected RefinementElementPropertyManager	mRefinementElementPropertyManager
Repository	mRepository
protected java.lang.String	mSearchFacetId
protected atg.repository.search.refinement.admin.SortOptionPropertyManager	mSortOptionPropertyManager

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

Constructors

Constructor and Description
FacetManager()

Method Summary

Methods

Modifier and Type	Method and Description
protected RepositoryItem	getItem(java.lang.String pItemId, java.lang.String pItemDescriptorName) Returns the refinement repository item with the given id and item descriptor.
RepositoryItem	getRefineConfigById(java.lang.String pRefineConfigId) Returns the refinement configuration object with the given id.
RepositoryItem	getRefineElementById(java.lang.String pRefineElementId) Returns the refinement element object with the given id.
RefinementConfigurationPropertyManager	getRefinementConfigurationPropertyManager()
RefinementElementPropertyManager	getRefinementElementPropertyManager()
Repository	getRepository()
java.lang.String	getSearchFacetId()
RepositoryItem	getSortOptionById(java.lang.String pSortOptionId) Returns the sort option object with the given id.
atg.repository.search.refinement.admin.SortOptionPropertyManager	getSortOptionPropertyManager()
void	setRefinementConfigurationPropertyManager(RefinementConfigurationPropertyManager pRefinementConfigurationPropertyManager)
void	setRefinementElementPropertyManager(RefinementElementPropertyManager pRefinementElementPropertyManager)
void	setRepository(Repository pRepository)
void	setSearchFacetId(java.lang.String pSearchFacetId)
void	setSortOptionPropertyManager(atg.repository.search.refinement.admin.SortOptionPropertyManager pSortOptionPropertyManager)

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

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mRefinementConfigurationPropertyManager

protected RefinementConfigurationPropertyManager mRefinementConfigurationPropertyManager

mRefinementElementPropertyManager

protected RefinementElementPropertyManager mRefinementElementPropertyManager

mSortOptionPropertyManager

protected atg.repository.search.refinement.admin.SortOptionPropertyManager mSortOptionPropertyManager

mRepository

public Repository mRepository

mSearchFacetId

protected java.lang.String mSearchFacetId

Constructor Detail

FacetManager

public FacetManager()

Method Detail

getRefinementConfigurationPropertyManager

public RefinementConfigurationPropertyManager getRefinementConfigurationPropertyManager()

setRefinementConfigurationPropertyManager

public void setRefinementConfigurationPropertyManager(RefinementConfigurationPropertyManager pRefinementConfigurationPropertyManager)

getRefinementElementPropertyManager

public RefinementElementPropertyManager getRefinementElementPropertyManager()

setRefinementElementPropertyManager

public void setRefinementElementPropertyManager(RefinementElementPropertyManager pRefinementElementPropertyManager)

getSortOptionPropertyManager

public atg.repository.search.refinement.admin.SortOptionPropertyManager getSortOptionPropertyManager()

setSortOptionPropertyManager

public void setSortOptionPropertyManager(atg.repository.search.refinement.admin.SortOptionPropertyManager pSortOptionPropertyManager)

getRepository

public Repository getRepository()

setRepository

public void setRepository(Repository pRepository)

getSearchFacetId

public java.lang.String getSearchFacetId()

setSearchFacetId

public void setSearchFacetId(java.lang.String pSearchFacetId)

getRefineConfigById

public RepositoryItem getRefineConfigById(java.lang.String pRefineConfigId)
                                   throws RepositoryException

Returns the refinement configuration object with the given id. The item has a descriptor type of "refineConfig" in the repository.

Parameters:

pRefineConfigId - String id of the refinement configuration to retrieve

Returns:

a RepositoryItem object if the item can be found, otherwise null is returned.

Throws:

RepositoryException

getRefineElementById

public RepositoryItem getRefineElementById(java.lang.String pRefineElementId)
                                    throws RepositoryException

Returns the refinement element object with the given id. The item has a descriptor type of "refineElement" in the repository.

Parameters:

pRefineElementId - String id of the refinement element to retrieve

Returns:

a RepositoryItem object if the item can be found, otherwise null is returned.

Throws:

RepositoryException

getSortOptionById

public RepositoryItem getSortOptionById(java.lang.String pSortOptionId)
                                 throws RepositoryException

Returns the sort option object with the given id. The item has a descriptor type of "sortOption".

Parameters:

pSortOptionId - String id of the sort option to retrieve

Returns:

a RepositoryItem object if the item can be found, otherwise null is returned.

Throws:

RepositoryException

getItem

protected RepositoryItem getItem(java.lang.String pItemId,
                     java.lang.String pItemDescriptorName)
                          throws RepositoryException

Returns the refinement repository item with the given id and item descriptor.

Parameters:

pItemId - String id of the item to retrieve

pItemDescriptorName - String item descriptor name

Returns:

a RepositoryItem object if the item can be found, otherwise null is returned.

Throws:

RepositoryException