Language
Asturianu (ast)
Català (ca)
Čeština (cs)
Dansk (da)
Deutsch (de)
English [US] (en-US)
Español (es)
Esperanto (eo)
Eesti keel (et)
Euskara (eu)
Français (fr)
Gàidhlig (gd)
Galego (gl)
Italiano (it)
Lietuvių (lt)
Magyar (hu)
Nederlands (nl)
Norsk (no)
Polski (pl)
Português [do Brasil] (pt-BR)
Português [Europeu] (pt)
Română (ro)
Slovenčina (sk)
Slovenščina (sl)
Suomi (fi)
Svenska (sv)
Yкраїнська (uk)
Tiếng Việt (vi)
Türkçe (tr)
ኦሮሚኛ (om)
Հայերեն (hy)
Ελληνικά (el)
български език (bg)
Русский (ru)
Cрпски [ћирилицом] (sr)
עברית (he)
हिन्दी (hi)
ភាសាខ្មែរ (km)
தமிழ் (ta)
ภาษาไทย (th)
简体中文 (zh-CN)
正體中文 (zh-TW)
日本語 (ja)
한국어 (ko)
The Free and Open Productivity Suite
:: com :: sun :: star :: xml :: crypto :: sax ::
unpublished
interface XSAXEventKeeper
Usage Restrictions
not published
Description
* Interface of SAX Event Keeper.
*
* This interface is used to manipulate element marks in a SAX event stream.
*
* There are two kinds of element mark, one is element collector, which is
* used to collect a particular element from the SAX event stream; the other
* is blocker, which is used to block the SAX event stream.
Methods' Details
addElementCollector
long
addElementCollector ();
Description
* Adds a new element collector on the next element in the SAX event
* stream.
*
*
Returns
the keeper id of the new element collector
removeElementCollector
void
removeElementCollector (
[in] long
id );
Description
* Removes an element collector.
*
*
Parameter id
the keeper id of the element collector to be removed
addBlocker
Description
* Adds a new blocker on the next element in the SAX event stream.
*
* No SAX event starting from the next element will be forwarded until
* this blocker is removed.
*
*
Returns
the keeper id of the new blocker
removeBlocker
void
removeBlocker (
[in] long
id );
Description
* Removes a blocker
*
*
Parameter id
the keeper id of the blocker to be removed
isBlocking
Description
* Checks whether the SAX event stream is blocking.
*
*
Returns
true
if blocking, false
otherwise
getElement
Description
* Gets the element of an element mark.
*
*
Parameter id
the keeper id of the element mark, it can be a element
* collector or a blocker
setElement
Description
* Sets the element of an element mark.
*
* When an element is replaced outside of this interface, then uses this method
* can restore the link between an element mark and its working element.
*
*
Parameter id
the keeper id of the element mark to be set
*
Parameter aElement
the new element for this element mark.
setNextHandler
Description
* Sets the next document handler in the SAX chain.
*
* This handler will receive SAX events forwarded by the SAXEventKeeper.
*
*
Parameter nextHandler
the next handler in the SAX chain
*
Returns
the old next handler
printBufferNodeTree
string
printBufferNodeTree ();
Description
* Prints information about all bufferred elements.
*
*
Returns
a tree-style string including all buffer informtion
getCurrentBlockingNode
Description
* Gets the element which current blocking happens.
*
* This element is the working element of the first blocker in tree order.
*
*
Returns
the current blocking element
Top of Page Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.