Warning: This is a facade provided for use by user code, not for implementation by user code. User implementations of this interface are highly likely to be incompatible with future releases of the product at both binary and source levels.
Processes can be added to the pipeline after it has been running which means that they may have missed some of the events that carry contextual information that may be needed in order to interpret other events, e.g. setDocumentLocator, startPrefixMapping, etc. This class provides access to that information.
Each pipeline has its own instance of this object which is created when the pipeline is created and discarded when the pipeline is discarded. Nested pipelines use the same instance of this class as the containing pipeline.
In addition to the normal SAX contextual information this class also provides facilities for pipeline objects such as XMLProcesses to communicate with each other.
The XML Base standard defines a mechanism to allow page authors to specify the base URI used when resolving relative URIs. This interface provides support for managing them using the following methods.
The {@link EnvironmentInteractionTracker} is used to keep track of theenvironment interactions that affect the pipeline.
The object stack can be used by objects (processes, dynamic element rules, etc) to communicate and cooperate with one another.
The {@link ResourceOwner#release} method will be invoked on stack objectsthat implement the interface when the object is popped off the stack.
While pushing an {@link XMLProcess} on the object stack is allowed it isnot recommended as it can cause problems. An {@link XMLProcess} is a{@link ResourceOwner} and so popping it off the stack could
These are used to allow pipeline objects (processes, rules) to communicate and cooperate with both the user of the pipeline and other pipeline objects. See {@link PropertyContainer} for more details.
The {@link ResourceOwner#release} method will be invoked on propertyvalues that implement the interface if the property is changed or removed.
Conditional content and error recovery require the ability to skip over events within the pipeline until a certain point within the event stream is reached at which time the pipeline carries on processing as normal. The mechanism to support this is called flow control.
As part of error recovery this object provides support for recovering back to a well known state. This can involve discarding property values and objects on the object stack. The {@link ResourceOwner#release} method willbe invoked for those property values and stack objects that implement that interface and are discarded during error recovery.
@volantis-api-include-in PublicAPI @volantis-api-include-in ProfessionalServicesAPI @volantis-api-include-in InternalAPI @mock.generate | |