Package org.smooks.engine.delivery.sax.ng.pointer

Class EventPointer

java.lang.Object

org.smooks.engine.delivery.sax.ng.pointer.EventPointer

public class EventPointer
extends Object

Represents a pointer to an event and provides convenience methods to retrieve attribute values from the event.

A pointer captures the state of an execution in a point of time. Formally, a pointer is a pair of attributes:

reference: key to an execution context value holding the event visit: name of the visit method that the event is targeting

Pointer nodes are meant for nested Smooks executions (i.e., a Smooks execution within another Smooks execution). It allows the outer execution to carry over its visit state to the nested execution with the help of EventPointerStaticProxyInterceptor. Without a pointer, the nested Smooks instance cannot join the inner execution to the outer one.

Constructor Summary

Constructors

Constructor	Description
EventPointer(Document factory, VisitSequence visitSequence)
EventPointer(Node node)

Method Summary

Modifier and Type	Method	Description
Node	dereference(org.smooks.api.ExecutionContext executionContext)	Provides a convenience method to retrieve the source node.
Node	getPointerNode()
org.smooks.api.TypedKey<Node>	getReference()	Gets the execution context key which maps to the node representing the event.
VisitSequence	getVisit()	Gets the name of the visit this EventPointer is targeting.
static boolean	isPointer(Node node)	Checks whether a node is a pointer element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventPointer

public EventPointer(Node node)

EventPointer

public EventPointer(Document factory,
                    VisitSequence visitSequence)

Method Detail

getPointerNode

public Node getPointerNode()

isPointer

public static boolean isPointer(Node node)

Checks whether a node is a pointer element.

Parameters:

node - the node to be tested

Returns:

true if the node is a pointer otherwise false

getReference

public org.smooks.api.TypedKey<Node> getReference()

Gets the execution context key which maps to the node representing the event.

Returns:

the key of the execution context entry that holds the event node

getVisit

public VisitSequence getVisit()

Gets the name of the visit this EventPointer is targeting.

Returns:

the name of the visit

dereference

public Node dereference(org.smooks.api.ExecutionContext executionContext)

Provides a convenience method to retrieve the source node.

Parameters:

executionContext - the execution context holding the source

Returns:

the source node or null if not found