nsISAXXMLReader
| IID: | 5556997e-d816-4218-8b54-803d4261206e |
| Inherits From: | nsIStreamListener |
Interface for reading an XML document using callbacks.
NsISAXXMLReader is the interface that an XML parser's SAX2 driver must implement. This interface allows an application to set and query features and properties in the parser, to register event handlers for document processing, and to initiate a document parse.
This interface is implemented by the following components:
Properties
nsIURI baseURI
The base URI.
nsISAXContentHandler contentHandler
If the application does not register a content handler, all content events reported by the SAX parser will be silently ignored.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
nsISAXDTDHandler dtdHandler
If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
nsISAXErrorHandler errorHandler
If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
nsISAXLexicalHandler lexicalHandler
If the application does not register a lexical handler, all lexical events (e.g. startDTD) reported by the SAX parser will be silently ignored.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
Methods
PRBool getFeature ( AString name )
PRBool getProperty ( AString name )
void parseAsync ( nsIRequestObserver observer )
void parseFromStream ( nsIInputStream stream , char* charset , char* contentType )
void parseFromString ( AString str , char* contentType )
void setFeature ( AString name , PRBool value )
void setProperty ( AString name , nsISupports value )
PRBool getFeature ( AString name )
Look up the value of a feature flag. NOT CURRENTLY IMPLEMENTED.
The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but temporarily be unable to return its value. Some feature values may be available only in specific contexts, such as before, during, or after a parse.
All XMLReaders are required to recognize the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes feature names.
- Arguments:
- name: String flag for a parser feature.
PRBool getProperty ( AString name )
Look up the value of a property. NOT CURRENTLY IMPLEMENTED.
The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but temporarily be unable to return its value. Some property values may be available only in specific contexts, such as before, during, or after a parse.
XMLReaders are not required to recognize any specific property names, though an initial core set is documented for SAX2.
Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.
- Arguments:
- name: The property name, which is a fully-qualified URI.
- Returns:
- The current value of the property.
void parseAsync ( nsIRequestObserver observer )
Begin an asynchronous parse. This method initializes the parser, and must be called before any nsIStreamListener methods. It is then the caller's duty to call nsIStreamListener methods to drive the parser. Once this method is called, the caller must not call one of the other parse methods.
- Arguments:
- observer: The nsIRequestObserver to notify upon start or stop. Can be NULL.
void parseFromStream ( nsIInputStream stream , char* charset , char* contentType )
- Arguments:
- stream: The byte stream whose contents are parsed
- charset: The character set that was used to encode the byte stream. NULL if not specified.
- contentType: The content type of the string - either text/xml, application/xml, or application/xhtml+xml. Must not be NULL.
void parseFromString ( AString str , char* contentType )
- Arguments:
- str: The UTF16 string to be parsed
- contentType: The content type of the string (see parseFromStream)
void setFeature ( AString name , PRBool value )
Set the value of a feature flag. NOT CURRENTLY IMPLEMENTED.
The feature name is any fully-qualified URI. It is possible for an XMLReader to expose a feature value but to be unable to change the current value. Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.
All XMLReaders are required to support setting http://xml.org/sax/features/namespaces to true and http://xml.org/sax/features/namespace-prefixes to false.
- Arguments:
- name: String flag for a parser feature.
- value: Turn the feature on/off.
void setProperty ( AString name , nsISupports value )
Set the value of a property. NOT CURRENTLY IMPLEMENTED.
The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to change the current value. Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.
XMLReaders are not required to recognize setting any specific property names, though a core set is defined by SAX2.
This method is also the standard mechanism for setting extended handlers.
- Arguments:
- name: String flag for a parser feature
- value: Turn the feature on/off.
References
This interface is the type of the following properties:
Reference documentation is generated from Mozilla's source.