atg.projects.store.droplet

Class ArraySubsetHelper

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.nucleus.TimedOperationService

atg.nucleus.servlet.ServletService

atg.nucleus.servlet.HttpServletService

atg.servlet.DynamoServlet

atg.projects.store.droplet.ArraySubsetHelper

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameContextParentable, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.Configured, 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 ArraySubsetHelper
extends atg.servlet.DynamoServlet

This droplet determines the indices of a corresponding array if the array was subdivided into separate parts. It was designed with the display of product ranges in mind. It allows the user to display a numerical navigation through the subsets of a given array.

This droplet takes the following input parameters:

• array - Collection or array to calculate against.
• subsetsize - The size of the array subsets.

This droplet renders the following oparams:

• output - always rendered

This droplet sets the following output parameters:

• subsetIndices - list of indices for the given subdivisions

This droplet assumes the base index starts at 1. Those who wish this to start at zero should set the startIndexAtZero value to true.

Example:

 <dsp:droplet bean="/atg/store/droplet/ArraySubsetHelper"> <dsp:param
 name="array" param="category.childProducts"> <dsp:param
 name="elementName" value="subsetIndex"> <dsp:param name="subsetSize"
 value="10"> <dsp:oparam name="output"> <dsp:droplet
 name="ForEach"> <dsp:param name="array" param="subsetIndices">
 <dsp:oparam name="output"> <dsp:valueof param="count"/>
 <dsp:valueof param="subsetIndex"/> </dsp:oparam>
 </dsp:oparam> </dsp:droplet>

 

Version:

$Revision: #1 $

Author:

ATG

Field Summary

Fields

Modifier and Type	Field and Description
static atg.nucleus.naming.ParameterName	ARRAY Array parameter name.
static java.lang.String	CLASS_VERSION Class version string.
static atg.nucleus.naming.ParameterName	OUTPUT Output parameter name.
static java.lang.String	SUBSETINDEXES Subset indices parameter name.
static atg.nucleus.naming.ParameterName	SUBSETSIZE Subset size parameter name.

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

Constructors

Constructor and Description
ArraySubsetHelper()

Method Summary

Modifier and Type	Method and Description
boolean	isStartIndexAtZero()
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This performs the work as described in the class definition.
void	setStartIndexAtZero(boolean pStartIndexAtZero)

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, 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, toString

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, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string.

See Also:

Constant Field Values

ARRAY

public static final atg.nucleus.naming.ParameterName ARRAY

Array parameter name.

SUBSETSIZE

public static final atg.nucleus.naming.ParameterName SUBSETSIZE

Subset size parameter name.

OUTPUT

public static final atg.nucleus.naming.ParameterName OUTPUT

Output parameter name.

SUBSETINDEXES

public static final java.lang.String SUBSETINDEXES

Subset indices parameter name.

See Also:

Constant Field Values

Constructor Detail

ArraySubsetHelper

public ArraySubsetHelper()

Method Detail

setStartIndexAtZero

public void setStartIndexAtZero(boolean pStartIndexAtZero)

Parameters:

pStartIndexAtZero - - this assumes the indices returned started at zero.

isStartIndexAtZero

public boolean isStartIndexAtZero()

Returns:

If set this assumes the indices returned started at zero. Default is false.

service

public void service(atg.servlet.DynamoHttpServletRequest pRequest,
                    atg.servlet.DynamoHttpServletResponse pResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException

This performs the work as described in the class definition.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - - http request

pResponse - - http response

Throws:

javax.servlet.ServletException - - if error occurs

java.io.IOException - - if error occurs