Class DefaultHandler

Default base class for SAX2 event handlers.

Inheritance

System.Object

DefaultHandler

DefaultHandler2

Parser

Implements

IEntityResolver

IDTDHandler

IContentHandler

IErrorHandler

Namespace: Sax.Helpers

Assembly: Lucene.Net.Benchmark.dll

Syntax

public class DefaultHandler : object, 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[], Int32, Int32)

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
System.Char[]	ch	The characters.
System.Int32	start	The start position in the character array.
System.Int32	length	The number of characters to use from the character array.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

Characters(System.Char[], System.Int32, System.Int32)

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()

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

EndDocument()

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
System.String	uri	The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
System.String	localName	The local name (without prefix), or the empty string if Namespace processing is not being performed.
System.String	qName	The qualified name (with prefix), or the empty string if qualified names are not available.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

EndElement(System.String, System.String, System.String)

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
System.String	prefix	The Namespace prefix being declared.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

EndPrefixMapping(System.String)

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.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

Warning(SAXParseException)

SAXParseException

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.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

FatalError(SAXParseException)

SAXParseException

IgnorableWhitespace(Char[], Int32, Int32)

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
System.Char[]	ch	The whitespace characters.
System.Int32	start	The start position in the character array.
System.Int32	length	The number of characters to use from the character array.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

IgnorableWhitespace(System.Char[], System.Int32, System.Int32)

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
System.String	name	The notation name.
System.String	publicId	The notation public identifier, or null if not available.
System.String	systemId	The notation system identifier.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

NotationDecl(System.String, System.String, System.String)

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
System.String	target	The processing instruction target.
System.String	data	The processing instruction data, or null if none is supplied.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

ProcessingInstruction(System.String, System.String)

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
System.String	publicId	The public identifer, or null if none is available.
System.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
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

ResolveEntity(System.String, System.String)

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.

See Also

SetDocumentLocator(ILocator)

ILocator

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
System.String	name	The name of the skipped entity.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

ProcessingInstruction(System.String, System.String)

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()

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

StartDocument()

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
System.String	uri	The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
System.String	localName	The local name (without prefix), or the empty string if Namespace processing is not being performed.
System.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.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

StartElement(System.String, System.String, System.String, IAttributes)

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
System.String	prefix	The Namespace prefix being declared.
System.String	uri	The Namespace URI mapped to the prefix.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

StartPrefixMapping(System.String, System.String)

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
System.String	name	The entity name.
System.String	publicId	The entity public identifier, or null if not available.
System.String	systemId	The entity system identifier.
System.String	notationName	The name of the associated notation.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

UnparsedEntityDecl(System.String, System.String, System.String, System.String)

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.

Exceptions

Type	Condition
SAXException	Any SAX exception, possibly wrapping another exception.

See Also

Warning(SAXParseException)

SAXParseException

Implements

IEntityResolver

IDTDHandler

IContentHandler

IErrorHandler

See Also

IEntityResolver

IDTDHandler

IContentHandler

IErrorHandler