atg.droplet
Class Format
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.droplet.Format
- All Implemented Interfaces:
- NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet
public class Format
- extends DynamoServlet
This servlet uses java.text.MessageFormat
to set a message
string parameter that can be used when the output parameter is
rendered.
A complete description of the parameters to the Format droplet is:
- format
- The format string used to construct the
java.text.MessageFormat
object. Typically this is just
a string containing parameter names in curly braces showing where the
arguments should be placed in the resulting message string, although many
more advanced features and options are available. The syntax of the
format is the same as that of java.text.MessageFormat
,
except that named parameters are used instead of numeric ones.
See the
java.text.MessageFormat
javadoc for more details.
- named parameters
-
The arguments to be formatted. These may be objects of any type, but
are typically strings. The name of each parameter should correspond to
a name inside curly braces in the format parameter.
- locale
- The
java.util.Locale
object passed to the constructed
MessageFormat object using the setLocale
method. If this
parameter is omitted, the locale of the request is used.
Examples:
A simple example that concatentates two strings.
<droplet bean="/atg/dynamo/droplet/Format">
<param name="format" value="{first}{last}">
<param name="first" value="bean:/MyComponent.firstString">
<param name="last" value="bean:/MyComponent.secondString">
<oparam name="output">
The concatenated value is <valueof param="message"/>.
</oparam>
</droplet>
This example is adapted from the MessageFormat javadoc:
<droplet bean="/atg/dynamo/droplet/Format">
<param name="format"
value="At {when,time} on {when,date}, there was {what} on planet {where,number,integer}.">
<param name="where" value="bean:/MyComponent.location">
<param name="when" value="bean:/MyComponent.date">
<param name="what" value="bean:/MyComponent.event">
<oparam name="output">
<valueof param="message"/>
</oparam>
</droplet>
If the "/MyComponent" component
has properties "location", "date", and "event" with values "new Integer(7)",
"new Date(System.currentTimeMillis())", and "a disturbance in the Force", the
output might be
At 12:30 PM on Jul 3, 2053, there was a disturbance in the Force on planet 7.
- See Also:
MessageFormat
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
DEFAULT_LOG_TRACE_STATUS |
Methods inherited from class atg.nucleus.GenericService |
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService |
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 |
CLASS_VERSION
public static java.lang.String CLASS_VERSION
Format
public Format()
getCacheSize
public int getCacheSize()
- Return the number of format strings to cache.
setCacheSize
public void setCacheSize(int pCacheSize)
- Set the number of format strings to cache.
service
public void service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
throws javax.servlet.ServletException,
java.io.IOException
- Evaluate the droplet.
- Overrides:
service
in class DynamoServlet
- Parameters:
pRequest
- the request to be processedpResponse
- the response object for this request
- Throws:
javax.servlet.ServletException
- an application specific error occurred
processing this request
java.io.IOException
- an error occurred reading data from the request
or writing data to the response.