atg.projects.store.droplet
Class FacetDisplayDroplet

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.nucleus.TimedOperationService
              extended by atg.nucleus.servlet.ServletService
                  extended by atg.nucleus.servlet.HttpServletService
                      extended by atg.servlet.DynamoServlet
                          extended by atg.projects.store.droplet.FacetDisplayDroplet
All Implemented Interfaces:
atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, atg.servlet.ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class FacetDisplayDroplet
extends atg.servlet.DynamoServlet

A droplet that will return facets in a List ordered their priority. The list item will either be a FacetHolder or a FacetValue depending on whether the facet has been selected. Input Parameters: appliedFacets - This is the facets that are currently applied, it should be set to the current FacetTrail. Open Parameters: output - Rendered when there are no errors Output Parameters: facetOptions - A List of FacetHolder and FacetValue options in priority order displayAll - A list of refinement ids whose facets shouldnt have the "More/Less" pagination applied.


Field Summary
static java.lang.String CLASS_VERSION
          Class Version
static java.lang.String OPARAM_OUTPUT
           
static java.lang.String OUT_DISPLAY_ALL
           
static java.lang.String OUT_FACET_OPTIONS
           
static java.lang.String OUT_SELECTED_FACET_COUNT
           
static java.lang.String PARAM_APPLIED_FACETS
           
 
Fields inherited from class atg.servlet.DynamoServlet
mAllowCleanupRequest, mParameters
 
Fields inherited from class atg.nucleus.servlet.ServletService
SERVLET_INFO_KEY
 
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
FacetDisplayDroplet()
           
 
Method Summary
 java.util.List getDisplayAll()
           
 java.util.List getExcludeFacets()
           
 atg.repository.search.refinement.FacetSearchTools getFacetSearchTools()
           
 void service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
          Returns an order list of facet objects (either FacetHolder's or FacetValue's depending on whether the facet is currently applied).
 void setDisplayAll(java.util.List pDisplayAll)
           
 void setExcludeFacets(java.util.List pExcludeFacets)
           
 void setFacetSearchTools(atg.repository.search.refinement.FacetSearchTools pFacetSearchTools)
           
 
Methods inherited from class atg.servlet.DynamoServlet
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, service, service, setParameter
 
Methods inherited from class atg.nucleus.servlet.ServletService
destroy, getServletConfig, getServletInfo, init, setServletInfo
 
Methods inherited from class atg.nucleus.TimedOperationService
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics
 
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 final java.lang.String CLASS_VERSION
Class Version

See Also:
Constant Field Values

PARAM_APPLIED_FACETS

public static final java.lang.String PARAM_APPLIED_FACETS
See Also:
Constant Field Values

OPARAM_OUTPUT

public static final java.lang.String OPARAM_OUTPUT
See Also:
Constant Field Values

OUT_FACET_OPTIONS

public static final java.lang.String OUT_FACET_OPTIONS
See Also:
Constant Field Values

OUT_SELECTED_FACET_COUNT

public static final java.lang.String OUT_SELECTED_FACET_COUNT
See Also:
Constant Field Values

OUT_DISPLAY_ALL

public static final java.lang.String OUT_DISPLAY_ALL
See Also:
Constant Field Values
Constructor Detail

FacetDisplayDroplet

public FacetDisplayDroplet()
Method Detail

getFacetSearchTools

public atg.repository.search.refinement.FacetSearchTools getFacetSearchTools()
Returns:
FacetSearchTools Component

setFacetSearchTools

public void setFacetSearchTools(atg.repository.search.refinement.FacetSearchTools pFacetSearchTools)
Parameters:
pFacetSearchTools -

getExcludeFacets

public java.util.List getExcludeFacets()
Returns:
List of facets ids whose facets are excluded from the returned list

setExcludeFacets

public void setExcludeFacets(java.util.List pExcludeFacets)
Parameters:
pExcludeFacets - Sets a list of facet ids whose facets are excluded from the returned list

getDisplayAll

public java.util.List getDisplayAll()
Returns:
List of facets ids whose facets should all be displayed without the "More" or "Less" pagination

setDisplayAll

public void setDisplayAll(java.util.List pDisplayAll)
Parameters:
pExcludeFacets - Sets a list of facets ids whose facets should all be displayed without the "More" or "Less" pagination

service

public void service(atg.servlet.DynamoHttpServletRequest pRequest,
                    atg.servlet.DynamoHttpServletResponse pResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException
Returns an order list of facet objects (either FacetHolder's or FacetValue's depending on whether the facet is currently applied).

Overrides:
service in class atg.servlet.DynamoServlet
Parameters:
pRequest - The current request
pResponse - The response
Throws:
ServletException, - IOException
javax.servlet.ServletException
java.io.IOException