public class Range extends DynamoServlet
Each iteration will set several parameters: index and count to the current loop index (0-based) and count (1-based), respectively; element to the value of that element of the array; hasPrev and hasNext to indicate whether there are array items before or after the current subset, respectively; plus several others to help render the previous or next range of elements.
A complete description of the parameters to the Range droplet are:
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ARRAY |
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
COUNT |
static java.lang.String |
ELEMENT |
static java.lang.String |
ELEMENT_NAME |
static java.lang.String |
EMPTY |
static java.lang.String |
END |
static java.lang.String |
HAS_NEXT |
static java.lang.String |
HAS_PREV |
static java.lang.String |
HOW_MANY |
static java.lang.String |
INDEX |
static java.lang.String |
INDEX_NAME |
static java.lang.String |
KEY |
static java.lang.String |
NEXT_END |
static java.lang.String |
NEXT_HOW_MANY |
static java.lang.String |
NEXT_START |
static java.lang.String |
OUTPUT |
static java.lang.String |
OUTPUT_END |
static java.lang.String |
OUTPUT_START |
static java.lang.String |
PREV_END |
static java.lang.String |
PREV_HOW_MANY |
static java.lang.String |
PREV_START |
static java.lang.String |
SIZE |
static java.lang.String |
START |
mAllowCleanupRequest, mParameters
SERVLET_INFO_KEY
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 |
---|
Range() |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getArray(DynamoHttpServletRequest pRequest)
Gets the array-like value (e.g., array, Vector, Enumeration)
to be used by this droplet from the request.
|
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called when a request needs to be processed.
|
protected void |
serviceArray(java.lang.Object pArray,
int pStart,
int pHowMany,
java.lang.String pIndexName,
java.lang.String pElementName,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Renders the range operation for array objects
|
protected void |
serviceCollection(java.util.Collection pCollection,
int pStart,
int pHowMany,
java.lang.String pIndexName,
java.lang.String pElementName,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Renders the range operation for Collection objects
|
protected void |
serviceDictionary(java.util.Dictionary pDictionary,
int pStart,
int pHowMany,
java.lang.String pIndexName,
java.lang.String pElementName,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Renders the range operation for Dictionary objects
|
protected void |
serviceEnumeration(java.util.Enumeration pEnumeration,
int pStart,
int pHowMany,
java.lang.String pIndexName,
java.lang.String pElementName,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Renders the range operation for Enumeration objects
|
protected void |
serviceIterator(java.util.Iterator pIterator,
int pStart,
int pHowMany,
java.lang.String pIndexName,
java.lang.String pElementName,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Renders the range operation for Interator objects
|
protected void |
serviceList(java.util.List pList,
int pStart,
int pHowMany,
java.lang.String pIndexName,
java.lang.String pElementName,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Renders the range operation for List objects
|
protected void |
serviceMap(java.util.Map pMap,
int pStart,
int pHowMany,
java.lang.String pIndexName,
java.lang.String pElementName,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Renders the range operation for Map objects
|
static void |
setPrevNextParameters(int pStart,
int pHowMany,
int pLength,
DynamoHttpServletRequest pRequest)
Sets the HAS_PREV/NEXT, PREV/NEXT_START, PREV/NEXT_END,
PREV/NEXT_HOW_MANY, SIZE, and END parameters based on the input
parameter values and the length of the array.
|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter
destroy, getServletConfig, getServletInfo, setServletInfo
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics
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
public static java.lang.String CLASS_VERSION
public static final java.lang.String ARRAY
public static final java.lang.String START
public static final java.lang.String HOW_MANY
public static final java.lang.String INDEX_NAME
public static final java.lang.String ELEMENT_NAME
public static final java.lang.String OUTPUT_START
public static final java.lang.String OUTPUT_END
public static final java.lang.String OUTPUT
public static final java.lang.String EMPTY
public static final java.lang.String INDEX
public static final java.lang.String COUNT
public static final java.lang.String ELEMENT
public static final java.lang.String KEY
public static final java.lang.String END
public static final java.lang.String SIZE
public static final java.lang.String HAS_PREV
public static final java.lang.String HAS_NEXT
public static final java.lang.String PREV_START
public static final java.lang.String PREV_END
public static final java.lang.String PREV_HOW_MANY
public static final java.lang.String NEXT_START
public static final java.lang.String NEXT_END
public static final java.lang.String NEXT_HOW_MANY
public java.lang.Object getArray(DynamoHttpServletRequest pRequest)
public static void setPrevNextParameters(int pStart, int pHowMany, int pLength, DynamoHttpServletRequest pRequest)
public void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
service
in class DynamoServlet
pRequest
- the request to be processedpResponse
- the response object for this requestjavax.servlet.ServletException
- if an application specific error
occurred processing this requestjava.io.IOException
- if an error occurred reading data from
the request or writing data to the responseprotected void serviceArray(java.lang.Object pArray, int pStart, int pHowMany, java.lang.String pIndexName, java.lang.String pElementName, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pArray
- the object to iteratepStart
- Specifies the starting index (1-based). For example, to start at
the beginning of the array, set start to 1. If start
points past the end of the array, the empty parameter will be
rendered.pHowMany
- Specifies the number of items in the array set to display. If the
combination of start and howMany point past the end of
the array, rendering stops after the end of the array is reached.pIndexName
- the parameter name to use for the indexpElementName
- the parameter name to use for the elementpRequest
- the request to be processedpResponse
- the response object for this requestjavax.servlet.ServletException
- if an application specific error occurred processing this requestjava.io.IOException
- if an error occurred reading data from the request or writing data to the responseprotected void serviceList(java.util.List pList, int pStart, int pHowMany, java.lang.String pIndexName, java.lang.String pElementName, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pList
- the object to iteratepStart
- Specifies the starting index (1-based). For example, to start at
the beginning of the array, set start to 1. If start
points past the end of the array, the empty parameter will be
rendered.pHowMany
- Specifies the number of items in the array set to display. If the
combination of start and howMany point past the end of
the array, rendering stops after the end of the array is reached.pIndexName
- the parameter name to use for the indexpElementName
- the parameter name to use for the elementpRequest
- the request to be processedpResponse
- the response object for this requestjavax.servlet.ServletException
- if an application specific error occurred processing this requestjava.io.IOException
- if an error occurred reading data from the request or writing data to the responseprotected void serviceCollection(java.util.Collection pCollection, int pStart, int pHowMany, java.lang.String pIndexName, java.lang.String pElementName, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pCollection
- the object to iteratepStart
- Specifies the starting index (1-based). For example, to start at
the beginning of the array, set start to 1. If start
points past the end of the array, the empty parameter will be
rendered.pHowMany
- Specifies the number of items in the array set to display. If the
combination of start and howMany point past the end of
the array, rendering stops after the end of the array is reached.pIndexName
- the parameter name to use for the indexpElementName
- the parameter name to use for the elementpRequest
- the request to be processedpResponse
- the response object for this requestjavax.servlet.ServletException
- if an application specific error occurred processing this requestjava.io.IOException
- if an error occurred reading data from the request or writing data to the responseprotected void serviceIterator(java.util.Iterator pIterator, int pStart, int pHowMany, java.lang.String pIndexName, java.lang.String pElementName, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pIterator
- the object to iteratepStart
- Specifies the starting index (1-based). For example, to start at
the beginning of the array, set start to 1. If start
points past the end of the array, the empty parameter will be
rendered.pHowMany
- Specifies the number of items in the array set to display. If the
combination of start and howMany point past the end of
the array, rendering stops after the end of the array is reached.pIndexName
- the parameter name to use for the indexpElementName
- the parameter name to use for the elementpRequest
- the request to be processedpResponse
- the response object for this requestjavax.servlet.ServletException
- if an application specific error occurred processing this requestjava.io.IOException
- if an error occurred reading data from the request or writing data to the responseprotected void serviceEnumeration(java.util.Enumeration pEnumeration, int pStart, int pHowMany, java.lang.String pIndexName, java.lang.String pElementName, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pEnumeration
- the object to iteratepStart
- Specifies the starting index (1-based). For example, to start at
the beginning of the array, set start to 1. If start
points past the end of the array, the empty parameter will be
rendered.pHowMany
- Specifies the number of items in the array set to display. If the
combination of start and howMany point past the end of
the array, rendering stops after the end of the array is reached.pIndexName
- the parameter name to use for the indexpElementName
- the parameter name to use for the elementpRequest
- the request to be processedpResponse
- the response object for this requestjavax.servlet.ServletException
- if an application specific error occurred processing this requestjava.io.IOException
- if an error occurred reading data from the request or writing data to the responseprotected void serviceMap(java.util.Map pMap, int pStart, int pHowMany, java.lang.String pIndexName, java.lang.String pElementName, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pMap
- the object to iteratepStart
- Specifies the starting index (1-based). For example, to start at
the beginning of the array, set start to 1. If start
points past the end of the array, the empty parameter will be
rendered.pHowMany
- Specifies the number of items in the array set to display. If the
combination of start and howMany point past the end of
the array, rendering stops after the end of the array is reached.pIndexName
- the parameter name to use for the indexpElementName
- the parameter name to use for the elementpRequest
- the request to be processedpResponse
- the response object for this requestjavax.servlet.ServletException
- if an application specific error occurred processing this requestjava.io.IOException
- if an error occurred reading data from the request or writing data to the responseprotected void serviceDictionary(java.util.Dictionary pDictionary, int pStart, int pHowMany, java.lang.String pIndexName, java.lang.String pElementName, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pDictionary
- the object to iteratepStart
- Specifies the starting index (1-based). For example, to start at
the beginning of the array, set start to 1. If start
points past the end of the array, the empty parameter will be
rendered.pHowMany
- Specifies the number of items in the array set to display. If the
combination of start and howMany point past the end of
the array, rendering stops after the end of the array is reached.pIndexName
- the parameter name to use for the indexpElementName
- the parameter name to use for the elementpRequest
- the request to be processedpResponse
- the response object for this requestjavax.servlet.ServletException
- if an application specific error occurred processing this requestjava.io.IOException
- if an error occurred reading data from the request or writing data to the response