|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Watch
A Watch represents a class that is interested in looking at nodes passing down a push pipeline. Originally this was for the purpose of evaluating uniqueness and key constraints while validating an instance document against a schema; now it us used for many expressions that need to be evaluated in streaming mode.
The nodes that the Watch is interested in are identified by a Selection object.
Method Summary | |
---|---|
void |
close()
The close() method is called immediately before the Watch is destroyed, that is, when the element whose declaration scopes the constraint implemented by this Watch goes out of scope. |
void |
endSelectedParentNode(int locationId)
Signal that the endElement event has occurred for the element whose startElement event caused the Watch to be activated. |
FleetingNode |
getAnchorNode()
Get the anchor node for the watch. |
NamespaceResolver |
getNamespaceResolver()
Get the namespace resolver in use by the Watch |
PipelineConfiguration |
getPipelineConfiguration()
Get the pipeline configuration in use |
Pattern |
getSelection()
Get the selection (that is, the restricted XPath expression) that defines the nodes that this Watch is looking for |
void |
notifySelectedLeafNode(FleetingNode node,
int locationId)
Signal that a node (other than a document or element node) that matches the selection has been found. |
void |
open()
Open the watch. |
void |
setAnchorNode(FleetingNode anchor)
Set the anchor node for the watch. |
void |
setNamespaceResolver(NamespaceResolver resolver)
Set a NamespaceResolver for use by the Watch |
void |
setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipeline configuration in use |
void |
setSelection(Pattern selection)
Set the selection (that is, the streamable XPath expression) that defines the nodes that this Watch is looking for |
Receiver |
startSelectedParentNode(FleetingNode node,
int locationId)
Signal that an element or document node has been found that matches the selection that this Watch is looking for. |
Method Detail |
---|
void setSelection(Pattern selection)
selection
- the streamable XPath expressionPattern getSelection()
void setPipelineConfiguration(PipelineConfiguration pipe)
pipe
- the pipeline Configuration in usePipelineConfiguration getPipelineConfiguration()
void setNamespaceResolver(NamespaceResolver resolver)
resolver
- the namespace resolver to be usedNamespaceResolver getNamespaceResolver()
void setAnchorNode(FleetingNode anchor)
anchor
- The anchor node within which the watch is scopedFleetingNode getAnchorNode()
void open() throws XPathException
XPathException
Receiver startSelectedParentNode(FleetingNode node, int locationId) throws XPathException
node
- the element or document node whose start event has been matchedlocationId
- the location associated with the element or document node (may be
the location of the instruction that created it)
ValidationException
- May be raised if the constraint implemented by this
Watch is violated
XPathException
void endSelectedParentNode(int locationId) throws XPathException
locationId
- the location of the element
XPathException
- May be raised if a constraint implemented by this
Watch is violatedvoid notifySelectedLeafNode(FleetingNode node, int locationId) throws XPathException
node
- the node that was matched.locationId
-
XPathException
void close() throws XPathException
XPathException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |