Class XMLFilter
Base class for deriving an XML filter.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.
This class is designed to sit between an IXMLReader and the client application's event handlers. By default, it does nothing but pass requests up to the reader and events on to the handlers unmodified, but subclasses can override specific methods to modify the event stream or the configuration requests as they pass through.
Inheritance
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class XMLFilter : object, IXMLFilter, IXMLReader, IEntityResolver, IDTDHandler, IContentHandler, IErrorHandlerConstructors
| Name | Description |
|---|---|
| XMLFilter() | Construct an empty XML filter, with no parent. This filter will have no parent: you must assign a parent before you start a parse or do any configuration with setFeature or setProperty, unless you use this as a pure event consumer rather than as an IXMLReader. |
| XMLFilter(IXMLReader) | Construct an XML filter with the specified parent. |
Properties
| Name | Description |
|---|---|
| ContentHandler | Gets or Sets the content event handler. |
| DTDHandler | Gets or Sets the DTD event handler. |
| EntityResolver | Gets or Sets the entity resolver. |
| ErrorHandler | Gets or Sets the error event handler. |
| Parent | Gets or sets the parent reader. |
Methods
| Name | Description |
|---|---|
| Characters(Char[], Int32, Int32) | Filter a character data event. |
| EndDocument() | Filter an end document event. |
| EndElement(String, String, String) | Filter an end element event. |
| EndPrefixMapping(String) | Filter an end Namespace prefix mapping event. |
| Error(SAXParseException) | Filter an error event. |
| FatalError(SAXParseException) | Filter a fatal error event. |
| GetFeature(String) | Look up the value of a feature. This will always fail if the parent is null. |
| GetProperty(String) | Look up the value of a property. |
| IgnorableWhitespace(Char[], Int32, Int32) | Filter an ignorable whitespace event. |
| NotationDecl(String, String, String) | Filter a notation declaration event. |
| Parse(InputSource) | Parse an XML document. The application can use this method to instruct the XML reader to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI). Applications may not invoke this method while a parse is in progress (they should create a new XMLReader instead for each nested XML document). Once a parse is complete, an application may reuse the same XMLReader object, possibly with a different input source. Configuration of the XMLReader object (such as handler bindings and values established for feature flags and properties) is unchanged by completion of a parse, unless the definition of that aspect of the configuration explicitly specifies other behavior. (For example, feature flags or properties exposing characteristics of the document being parsed.) During the parse, the XMLReader will provide information about the XML document through the registered event handlers. This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception. |
| Parse(String) | Parse a document. |
| ProcessingInstruction(String, String) | Filter a processing instruction event. |
| ResolveEntity(String, String) | Filter an external entity resolution. |
| SetDocumentLocator(ILocator) | Filter a new document locator event. |
| SetFeature(String, Boolean) | Set the value of a feature. This will always fail if the parent is null. |
| SetProperty(String, Object) | Set the value of a property. This will always fail if the parent is null. |
| SkippedEntity(String) | Filter a skipped entity event. |
| StartDocument() | Filter a start document event. |
| StartElement(String, String, String, IAttributes) | Filter a start element event. |
| StartPrefixMapping(String, String) | Filter a start Namespace prefix mapping event. |
| UnparsedEntityDecl(String, String, String, String) | Filter an unparsed entity declaration event. |
| Warning(SAXParseException) | Filter a warning event. |
