|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.commerce.util.MapToArrayDefaultFirst
public class MapToArrayDefaultFirst
This droplet is used to convert a map property to a sorted array with the value of the first item being the item that matched the defaultId param. The droplet is primarily to sort the shipping address and credit card properties so that the default address or card is displayed as the first item on the jsp page. Each item in the sorted array is a repository item.
If either the defaultId or map parameters are not set, the droplet will return the map as an unsorted array. In the case of a null map, the returning array would be null.
This droplet takes the following parameters
Example
<dsp:droplet name="MapToArrayDefaultFirst"> <param name="defaultId" value="Profile.shippingAddress.repositoryId"/> <param name="map" value="Profile.shippingAddrs"/> <oparam name="output"> <dsp:droplet name="ForEach"> <param name="array" value="sortedArray"/> <oparam name="output"> key: <dsp:valueof param="element.key"/> address city: <dsp:valueof param="element.value.city">/> </oparam> </dsp:droplet> </oparam>> </droplet>
Parameters:
output- Rendered on successful sort.
sortedArray- Array of RepositoryItem
object with the default item first
sortedArraySize- Size of returned array
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string. |
static ParameterName |
DEFAULT_ID
Default id parameter name. |
static ParameterName |
MAP
Map parameter name. |
static ParameterName |
OUTPUT
Output parameter name. |
static java.lang.String |
SORTED_ARRAY
Sorted array parameter name. |
static java.lang.String |
SORTED_ARRAY_SIZE
Sorted array 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 | |
---|---|
MapToArrayDefaultFirst()
|
Method Summary | |
---|---|
protected boolean |
checkIfDefaultIsInMap(java.util.Map pMap,
java.lang.String pDefaultId)
Look in the map and see if an item with the defaultId value is in there. |
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
See the class documentation above. |
protected java.lang.Object[] |
sortArray(java.lang.Object[] pUnsortedArray,
java.lang.String pDefaultId,
DynamoHttpServletRequest pRequest)
Performs the sorting of the array of RepositoryItem. |
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.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 |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final ParameterName MAP
public static final ParameterName DEFAULT_ID
public static final ParameterName OUTPUT
public static java.lang.String SORTED_ARRAY
public static java.lang.String SORTED_ARRAY_SIZE
Constructor Detail |
---|
public MapToArrayDefaultFirst()
Method Detail |
---|
public void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
See the class documentation above.
service
in class DynamoServlet
pRequest
- - http requestpResponse
- - http response
javax.servlet.ServletException
- if an error occurs
java.io.IOException
- if an error occursprotected java.lang.Object[] sortArray(java.lang.Object[] pUnsortedArray, java.lang.String pDefaultId, DynamoHttpServletRequest pRequest)
pUnsortedArray
- of the propeties from the map.pDefaultId
- of the default RepositoryItempRequest
- object
protected boolean checkIfDefaultIsInMap(java.util.Map pMap, java.lang.String pDefaultId)
pMap
- - map to checkpDefaultId
- - default id
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |