Java Doc for XMLOutput.java in  » Library » Apache-commons-jelly-1.0-src » org » apache » commons » jelly » Java Source Code / Java DocumentationJava Source Code and Java Documentation

XMLOutput is used to output XML events in a SAX-like manner. This also allows pipelining to be done such as in the Cocoon project.

The Parser will call this method to report each chunk of character data.

This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read).

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse.

See XMLOutput.startPrefixMapping startPrefixMapping for details.

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 XMLOutput.characters characters() , processing instruction data may have characters that need more than one char value.

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.

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 org.xml.sax.DTDHandler DTDHandler or org.xml.sax.ext.DeclHandler DeclHandler events must appear between the startDTD and XMLOutput.endDTD endDTD events. Declarations are assumed to belong to the internal DTD subset unless they appear between XMLOutput.startEntity startEntity and XMLOutput.endEntity endEntity events.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding XMLOutput.endElement endElement event for every startElement event (even when the element is empty).

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.

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 XMLOutput.ignorableWhitespace ignorableWhitespace method rather than this one (validating parsers must do so).

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

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.

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.

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

For information on the names, see startElement.

See XMLOutput.startPrefixMapping startPrefixMapping for details. These events will always occur immediately after the corresponding XMLOutput.endElement endElement event, but the order of XMLOutput.endPrefixMapping endPrefixMapping events is not otherwise guaranteed.

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.

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 XMLOutput.characters characters() , processing instruction data may have characters that need more than one char value.

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 of the events in this interface. The application should not attempt to use it at any other time.

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-parameter-entities properties.

The contents of the CDATA section will be reported through the regular org.xml.sax.ContentHandler.characterscharacters event; this event is intended only to report the boundary.

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 org.xml.sax.DTDHandler DTDHandler or org.xml.sax.ext.DeclHandler DeclHandler events must appear between the startDTD and XMLOutput.endDTD endDTD events. Declarations are assumed to belong to the internal DTD subset unless they appear between XMLOutput.startEntity startEntity and XMLOutput.endEntity endEntity events. Comments and processing instructions from the DTD should also be reported between the startDTD and endDTD events, in their original order of (logical) occurrence; they are not required to appear in their correct locations relative to DTDHandler or DeclHandler events, however.

Note that the start/endDTD events will appear within the start/endDocument events from ContentHandler and before the first org.xml.sax.ContentHandler.startElement startElement event.

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

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding XMLOutput.endElement endElement event for every startElement event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement 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 the http://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 XMLOutput.characters characters() , attribute values may have characters that need more than one char value.

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 org.xml.sax.ext.DeclHandler DeclHandler or org.xml.sax.DTDHandler DTDHandler be properly ordered.

Note that skipped entities will be reported through the org.xml.sax.ContentHandler.skippedEntity skippedEntity 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.
Parameters:
  name - The name of the entity. If it is a parameterentity, the name will begin with '%', and if it is theexternal DTD subset, it will be "[dtd]".
exception:
  SAXException - The application may raise an exception.
See Also:   XMLOutput.endEntity
See Also:   org.xml.sax.ext.DeclHandler.internalEntityDecl
See Also:   org.xml.sax.ext.DeclHandler.externalEntityDecl

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 XMLOutput.startElement startElement event, and all XMLOutput.endPrefixMapping endPrefixMapping events will occur immediately after the corresponding XMLOutput.endElement endElement 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.