Interface ILexicalHandler

SAX2 extension handler for lexical events.

Namespace: Sax.Ext

Assembly: Lucene.Net.Benchmark.dll

Syntax

public interface ILexicalHandler

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 is an optional extension handler for SAX2 to provide lexical information about an XML document, such as comments and CDATA section boundaries. XML readers are not required to recognize this handler, and it is not part of core-only SAX2 distributions.

The events in the lexical handler apply to the entire document, not just to the document element, and all lexical handler events must appear between the content handler's StartDocument and EndDocument events.

To set the LexicalHandler for an XML reader, use the SetProperty(String, Object) method with the property name http://xml.org/sax/properties/lexical-handler and an object implementing this interface (or null) as the value. If the reader does not report lexical events, it will throw a SAXNotRecognizedException when you attempt to register the handler.

Methods

Comment(Char[], Int32, Int32)

Report an XML comment anywhere in the document.

This callback will be used for comments inside or outside the document element, including comments in the external DTD subset(if read). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events(if used).

Declaration

void Comment(char[] ch, int start, int length)

Parameters

Type	Name	Description
System.Char[]	ch	An array holding the characters in the comment.
System.Int32	start	The starting position in the array.
System.Int32	length	The number of characters to use from the array.

Exceptions

Type	Condition
SAXException	The application may raise an exception.

EndCDATA()

Report the end of a CDATA section.

Declaration

void EndCDATA()

Exceptions

Type	Condition
SAXException	The application may raise an exception.

See Also

StartCDATA()

EndDTD()

Report the end of DTD declarations.

This method is intended to report the end of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.

Declaration

void EndDTD()

Exceptions

Type	Condition
SAXException	The application may raise an exception.

See Also

StartDTD(String, String, String)

EndEntity(String)

Report the end of an entity.

Declaration

void EndEntity(string name)

Parameters

Type	Name	Description
System.String	name	The name of the entity that is ending.

Exceptions

Type	Condition
SAXException	The application may raise an exception.

See Also

StartEntity(String)

StartCDATA()

Report the start of a CDATA section.

Declaration

void StartCDATA()

Remarks

The contents of the CDATA section will be reported through the regular Characters(Char[], Int32, Int32) event; this event is intended only to report the boundary.

Exceptions

Type	Condition
SAXException	The application may raise an exception.

See Also

EndEntity(String)

StartDTD(String, String, String)

Report the start of DTD declarations, if any.

Declaration

void StartDTD(string name, string publicId, string systemId)

Parameters

Type	Name	Description
System.String	name	The document type name.
System.String	publicId	The declared public identifier for the external DTD subset, or null if none was declared.
System.String	systemId	The declared system identifier for the external DTD subset, or null if none was declared. (Note that this is not resolved against the document base URI.)

Remarks

This method is intended to report the beginning of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.

All declarations reported through IDTDHandler or IDeclHandler events must appear between the startDTD and EndDTD() events. Declarations are assumed to belong to the internal DTD subset unless they appear between StartEntity(String) and EndEntity(String) events. Comments and processing instructions from the DTD should also be reported between the StartDTD(String, String, String) and EndDTD() events, in their original order of(logical) occurrence; they are not required to appear in their correct locations relative to IDTDHandler or IDeclHandler events, however.

Note that the start / endDTD events will appear within the start / endDocument events from IContentHandler and before the first StartElement(String, String, String, IAttributes) event.

Exceptions

Type	Condition
SAXException	The application may raise an exception.

StartEntity(String)

Report the beginning of some internal and external XML entities.

Declaration

void StartEntity(string name)

Parameters

Type	Name	Description
System.String	name	The name of the entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be "[dtd]".

Remarks

The reporting of parameter entities (including the external DTD subset) is optional, and SAX2 drivers that report LexicalHandler events may not implement it; you can use the http://xml.org/sax/features/lexical-handler/parameter-entities feature to query or control the reporting of parameter entities.

General entities are reported with their regular names, parameter entities have '%' prepended to their names, and the external DTD subset has the pseudo-entity name "[dtd]".

When a SAX2 driver is providing these events, all other events must be properly nested within start/end entity events. There is no additional requirement that events from IDeclHandler or IDTDHandler be properly ordered.

Note that skipped entities will be reported through the SkippedEntity(String) event, which is part of the ContentHandler interface.

Because of the streaming event model that SAX uses, some entity boundaries cannot be reported under any circumstances:

• general entities within attribute values
• parameter entities within declarations

These will be silently expanded, with no indication of where the original entity boundaries were.

Note also that the boundaries of character references (which are not really entities anyway) are not reported.

All start/endEntity events must be properly nested.

Exceptions

Type	Condition
SAXException	The application may raise an exception.

See Also

EndEntity(String)

InternalEntityDecl(System.String, System.String)

ExternalEntityDecl(System.String, System.String, System.String)