Class NodeMatch

  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.nucleus.TimedOperationService
              extended by atg.nucleus.servlet.ServletService
                  extended by atg.nucleus.servlet.HttpServletService
                      extended by atg.servlet.DynamoServlet
                          extended by atg.droplet.xml.NodeMatch
All Implemented Interfaces:
NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class NodeMatch
extends DynamoServlet

Select the next DOM node that matches a pattern.

These are the parameters for the NodeMatch droplet:

Input Paramaters
node (required)
The DOM node from which to start the search. The match will only find nodes appearing after this node in the document. If this is a Document node, then the whole document will be searched.

match (required)
The pattern that is used to select the next node. This pattern can be any XPath expression, see (1999-11-16). Examples:
comment() select a comment child of the current node
widget-order select the next widget-order element
widget-order[@id=1111] select the widget-order element with the id attribute 1111
widget-order/@id select the value of the id attribute for the next widget-order element
Output Paramaters
The next DOM node which matches the pattern. This parameter is available for formatting in the output oparam.

Open Paramaters
The oparam to use when the required node and match parameters were not set.

The oparam used when there was a failure during the XML query. For example, the match parameter was an illegal XPath expression. If error logging is enabled, then the details of the exception will be written to the log.

The oparam used when no node was selected.

The oparam used when a node was selected. The result is bound to the matched output parameter.

Field Summary
static java.lang.String CLASS_VERSION
protected static java.lang.String EMPTY_PARAM
          The name of the empty open parameter
protected static java.lang.String FAILURE_PARAM
          The name of the failure open parameter
protected static java.lang.String MATCH_PARAM
          The name of the match input parameter
protected static java.lang.String MATCHED_PARAM
          The name of the matched output parameter
protected static java.lang.String NODE_PARAM
          The name of the node input parameter
protected static java.lang.String OUTPUT_PARAM
          The name of the output open parameter
protected static java.lang.String UNSET_PARAM
          The name of the unset open parameter
Fields inherited from class atg.servlet.DynamoServlet
mAllowCleanupRequest, mParameters
Fields inherited from class atg.nucleus.servlet.ServletService
Fields inherited from class atg.nucleus.GenericService
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging
Fields inherited from interface atg.nucleus.logging.ApplicationLogging
Constructor Summary
Method Summary getXmlToolsFactory()
          The XMLToolsFactory used by this component.
 void service(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pRes)
          The service() method for this droplet.
 void setXmlToolsFactory( pXMLToolsFactory)
          The XMLToolsFactory used by this component.
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.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, reResolveThis, 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

Field Detail


public static java.lang.String CLASS_VERSION


protected static java.lang.String NODE_PARAM
The name of the node input parameter


protected static java.lang.String MATCH_PARAM
The name of the match input parameter


protected static java.lang.String UNSET_PARAM
The name of the unset open parameter


protected static java.lang.String FAILURE_PARAM
The name of the failure open parameter


protected static java.lang.String EMPTY_PARAM
The name of the empty open parameter


protected static java.lang.String OUTPUT_PARAM
The name of the output open parameter


protected static java.lang.String MATCHED_PARAM
The name of the matched output parameter

Constructor Detail


public NodeMatch()
Method Detail


public void setXmlToolsFactory( pXMLToolsFactory)
The XMLToolsFactory used by this component.


public getXmlToolsFactory()
The XMLToolsFactory used by this component.


public void service(DynamoHttpServletRequest pReq,
                    DynamoHttpServletResponse pRes)
             throws javax.servlet.ServletException,
The service() method for this droplet.

service in class DynamoServlet
pReq - the request to be processed
pRes - the response object for this request
javax.servlet.ServletException - an application specific error occurred processing this request - an error occurred reading data from the request or writing data to the response.