| java.lang.Object
 org.cyberneko.pull.util.EventQueue
org.cyberneko.pull.util.EventCollector
| EventCollector | | public class EventCollector extends EventQueue implements XMLComponent,XMLDocumentHandler(Code) | | This class converts XNI document handler callbacks into pull parser
event objects, storing them on an event queue. In order to work with
any kind of XNI generator, the data passed via the XNI callbacks is
buffered internally when converted to event objects. Therefore, this
class is for general use and is not intended for high
performance pull parsing. For better performance, a parser written
directly to the pull parser API should be used.
Note:
There is a performance hit to buffering the underlying XNI events.
While the difference is negligible for small documents, it becomes
more pronounced as the document size increases.
See Also: EventDispatcher
author:
Andy Clark
version:
$Id$ |
| Method Summary | |
| protected void | attrs(XMLAttributes src, XMLAttributes dest)
Copies the source attributes into the specified destination. | | protected Augmentations | augs(Augmentations augs)
Returns a copy of the specified args. | | public void | characters(XMLString text, Augmentations augs)
Character content. | | public void | comment(XMLString text, Augmentations augs)
A comment. | | public XMLEvent | dequeue()
Removes an event from the queue. | | public void | doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document. | | protected void | dropEvent(XMLEvent event)
Drops an event by putting it back on the event cache so that it
can be re-used when needed. | | public void | emptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element. | | public void | endCDATA(Augmentations augs)
The end of a CDATA section. | | public void | endDocument(Augmentations augs)
The end of the document. | | public void | endElement(QName element, Augmentations augs)
The end of an element. | | public void | endGeneralEntity(String name, Augmentations augs)
This method notifies the end of a general entity. | | public void | endPrefixMapping(String prefix, Augmentations augs)
The end of a namespace prefix mapping. | | public XMLDocumentSource | getDocumentSource()
Returns the document source. | | protected XMLEvent | getEvent(short type)
Returns an event object for the given type. | | public Boolean | getFeatureDefault(String featureId)
Returns feature default. | | public Object | getPropertyDefault(String propertyId)
Returns property default. | | public String[] | getRecognizedFeatures()
Returns recognized features. | | public String[] | getRecognizedProperties()
Returns recognized properties. | | protected void | handleEndElement(QName element, Augmentations augs, boolean empty)
Handles an end element by copying the necessary data. | | protected void | handleStartElement(QName element, XMLAttributes attributes, Augmentations augs, boolean empty)
Handles a start element by copying the necessary data. | | public void | ignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace. | | public void | processingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction. | | public void | reset(XMLComponentManager manager)
Reset. | | public void | setDocumentSource(XMLDocumentSource source)
Sets the document source. | | public void | setFeature(String featureId, boolean state)
Set feature. | | public void | setProperty(String propertyId, Object value)
Set property. | | public void | startCDATA(Augmentations augs)
The start of a CDATA section. | | public void | startDocument(XMLLocator locator, String encoding, NamespaceContext nscontext, Augmentations augs)
Start document. | | public void | startDocument(XMLLocator locator, String encoding, Augmentations augs)
The start of the document.
Parameters:
locator - The document locator, or null if the documentlocation cannot be reported during the parsingof this document. | | public void | startElement(QName element, XMLAttributes attributes, Augmentations augs)
The start of an element. | | public void | startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of a general entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the general entity.
Parameters:
identifier - The resource identifier.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. | | public void | startPrefixMapping(String prefix, String uri, Augmentations augs)
The start of a namespace prefix mapping. | | protected XMLString | string(XMLString text, boolean content)
Returns a copy of the specified string. | | public void | textDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity. | | public void | xmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document. |
| FEATURE_DEFAULTS | | final protected static Boolean[] FEATURE_DEFAULTS(Code) | | Feature defaults.
|
| RECOGNIZED_FEATURES | | final protected static String[] RECOGNIZED_FEATURES(Code) | | Recognized features.
|
| REUSE_BUFFERS | | final protected static String REUSE_BUFFERS(Code) | | Feature identifer: reuse buffers.
Note:
This capability is not yet implemented in the Xerces2 parser.
Therefore, this feature identifier is a placeholder for future
capability to improve performance of a pull parser impl built
on top of Xerces2.
|
| fDocumentSource | | protected XMLDocumentSource fDocumentSource(Code) | | XNI document source.
|
| fNamespaceContext | | protected NamespaceContext fNamespaceContext(Code) | | Namespace context.
|
| fReuseBuffers | | protected boolean fReuseBuffers(Code) | | Underlying buffers are re-used by the creator of the XNI events.
|
| attrs | | protected void attrs(XMLAttributes src, XMLAttributes dest)(Code) | | Copies the source attributes into the specified destination.
|
| augs | | protected Augmentations augs(Augmentations augs)(Code) | | Returns a copy of the specified args.
|
| characters | | public void characters(XMLString text, Augmentations augs) throws XNIException(Code) | | Character content.
Parameters:
text - The content.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| comment | | public void comment(XMLString text, Augmentations augs) throws XNIException(Code) | | A comment.
Parameters:
text - The text in the comment.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by application to signal an error. |
| dequeue | | public XMLEvent dequeue()(Code) | | Removes an event from the queue.
|
| doctypeDecl | | public void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) throws XNIException(Code) | | Notifies of the presence of the DOCTYPE line in the document.
Parameters:
rootElement - The name of the root element.
Parameters:
publicId - The public identifier if an external DTD or nullif the external DTD is specified using SYSTEM.
Parameters:
systemId - The system identifier if an external DTD, nullotherwise.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| dropEvent | | protected void dropEvent(XMLEvent event)(Code) | | Drops an event by putting it back on the event cache so that it
can be re-used when needed.
|
| emptyElement | | public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException(Code) | | An empty element.
Parameters:
element - The name of the element.
Parameters:
attributes - The element attributes.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endCDATA | | public void endCDATA(Augmentations augs) throws XNIException(Code) | | The end of a CDATA section.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endDocument | | public void endDocument(Augmentations augs) throws XNIException(Code) | | The end of the document.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endElement | | public void endElement(QName element, Augmentations augs) throws XNIException(Code) | | The end of an element.
Parameters:
element - The name of the element.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endGeneralEntity | | public void endGeneralEntity(String name, Augmentations augs) throws XNIException(Code) | | This method notifies the end of a general entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the entity.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endPrefixMapping | | public void endPrefixMapping(String prefix, Augmentations augs) throws XNIException(Code) | | The end of a namespace prefix mapping. This method will only be
called when namespace processing is enabled.
Parameters:
prefix - The namespace prefix.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| getDocumentSource | | public XMLDocumentSource getDocumentSource()(Code) | | Returns the document source.
|
| getEvent | | protected XMLEvent getEvent(short type)(Code) | | Returns an event object for the given type. If an un-used event object
of this type is on the event cache, it is returned. Otherwise, a new
event object is created.
|
| getFeatureDefault | | public Boolean getFeatureDefault(String featureId)(Code) | | Returns feature default.
|
| getPropertyDefault | | public Object getPropertyDefault(String propertyId)(Code) | | Returns property default.
|
| getRecognizedFeatures | | public String[] getRecognizedFeatures()(Code) | | Returns recognized features.
|
| getRecognizedProperties | | public String[] getRecognizedProperties()(Code) | | Returns recognized properties.
|
| handleEndElement | | protected void handleEndElement(QName element, Augmentations augs, boolean empty)(Code) | | Handles an end element by copying the necessary data.
|
| handleStartElement | | protected void handleStartElement(QName element, XMLAttributes attributes, Augmentations augs, boolean empty)(Code) | | Handles a start element by copying the necessary data.
|
| ignorableWhitespace | | public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException(Code) | | Ignorable whitespace. For this method to be called, the document
source must have some way of determining that the text containing
only whitespace characters should be considered ignorable. For
example, the validator can determine if a length of whitespace
characters in the document are ignorable based on the element
content model.
Parameters:
text - The ignorable whitespace.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| processingInstruction | | public void processingInstruction(String target, XMLString data, Augmentations augs) throws XNIException(Code) | | A processing instruction. Processing instructions consist of a
target name and, optionally, text data. The data is only meaningful
to the application.
Typically, a processing instruction's data will contain a series
of pseudo-attributes. These pseudo-attributes follow the form of
element attributes but are not parsed or presented
to the application as anything other than text. The application is
responsible for parsing the data.
Parameters:
target - The target.
Parameters:
data - The data or null if none specified.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| reset | | public void reset(XMLComponentManager manager) throws XMLConfigurationException(Code) | | Reset.
|
| setDocumentSource | | public void setDocumentSource(XMLDocumentSource source)(Code) | | Sets the document source.
|
| setFeature | | public void setFeature(String featureId, boolean state) throws XMLConfigurationException(Code) | | Set feature.
|
| setProperty | | public void setProperty(String propertyId, Object value) throws XMLConfigurationException(Code) | | Set property.
|
| startCDATA | | public void startCDATA(Augmentations augs) throws XNIException(Code) | | The start of a CDATA section.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startDocument | | public void startDocument(XMLLocator locator, String encoding, NamespaceContext nscontext, Augmentations augs) throws XNIException(Code) | | Start document.
|
| startDocument | | public void startDocument(XMLLocator locator, String encoding, Augmentations augs) throws XNIException(Code) | | The start of the document.
Parameters:
locator - The document locator, or null if the documentlocation cannot be reported during the parsingof this document. However, it is stronglyrecommended that a locator be supplied that canat least report the system identifier of thedocument.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. This value will be null in those situationswhere the entity encoding is not auto-detected (e.g.internal entities or a document entity that isparsed from a java.io.Reader).
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startElement | | public void startElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException(Code) | | The start of an element.
Parameters:
element - The name of the element.
Parameters:
attributes - The element attributes.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startGeneralEntity | | public void startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException(Code) | | This method notifies the start of a general entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the general entity.
Parameters:
identifier - The resource identifier.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. This value will be null in those situationswhere the entity encoding is not auto-detected (e.g.internal entities or a document entity that isparsed from a java.io.Reader).
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startPrefixMapping | | public void startPrefixMapping(String prefix, String uri, Augmentations augs) throws XNIException(Code) | | The start of a namespace prefix mapping. This method will only be
called when namespace processing is enabled.
Parameters:
prefix - The namespace prefix.
Parameters:
uri - The URI bound to the prefix.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| string | | protected XMLString string(XMLString text, boolean content)(Code) | | Returns a copy of the specified string.
|
| textDecl | | public void textDecl(String version, String encoding, Augmentations augs) throws XNIException(Code) | | Notifies of the presence of a TextDecl line in an entity. If present,
this method will be called immediately following the startEntity call.
Note: This method will never be called for the
document entity; it is only called for external general entities
referenced in document content.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
version - The XML version, or null if not specified.
Parameters:
encoding - The IANA encoding name of the entity.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| xmlDecl | | public void xmlDecl(String version, String encoding, String standalone, Augmentations augs) throws XNIException(Code) | | Notifies of the presence of an XMLDecl line in the document. If
present, this method will be called immediately following the
startDocument call.
Parameters:
version - The XML version.
Parameters:
encoding - The IANA encoding name of the document, or null ifnot specified.
Parameters:
standalone - The standalone value, or null if not specified.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
|
|