com.marsching.flexiparse.configuration
Interface HandlerConfiguration

public interface HandlerConfiguration

Contains configuration information for a NodeHandler.

Author:

Sebastian Marsching

See Also:

NodeHandler

Method Summary

Collection<String>	getFollowingHandlers() Returns a list of handlers that, if present, should be called after the handler associated with this configuration.
String	getIdentifier() Returns a globally unique identifier for the handler.
Collection<String>	getPrecedingHandlers() Returns a list of handlers that, if present, should be called before the handler associated with this configuration.
RunOrder	getRunOrder() Indicates whether to run the handler before or after processing the child nodes of the node matched by this handler.
Collection<XPathExpression>	getXPathExpressions() Returns a list of XPathExpressions that will be used to match nodes in the parsed document.

Method Detail

getIdentifier

String getIdentifier()

Returns a globally unique identifier for the handler. This identifier is being used to reference this handler (e.g. in the configuration of other handlers).

Returns:

Globally unique id identifying the handler associated with this configuration

getPrecedingHandlers

Collection<String> getPrecedingHandlers()

Returns a list of handlers that, if present, should be called before the handler associated with this configuration. This only affects the invocation order for a single node. If a referenced handler is not triggered on the same node the handler associated with this configuration is triggered on, referencing that handler here will have no effect.

Returns:

list containing identifiers of handlers that - if called on the same node - must be called before this handler

getFollowingHandlers

Collection<String> getFollowingHandlers()

Returns a list of handlers that, if present, should be called after the handler associated with this configuration. This only affects the invocation order for a single node. If a referenced handler is not triggered on the same node the handler associated with this configuration is triggered on, referencing that handler here will have no effect.

Returns:

list containing identifiers of handlers that - if called on the same node - must be called after this handler

getXPathExpressions

Collection<XPathExpression> getXPathExpressions()

Returns a list of XPathExpressions that will be used to match nodes in the parsed document. If a node in the parsed document matches at least one of the XPathExpressions, the associated handler will be called. The evaluation context used when evaluating the XPathExpressions is always the Document node.

Returns:

list of XPathExpressions used to find matching nodes

getRunOrder

RunOrder getRunOrder()

Indicates whether to run the handler before or after processing the child nodes of the node matched by this handler.

Returns:

run order for this handler