atg.projects.store.droplet

Class StoreDistanceDroplet

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.StoreDistanceDroplet

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 StoreDistanceDroplet
extends atg.servlet.DynamoServlet

This Droplet is used to extract the distance of store from current location.

Example1:

 <dsp:droplet name="StoreDistanceDroplet">
   <dsp:param name="variable" value="${recordAttribute}"/> 
   <dsp:param name="fraction" value="3"/>
   <dsp:oparam name="output">
     <dsp:getvalueof var="distance" param="distance"/>
   </dsp:oparam>
 </dsp:droplet>
 

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/11.0/EStore/src/atg/projects/store/droplet/StoreDistanceDroplet.java#1 $

Author:

Oracle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string.

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
StoreDistanceDroplet()

Method Summary

Methods

Modifier and Type	Method and Description
double	extractValue(java.lang.String pRecordAttribute) This method extracts the value of distance variable from recordAttribute that is dynamically generated by Endeca.
double	formatDistance(double formatValue, int maxNumberOfDecimalPlaces) This method is used to round off the given double number up to maxNumberOfDecimalPlaces.
java.lang.String	getDistanceVariable()
int	getNumberOfDecimalPlaces()
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Extracts the store distance from Endeca generated record attributes.
void	setDistanceVariable(java.lang.String pDistanceVariable)
void	setNumberOfDecimalPlaces(int pNumberOfDecimalPlaces)

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

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.

Constructor Detail

StoreDistanceDroplet

public StoreDistanceDroplet()

Method Detail

getNumberOfDecimalPlaces

public int getNumberOfDecimalPlaces()

Returns:

mNumberOfDecimal Number of decimal places.

setNumberOfDecimalPlaces

public void setNumberOfDecimalPlaces(int pNumberOfDecimalPlaces)

Parameters:

pNumberOfDecimal - Number of decimal places.

getDistanceVariable

public java.lang.String getDistanceVariable()

Returns:

mDistanceVariable Name of distance variable.

setDistanceVariable

public void setDistanceVariable(java.lang.String pDistanceVariable)

Parameters:

pDistanceVariable - Name of distance variable.

service

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

Extracts the store distance from Endeca generated record attributes.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - A DynamoHttpServletRequest value.

pResponse - A DynamoHttpServletResponse value.

Throws:

javax.servlet.ServletException - If an error occurs.

java.io.IOException - If an error occurs.

extractValue

public double extractValue(java.lang.String pRecordAttribute)

This method extracts the value of distance variable from recordAttribute that is dynamically generated by Endeca.

Parameters:

pRecordAttribute - A string that holds the value of the Endeca generated content item.

Returns:

value Distance of store in kilometer.

formatDistance

public double formatDistance(double formatValue,
                    int maxNumberOfDecimalPlaces)

This method is used to round off the given double number up to maxNumberOfDecimalPlaces.

Parameters:

formatValue - Input value to format.

maxNumberOfDecimalPlaces - Maximum number of decimal places.

Returns:

roundOff Value after round off.