atg.droplet.xml
Class NodeMatch

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.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 http://www.w3.org/TR/xpath (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

matched

The next DOM node which matches the pattern. This parameter is available for formatting in the output oparam.

Open Paramaters

unset

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

failure

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.

empty

The oparam used when no node was selected.

output

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

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

NodeMatch()

Method Summary

atg.xml.tools.XMLToolsFactory	getXmlToolsFactory() The XMLToolsFactory used by this component.
void	service(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pRes) The service() method for this droplet.
void	setXmlToolsFactory(atg.xml.tools.XMLToolsFactory 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, 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

CLASS_VERSION

public static java.lang.String CLASS_VERSION

NODE_PARAM

protected static java.lang.String NODE_PARAM

The name of the node input parameter

MATCH_PARAM

protected static java.lang.String MATCH_PARAM

The name of the match input parameter

UNSET_PARAM

protected static java.lang.String UNSET_PARAM

The name of the unset open parameter

FAILURE_PARAM

protected static java.lang.String FAILURE_PARAM

The name of the failure open parameter

EMPTY_PARAM

protected static java.lang.String EMPTY_PARAM

The name of the empty open parameter

OUTPUT_PARAM

protected static java.lang.String OUTPUT_PARAM

The name of the output open parameter

MATCHED_PARAM

protected static java.lang.String MATCHED_PARAM

The name of the matched output parameter

Constructor Detail

NodeMatch

public NodeMatch()

Method Detail

setXmlToolsFactory

public void setXmlToolsFactory(atg.xml.tools.XMLToolsFactory pXMLToolsFactory)

The XMLToolsFactory used by this component.

getXmlToolsFactory

public atg.xml.tools.XMLToolsFactory getXmlToolsFactory()

The XMLToolsFactory used by this component.

service

public void service(DynamoHttpServletRequest pReq,
                    DynamoHttpServletResponse pRes)
             throws javax.servlet.ServletException,
                    java.io.IOException

The service() method for this droplet.

Overrides:

service in class DynamoServlet

Parameters:

pReq - the request to be processed

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