Class PYXWriter

A IContentHandler that generates PYX format instead of XML. Primarily useful for debugging.

Inheritance
object
PYXWriter
Inherited Members
Namespace: TagSoup
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class PYXWriter : IScanHandler, IContentHandler, ILexicalHandler

Constructors

PYXWriter(TextWriter)

A IContentHandler that generates PYX format instead of XML. Primarily useful for debugging.

Declaration
public PYXWriter(TextWriter writer)
Parameters
Type Name Description
TextWriter writer

Methods

Adup(char[], int, int)

Reports an attribute name without a value.

Declaration
public virtual void Adup(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

Aname(char[], int, int)

Reports an attribute name; a value will follow.

Declaration
public virtual void Aname(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

Aval(char[], int, int)

Reports an attribute value.

Declaration
public virtual void Aval(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

CDSect(char[], int, int)

Reports the content of a CDATA section (not a CDATA element)

Declaration
public virtual void CDSect(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

Characters(char[], int, int)

Receive notification of character data.

Declaration
public virtual void Characters(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

the number of characters to read from the array
Remarks

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Individual characters may consist of more than one Java char value.There are two important cases where this happens, because characters can't be represented in just sixteen bits. In one case, characters are represented in a Surrogate Pair, using two special Unicode values. Such characters are in the so-called "Astral Planes", with a code point above U+FFFF.A second case involves composite characters, such as a base character combining with one or more accent characters.

Your code should not assume that algorithms using char-at-a-time idioms will be working in character units; in some cases they will split characters. This is relevant wherever XML permits arbitrary characters, such as attribute values, processing instruction data, and comments as well as in data reported from this method. It's also generally relevant whenever Java code manipulates internationalized text; the issue isn't unique to XML.

Note that some parsers will report whitespace in element content using the IgnorableWhitespace(char[], int, int) method rather than this one (validating parsers must do so).
Exceptions
Type Condition
SAXException

any SAX exception, possibly wrapping another exception
See Also

Cmnt(char[], int, int)

Reports a comment.

Declaration
public virtual void Cmnt(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

Comment(char[], int, int)

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
public virtual void Comment(char[] ch, int start, int length)
Parameters
Type Name Description
char[] ch

An array holding the characters in the comment.
int start

The starting position in the array.
int length

The number of characters to use from the array.
Exceptions
Type Condition
SAXException

The application may raise an exception.

Decl(char[], int, int)

Reports a <!....> declaration - typically a DOCTYPE

Declaration
public virtual void Decl(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

EOF(char[], int, int)

Reports EOF.

Declaration
public virtual void EOF(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

ETag(char[], int, int)

Reports an end-tag.

Declaration
public virtual void ETag(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

EndCDATA()

Report the end of a CDATA section.

Declaration
public virtual void EndCDATA()
Exceptions
Type Condition
SAXException

The application may raise an exception.
See Also

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
public virtual void EndDTD()
Exceptions
Type Condition
SAXException

The application may raise an exception.
See Also

EndDocument()

Receive notification of the end of a document.

Declaration
public virtual void EndDocument()
Remarks

There is an apparent contradiction between the documentation for this method and the documentation for FatalError(SAXParseException). Until this ambiguity is resolved in a future major release, clients should make no assumptions about whether EndDocument() will or will not be invoked when the parser has reported a FatalError(SAXParseException) or thrown an exception.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse.The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.
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.

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
string qname
Remarks

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding StartElement(string, string, string, IAttributes) event for every endElement event (even when the element is empty).

For information on the names, see StartElement(string, string, string, IAttributes).
Exceptions
Type Condition
SAXException

any SAX exception, possibly wrapping another exception

EndEntity(string)

Report the end of an entity.

Declaration
public virtual void EndEntity(string name)
Parameters
Type Name Description
string name

The name of the entity that is ending.
Exceptions
Type Condition
SAXException

The application may raise an exception.
See Also

EndPrefixMapping(string)

End the scope of a prefix-URI mapping.

Declaration
public virtual void EndPrefixMapping(string prefix)
Parameters
Type Name Description
string prefix

the prefix that was being mapped. This is the empty string when a default mapping scope ends.
Remarks

See StartPrefixMapping(string, string) for details. These events will always occur immediately after the corresponding EndElement(string, string, string) event, but the order of EndPrefixMapping(string) events is not otherwise guaranteed.

Exceptions
Type Condition
SAXException

the client may throw an exception during processing
See Also

Entity(char[], int, int)

Reports an entity reference or character reference.

Declaration
public virtual void Entity(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

GI(char[], int, int)

Reports the general identifier (element type name) of a start-tag.

Declaration
public virtual void GI(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

GetEntity()

Returns the value of the last entity or character reference reported.

Declaration
public virtual int GetEntity()
Returns
Type Description
int

The value of the last entity or character reference reported.

IgnorableWhitespace(char[], int, int)

Receive notification of ignorable whitespace in element content.

Declaration
public virtual void IgnorableWhitespace(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

the number of characters to read from the array
Remarks

Validating Parsers must use this method to report each chunk of whitespace in element content (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.

SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.
Exceptions
Type Condition
SAXException

any SAX exception, possibly wrapping another exception
See Also

PCDATA(char[], int, int)

Reports character content.

Declaration
public virtual void PCDATA(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

PI(char[], int, int)

Reports the data part of a processing instruction.

Declaration
public virtual void PI(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

PITarget(char[], int, int)

Reports the target part of a processing instruction.

Declaration
public virtual void PITarget(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

ProcessingInstruction(string, string)

Receive notification of a processing instruction.

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 was supplied. The data does not include any whitespace separating it from the target
Remarks

The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

A SAX parser must never report an XML declaration(XML 1.0, section 2.8) or a text declaration(XML 1.0, section 4.3.1) using this method.

Like Characters(char[], int, int), processing instruction data may have characters that need more than one char value.
Exceptions
Type Condition
SAXException

any SAX exception, possibly wrapping another exception

STagC(char[], int, int)

Reports the close of a start-tag.

Declaration
public virtual void STagC(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

STagE(char[], int, int)

Reports the close of an empty-tag.

Declaration
public virtual void STagE(char[] buffer, int startIndex, int length)
Parameters
Type Name Description
char[] buffer
int startIndex
int length

SetDocumentLocator(ILocator)

Receive an object for locating the origin of SAX document events.

Declaration
public virtual void SetDocumentLocator(ILocator locator)
Parameters
Type Name Description
ILocator locator

an object that can return the location of any SAX document event
Remarks

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

Note that the locator will return correct information only during the invocation SAX event callbacks after StartDocument() returns and before EndDocument() is called. The application should not attempt to use it at any other time.
See Also

SkippedEntity(string)

Receive notification of a skipped entity. This is not called for entity references within markup constructs such as element start tags or markup declarations. (The XML recommendation requires reporting skipped external entities. SAX also reports internal entity expansion/non-expansion, except within markup constructs.)

The Parser will invoke this method each time the entity is skipped.Non-validating processors may skip entities if they have not seen the declarations(because, for example, the entity was declared in an external DTD subset). All processors may skip external entities, depending on the values of the http://xml.org/sax/features/external-general-entities and the http://xml.org/sax/features/external-general-entities properties.
Declaration
public virtual void SkippedEntity(string name)
Parameters
Type Name Description
string name

the name of the skipped entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be the string "[dtd]"
See Also

StartCDATA()

Report the start of a CDATA section.

Declaration
public virtual void StartCDATA()
Remarks

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

Exceptions
Type Condition
SAXException

The application may raise an exception.
See Also

StartDTD(string, string, string)

Report the start of DTD declarations, if any.

Declaration
public virtual void StartDTD(string name, string publicId, string systemId)
Parameters
Type Name Description
string name

The document type name.
string publicId

The declared public identifier for the external DTD subset, or null if none was declared.
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.

StartDocument()

Receive notification of the beginning of a document.

Declaration
public virtual void StartDocument()
Remarks

The SAX parser will invoke this method only once, before any other event callbacks (except for SetDocumentLocator(ILocator).

Exceptions
Type Condition
SAXException

any SAX exception, possibly wrapping another exception
See Also

StartElement(string, string, string, IAttributes)

Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding EndElement(string, string, string) event for every StartElement(string, string, string, IAttributes) event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding EndElement(string, string, string) event.

This event allows up to three name components for each element:
  1. the Namespace URI;
  2. the local name; and
  3. the qualified (prefixed) name.

Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and thehttp://xml.org/sax/features/namespace-prefixes properties:
  • the Namespace URI and local name are required when the namespaces property is true (the default), and are optional when the namespaces property is false (if one is specified, both must be);
  • the qualified name is required when the namespace-prefixes property is true, and is optional when the namespace-prefixes property is false (the default).

Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted. The attribute list will contain attributes used for Namespace declarations (xmlns/// attributes) only if the http://xml.org/sax/features/namespace-prefixes property is true (it is false by default, and support for a true value is optional).

Like Characters(char[], int, int), attribute values may have characters that need more than one char value.
Declaration
public virtual void StartElement(string uri, string localname, string qname, IAttributes atts)
Parameters
Type Name Description
string uri

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
string qname
IAttributes atts

the attributes attached to the element. If there are no attributes, it shall be an empty IAttributes object. The value of this object after StartElement(string, string, string, IAttributes) returns is undefined
Exceptions
Type Condition
SAXException

any SAX exception, possibly wrapping another exception
See Also

StartEntity(string)

Report the beginning of some internal and external XML entities.

Declaration
public virtual void StartEntity(string name)
Parameters
Type Name Description
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

StartPrefixMapping(string, string)

Begin the scope of a prefix-URI Namespace mapping.

Declaration
public virtual void StartPrefixMapping(string prefix, string uri)
Parameters
Type Name Description
string prefix

the Namespace prefix being declared. An empty string is used for the default element namespace, which has no prefix.
string uri

the Namespace URI the prefix is mapped to
Remarks

The information from this event is not necessary for normal Namespace processing: the SAX XML reader will automatically replace prefixes for element and attribute names when the

http://xml.org/sax/features/namespaces
feature is true (the default).

There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary.

Note that start/endPrefixMapping events are not guaranteed to be properly nested relative to each other: all startPrefixMapping events will occur immediately before the corresponding StartElement(string, string, string, IAttributes) event, and all EndPrefixMapping(string) events will occur immediately after the corresponding EndElement(string, string, string) event, but their order is not otherwise guaranteed.

There should never be start/endPrefixMapping events for the "xml" prefix, since it is predeclared and immutable.
Exceptions
Type Condition
SAXException

the client may throw an exception during processing
See Also

Implements