Class DefaultHandler

Default base class for SAX2 event handlers.

Inheritance
object
DefaultHandler
DefaultHandler2
Parser
Inherited Members
Namespace: Sax.Helpers
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class DefaultHandler : IEntityResolver, IDTDHandler, IContentHandler, IErrorHandler
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.

Methods

Characters(char[], int, int)

Receive notification of character data inside an element.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).
Declaration
public virtual void Characters(char[] ch, int start, int length)
Parameters
Type Name Description
char[] ch

The characters.
int start

The start position in the character array.
int length

The number of characters to use from the character array.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

EndDocument()

Receive notification of the end of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of a document (such as finalising a tree or closing an output file).
Declaration
public virtual void EndDocument()
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

EndElement(string, string, string)

Receive notification of the end of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).
Declaration
public virtual void EndElement(string uri, string localName, string qName)
Parameters
Type Name Description
string uri

The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
string localName

The local name (without prefix), or the empty string if Namespace processing is not being performed.
string qName

The qualified name (with prefix), or the empty string if qualified names are not available.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

EndPrefixMapping(string)

Receive notification of the end of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each prefix mapping.
Declaration
public virtual void EndPrefixMapping(string prefix)
Parameters
Type Name Description
string prefix

The Namespace prefix being declared.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

Error(SAXParseException)

Receive notification of a recoverable parser error.

The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each error, such as inserting the message in a log file or printing it to the console.
Declaration
public virtual void Error(SAXParseException e)
Parameters
Type Name Description
SAXParseException e

The warning information encoded as an exception.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

FatalError(SAXParseException)

Report a fatal XML parsing error.

The default implementation throws a SAXParseException. Application writers may override this method in a subclass if they need to take specific actions for each fatal error (such as collecting all of the errors into a single report): in any case, the application must stop all regular processing when this method is invoked, since the document is no longer reliable, and the parser may no longer report parsing events.
Declaration
public virtual void FatalError(SAXParseException e)
Parameters
Type Name Description
SAXParseException e

The error information encoded as an exception.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

IgnorableWhitespace(char[], int, int)

Receive notification of ignorable whitespace in element content.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of ignorable whitespace (such as adding data to a node or buffer, or printing it to a file).
Declaration
public virtual void IgnorableWhitespace(char[] ch, int start, int length)
Parameters
Type Name Description
char[] ch

The whitespace characters.
int start

The start position in the character array.
int length

The number of characters to use from the character array.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

NotationDecl(string, string, string)

Receive notification of a notation declaration.

By default, do nothing. Application writers may override this method in a subclass if they wish to keep track of the notations declared in a document.
Declaration
public virtual void NotationDecl(string name, string publicId, string systemId)
Parameters
Type Name Description
string name

The notation name.
string publicId

The notation public identifier, or null if not available.
string systemId

The notation system identifier.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

ProcessingInstruction(string, string)

Receive notification of a processing instruction.

By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.
Declaration
public virtual void ProcessingInstruction(string target, string data)
Parameters
Type Name Description
string target

The processing instruction target.
string data

The processing instruction data, or null if none is supplied.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

ResolveEntity(string, string)

Resolve an external entity.

Always return null, so that the parser will use the system identifier provided in the XML document. This method implements the SAX default behaviour: application writers can override it in a subclass to do special translations such as catalog lookups or URI redirection.
Declaration
public virtual InputSource ResolveEntity(string publicId, string systemId)
Parameters
Type Name Description
string publicId

The public identifer, or null if none is available.
string systemId

The system identifier provided in the XML document.
Returns
Type Description
InputSource
Remarks

The new input source, or null to require the default behaviour.

Exceptions
Type Condition
IOException

If there is an error setting up the new input source.
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

SetDocumentLocator(ILocator)

Receive a Locator object for document events.

By default, do nothing. Application writers may override this method in a subclass if they wish to store the locator for use with other document events.
Declaration
public virtual void SetDocumentLocator(ILocator locator)
Parameters
Type Name Description
ILocator locator

A locator for all SAX document events.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
See Also

SkippedEntity(string)

Receive notification of a skipped entity.

By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.
Declaration
public virtual void SkippedEntity(string name)
Parameters
Type Name Description
string name

The name of the skipped entity.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

StartDocument()

Receive notification of the beginning of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as allocating the root node of a tree or creating an output file).
Declaration
public virtual void StartDocument()
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

StartElement(string, string, string, IAttributes)

Receive notification of the start of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).
Declaration
public virtual void StartElement(string uri, string localName, string qName, IAttributes attributes)
Parameters
Type Name Description
string uri

The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
string localName

The local name (without prefix), or the empty string if Namespace processing is not being performed.
string qName

The qualified name (with prefix), or the empty string if qualified names are not available.
IAttributes attributes

The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

StartPrefixMapping(string, string)

Receive notification of the start of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each Namespace prefix scope (such as storing the prefix mapping).
Declaration
public virtual void StartPrefixMapping(string prefix, string uri)
Parameters
Type Name Description
string prefix

The Namespace prefix being declared.
string uri

The Namespace URI mapped to the prefix.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

UnparsedEntityDecl(string, string, string, string)

Receive notification of an unparsed entity declaration.

By default, do nothing. Application writers may override this method in a subclass to keep track of the unparsed entities declared in a document.
Declaration
public virtual void UnparsedEntityDecl(string name, string publicId, string systemId, string notationName)
Parameters
Type Name Description
string name

The entity name.
string publicId

The entity public identifier, or null if not available.
string systemId

The entity system identifier.
string notationName

The name of the associated notation.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

Warning(SAXParseException)

Receive notification of a parser warning.

The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each warning, such as inserting the message in a log file or printing it to the console.
Declaration
public virtual void Warning(SAXParseException e)
Parameters
Type Name Description
SAXParseException e

The warning information encoded as an exception.
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. Seehttp://www.saxproject.org for further information.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:
  1. IEntityResolver
  2. IDTDHandler
  3. IContentHandler
  4. IErrorHandler

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1 Sax.HandlerBase class.
Exceptions
Type Condition
SAXException

Any SAX exception, possibly wrapping another exception.
See Also

Implements

See Also