Modifier and Type	Class and Description
private static class	SAX2StAXBaseWriter.SAXLocation `Location`implementation used to expose details from a SAX `Locator`.

Modifier and Type	Field and Description
protected StringBuffer	CDATABuffer
protected Locator	docLocator
pack-priv String	encoding
protected boolean	isCDATA
protected List<String>	namespaces
protected XMLReporter	reporter
pack-priv String	xmlVersion

Access	Constructor and Description
public	SAX2StAXBaseWriter()
public	SAX2StAXBaseWriter(XMLReporter reporter)

Method Summary

Modifier and Type	Method and Description
public void	characters(char[] The characters. ch, int The start position in the character array. start, int The number of characters to use from the character array. length) Overrides org.xml.sax.helpers.DefaultHandler.characters. Implements org.xml.sax.ContentHandler.characters. Receive notification of character data inside an element.
public void	comment(char[] An array holding the characters in the comment. ch, int The starting position in the array. start, int The number of characters to use from the array. length) Implements org.xml.sax.ext.LexicalHandler.comment. Report an XML comment anywhere in the document.
public void	endCDATA() Implements org.xml.sax.ext.LexicalHandler.endCDATA. Report the end of a CDATA section.
public void	endDocument() Overrides org.xml.sax.helpers.DefaultHandler.endDocument. Implements org.xml.sax.ContentHandler.endDocument. Receive notification of the end of the document.
public void	endDTD() Implements org.xml.sax.ext.LexicalHandler.endDTD. Report the end of DTD declarations.
public void	endElement(String The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed. uri, String The local name (without prefix), or the empty string if Namespace processing is not being performed. localName, String The qualified name (with prefix), or the empty string if qualified names are not available. qName) Overrides org.xml.sax.helpers.DefaultHandler.endElement. Implements org.xml.sax.ContentHandler.endElement. Receive notification of the end of an element.
public void	endEntity(String The name of the entity that is ending. name) Implements org.xml.sax.ext.LexicalHandler.endEntity. Report the end of an entity.
public void	endPrefixMapping(String The Namespace prefix being declared. prefix) Overrides org.xml.sax.helpers.DefaultHandler.endPrefixMapping. Implements org.xml.sax.ContentHandler.endPrefixMapping. Receive notification of the end of a Namespace mapping.
public void	error(SAXParseException The error information encoded as an exception. e) Overrides org.xml.sax.helpers.DefaultHandler.error. Implements org.xml.sax.ErrorHandler.error. Receive notification of a recoverable parser error.
public void	fatalError(SAXParseException The error information encoded as an exception. e) Overrides org.xml.sax.helpers.DefaultHandler.fatalError. Implements org.xml.sax.ErrorHandler.fatalError. Report a fatal XML parsing error.
public Location	getCurrentLocation()
public static final void	parseQName(String The qualified name to parse. qName, String[] An array where parse results will be placed. The prefix will be placed at `results[0]`, and the local part at `results[1]` results) Parses an XML qualified name, and places the resulting prefix and local name in the provided String array.
protected void	reportException(String type, SAXException e) Used to report a `SAXException`to the `XMLReporter` registered with this handler.
public void	setDocumentLocator(Locator A locator for all SAX document events. locator) Overrides org.xml.sax.helpers.DefaultHandler.setDocumentLocator. Implements org.xml.sax.ContentHandler.setDocumentLocator. Receive a Locator object for document events.
public void	setEncoding(String encoding)
public void	setXMLReporter(XMLReporter reporter)
public void	setXmlVersion(String version)
public void	startCDATA() Implements org.xml.sax.ext.LexicalHandler.startCDATA. Report the start of a CDATA section.
public void	startDocument() Overrides org.xml.sax.helpers.DefaultHandler.startDocument. Implements org.xml.sax.ContentHandler.startDocument. Receive notification of the beginning of the document.
public void	startDTD(String The document type name. name, String The declared public identifier for the external DTD subset, or null if none was declared. publicId, String 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.) systemId) Implements org.xml.sax.ext.LexicalHandler.startDTD. Report the start of DTD declarations, if any.
public void	startElement(String The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed. uri, String The local name (without prefix), or the empty string if Namespace processing is not being performed. localName, String The qualified name (with prefix), or the empty string if qualified names are not available. qName, Attributes The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object. attributes) Overrides org.xml.sax.helpers.DefaultHandler.startElement. Implements org.xml.sax.ContentHandler.startElement. Receive notification of the start of an element.
public void	startEntity(String 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]". name) Implements org.xml.sax.ext.LexicalHandler.startEntity. Report the beginning of some internal and external XML entities.
public void	startPrefixMapping(String The Namespace prefix being declared. prefix, String The Namespace URI mapped to the prefix. uri) Overrides org.xml.sax.helpers.DefaultHandler.startPrefixMapping. Implements org.xml.sax.ContentHandler.startPrefixMapping. Receive notification of the start of a Namespace mapping.
private void	updateVersionAndEncoding()
public void	warning(SAXParseException The warning information encoded as an exception. e) Overrides org.xml.sax.helpers.DefaultHandler.warning. Implements org.xml.sax.ErrorHandler.warning. Receive notification of a parser warning.
pack-priv void	writeStartDocument()

Inherited from org.xml.sax.helpers.DefaultHandler:: ignorableWhitespace notationDecl processingInstruction resolveEntity skippedEntity unparsedEntityDecl

Field Detail

CDATABuffer	back to summary
protected StringBuffer CDATABuffer

docLocator	back to summary
protected Locator docLocator

encoding	back to summary
pack-priv String encoding

isCDATA	back to summary
protected boolean isCDATA

namespaces	back to summary
protected List<String> namespaces

reporter	back to summary
protected XMLReporter reporter

xmlVersion	back to summary
pack-priv String xmlVersion

Constructor Detail

SAX2StAXBaseWriter	back to summary
public SAX2StAXBaseWriter()

SAX2StAXBaseWriter	back to summary
public SAX2StAXBaseWriter(XMLReporter reporter)

Method Detail

characters	back to summary
public void characters(char[] ch, int start, int length) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.characters. Implements org.xml.sax.ContentHandler.characters. Doc from org.xml.sax.helpers.DefaultHandler.characters. 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). Parameters ch:char[] The characters. start:int The start position in the character array. length:int The number of characters to use from the character array. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

characters

back to summary

public void characters(char[] ch, int start, int length) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.characters.

Implements org.xml.sax.ContentHandler.characters.

Doc from org.xml.sax.helpers.DefaultHandler.characters.

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

Parameters

ch:char[]: The characters.
start:int: The start position in the character array.
length:int: The number of characters to use from the character array.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

comment	back to summary
public void comment(char[] ch, int start, int length) throws SAXException Implements org.xml.sax.ext.LexicalHandler.comment. Doc from org.xml.sax.ext.LexicalHandler.comment. 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). Parameters ch:char[] An array holding the characters in the comment. start:int The starting position in the array. length:int The number of characters to use from the array. Exceptions SAXException: The application may raise an exception.

comment

back to summary

public void comment(char[] ch, int start, int length) throws SAXException

Implements org.xml.sax.ext.LexicalHandler.comment.

Doc from org.xml.sax.ext.LexicalHandler.comment.

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

Parameters

ch:char[]: An array holding the characters in the comment.
start:int: The starting position in the array.
length:int: The number of characters to use from the array.

Exceptions

SAXException:: The application may raise an exception.

endCDATA	back to summary
public void endCDATA() throws SAXException Implements org.xml.sax.ext.LexicalHandler.endCDATA. Doc from org.xml.sax.ext.LexicalHandler.endCDATA. Report the end of a CDATA section. Exceptions SAXException: The application may raise an exception.

endCDATA

back to summary

public void endCDATA() throws SAXException

Implements org.xml.sax.ext.LexicalHandler.endCDATA.

Doc from org.xml.sax.ext.LexicalHandler.endCDATA.

Report the end of a CDATA section.

Exceptions

SAXException:: The application may raise an exception.

endDocument	back to summary
public void endDocument() throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.endDocument. Implements org.xml.sax.ContentHandler.endDocument. Doc from org.xml.sax.helpers.DefaultHandler.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). Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

endDocument

back to summary

public void endDocument() throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.endDocument.

Implements org.xml.sax.ContentHandler.endDocument.

Doc from org.xml.sax.helpers.DefaultHandler.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).

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

endDTD	back to summary
public void endDTD() throws SAXException Implements org.xml.sax.ext.LexicalHandler.endDTD. Doc from org.xml.sax.ext.LexicalHandler.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. Exceptions SAXException: The application may raise an exception.

endDTD

back to summary

public void endDTD() throws SAXException

Implements org.xml.sax.ext.LexicalHandler.endDTD.

Doc from org.xml.sax.ext.LexicalHandler.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.

Exceptions

SAXException:: The application may raise an exception.

endElement	back to summary
public void endElement(String uri, String localName, String qName) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.endElement. Implements org.xml.sax.ContentHandler.endElement. Doc from org.xml.sax.helpers.DefaultHandler.endElement. 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). Parameters uri:String The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed. localName:String The local name (without prefix), or the empty string if Namespace processing is not being performed. qName:String The qualified name (with prefix), or the empty string if qualified names are not available. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

endElement

back to summary

public void endElement(String uri, String localName, String qName) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.endElement.

Implements org.xml.sax.ContentHandler.endElement.

Doc from org.xml.sax.helpers.DefaultHandler.endElement.

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

Parameters

uri:String: The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
localName:String: The local name (without prefix), or the empty string if Namespace processing is not being performed.
qName:String: The qualified name (with prefix), or the empty string if qualified names are not available.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

endEntity	back to summary
public void endEntity(String name) throws SAXException Implements org.xml.sax.ext.LexicalHandler.endEntity. Doc from org.xml.sax.ext.LexicalHandler.endEntity. Report the end of an entity. Parameters name:String The name of the entity that is ending. Exceptions SAXException: The application may raise an exception.

endEntity

back to summary

public void endEntity(String name) throws SAXException

Implements org.xml.sax.ext.LexicalHandler.endEntity.

Doc from org.xml.sax.ext.LexicalHandler.endEntity.

Report the end of an entity.

Parameters

name:String: The name of the entity that is ending.

Exceptions

SAXException:: The application may raise an exception.

endPrefixMapping	back to summary
public void endPrefixMapping(String prefix) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.endPrefixMapping. Implements org.xml.sax.ContentHandler.endPrefixMapping. Doc from org.xml.sax.helpers.DefaultHandler.endPrefixMapping. 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. Parameters prefix:String The Namespace prefix being declared. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

endPrefixMapping

back to summary

public void endPrefixMapping(String prefix) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.endPrefixMapping.

Implements org.xml.sax.ContentHandler.endPrefixMapping.

Doc from org.xml.sax.helpers.DefaultHandler.endPrefixMapping.

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.

Parameters

prefix:String: The Namespace prefix being declared.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

error	back to summary
public void error(SAXParseException e) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.error. Implements org.xml.sax.ErrorHandler.error. Doc from org.xml.sax.helpers.DefaultHandler.error. 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. Parameters e:SAXParseException The error information encoded as an exception. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

error

back to summary

public void error(SAXParseException e) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.error.

Implements org.xml.sax.ErrorHandler.error.

Doc from org.xml.sax.helpers.DefaultHandler.error.

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.

Parameters

e:SAXParseException: The error information encoded as an exception.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

fatalError	back to summary
public void fatalError(SAXParseException e) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.fatalError. Implements org.xml.sax.ErrorHandler.fatalError. Doc from org.xml.sax.helpers.DefaultHandler.fatalError. 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. Parameters e:SAXParseException The error information encoded as an exception. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

fatalError

back to summary

public void fatalError(SAXParseException e) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.fatalError.

Implements org.xml.sax.ErrorHandler.fatalError.

Doc from org.xml.sax.helpers.DefaultHandler.fatalError.

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.

Parameters

e:SAXParseException: The error information encoded as an exception.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

getCurrentLocation	back to summary
public Location getCurrentLocation()

parseQName back to summary

parseQName	back to summary
public static final void parseQName(String qName, String[] results) Parses an XML qualified name, and places the resulting prefix and local name in the provided String array. Parameters qName:String The qualified name to parse. results:String[] An array where parse results will be placed. The prefix will be placed at `results[0]`, and the local part at `results[1]`

public static final void parseQName(String qName, String[] results)

Parses an XML qualified name, and places the resulting prefix and local name in the provided String array.

Parameters

qName:String: The qualified name to parse.
results:String[]: An array where parse results will be placed. The prefix will be placed at results[0], and the local part at results[1]

reportException	back to summary
protected void reportException(String type, SAXException e) throws SAXException Used to report a `SAXException`to the `XMLReporter` registered with this handler.

setDocumentLocator	back to summary
public void setDocumentLocator(Locator locator) Overrides org.xml.sax.helpers.DefaultHandler.setDocumentLocator. Implements org.xml.sax.ContentHandler.setDocumentLocator. Doc from org.xml.sax.helpers.DefaultHandler.setDocumentLocator. 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. Parameters locator:Locator A locator for all SAX document events.

setDocumentLocator

back to summary

public void setDocumentLocator(Locator locator)

Overrides org.xml.sax.helpers.DefaultHandler.setDocumentLocator.

Implements org.xml.sax.ContentHandler.setDocumentLocator.

Doc from org.xml.sax.helpers.DefaultHandler.setDocumentLocator.

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.

Parameters

locator:Locator: A locator for all SAX document events.

setEncoding	back to summary
public void setEncoding(String encoding)

setXMLReporter	back to summary
public void setXMLReporter(XMLReporter reporter)

setXmlVersion	back to summary
public void setXmlVersion(String version)

startCDATA back to summary

startCDATA	back to summary
public void startCDATA() throws SAXException Implements org.xml.sax.ext.LexicalHandler.startCDATA. Doc from org.xml.sax.ext.LexicalHandler.startCDATA. Report the start of a CDATA section. The contents of the CDATA section will be reported through the regular `characters` event; this event is intended only to report the boundary. Exceptions SAXException: The application may raise an exception.

public void startCDATA() throws SAXException

Implements org.xml.sax.ext.LexicalHandler.startCDATA.

Doc from org.xml.sax.ext.LexicalHandler.startCDATA.

Report the start of a CDATA section.

The contents of the CDATA section will be reported through the regular characters event; this event is intended only to report the boundary.

Exceptions

SAXException:: The application may raise an exception.

startDocument	back to summary
public void startDocument() throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.startDocument. Implements org.xml.sax.ContentHandler.startDocument. Doc from org.xml.sax.helpers.DefaultHandler.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). Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

startDocument

back to summary

public void startDocument() throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.startDocument.

Implements org.xml.sax.ContentHandler.startDocument.

Doc from org.xml.sax.helpers.DefaultHandler.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).

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

startDTD back to summary

startDTD	back to summary
public void startDTD(String name, String publicId, String systemId) throws SAXException Implements org.xml.sax.ext.LexicalHandler.startDTD. Doc from org.xml.sax.ext.LexicalHandler.startDTD. Report the start of DTD declarations, if any. 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 `DTDHandler` or `DeclHandler` events must appear between the startDTD and `endDTD` events. Declarations are assumed to belong to the internal DTD subset unless they appear between `startEntity` and `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 `startElement` event. Parameters name:String The document type name. publicId:String The declared public identifier for the external DTD subset, or null if none was declared. systemId:String 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.) Exceptions SAXException: The application may raise an exception.

public void startDTD(String name, String publicId, String systemId) throws SAXException

Implements org.xml.sax.ext.LexicalHandler.startDTD.

Doc from org.xml.sax.ext.LexicalHandler.startDTD.

Report the start of DTD declarations, if any.

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 DTDHandler or DeclHandler events must appear between the startDTD and endDTD events. Declarations are assumed to belong to the internal DTD subset unless they appear between startEntity and 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 startElement event.

Parameters

name:String: The document type name.
publicId:String: The declared public identifier for the external DTD subset, or null if none was declared.
systemId:String: 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.)

Exceptions

SAXException:: The application may raise an exception.

startElement	back to summary
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.startElement. Implements org.xml.sax.ContentHandler.startElement. Doc from org.xml.sax.helpers.DefaultHandler.startElement. 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). Parameters uri:String The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed. localName:String The local name (without prefix), or the empty string if Namespace processing is not being performed. qName:String The qualified name (with prefix), or the empty string if qualified names are not available. attributes:Attributes The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

startElement

back to summary

public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.startElement.

Implements org.xml.sax.ContentHandler.startElement.

Doc from org.xml.sax.helpers.DefaultHandler.startElement.

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

Parameters

uri:String: The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
localName:String: The local name (without prefix), or the empty string if Namespace processing is not being performed.
qName:String: The qualified name (with prefix), or the empty string if qualified names are not available.
attributes:Attributes: The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

startEntity back to summary

startEntity	back to summary
public void startEntity(String name) throws SAXException Implements org.xml.sax.ext.LexicalHandler.startEntity. Doc from org.xml.sax.ext.LexicalHandler.startEntity. Report the beginning of some internal and external XML entities. 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 `DeclHandler` or `DTDHandler` be properly ordered. Note that skipped entities will be reported through the `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:String 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]". Exceptions SAXException: The application may raise an exception.

public void startEntity(String name) throws SAXException

Implements org.xml.sax.ext.LexicalHandler.startEntity.

Doc from org.xml.sax.ext.LexicalHandler.startEntity.

Report the beginning of some internal and external XML entities.

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 DeclHandler or DTDHandler be properly ordered.

Note that skipped entities will be reported through the 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:String: 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]".

Exceptions

SAXException:: The application may raise an exception.

startPrefixMapping	back to summary
public void startPrefixMapping(String prefix, String uri) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.startPrefixMapping. Implements org.xml.sax.ContentHandler.startPrefixMapping. Doc from org.xml.sax.helpers.DefaultHandler.startPrefixMapping. 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). Parameters prefix:String The Namespace prefix being declared. uri:String The Namespace URI mapped to the prefix. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

startPrefixMapping

back to summary

public void startPrefixMapping(String prefix, String uri) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.startPrefixMapping.

Implements org.xml.sax.ContentHandler.startPrefixMapping.

Doc from org.xml.sax.helpers.DefaultHandler.startPrefixMapping.

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

Parameters

prefix:String: The Namespace prefix being declared.
uri:String: The Namespace URI mapped to the prefix.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

updateVersionAndEncoding	back to summary
private void updateVersionAndEncoding()

warning	back to summary
public void warning(SAXParseException e) throws SAXException Overrides org.xml.sax.helpers.DefaultHandler.warning. Implements org.xml.sax.ErrorHandler.warning. Doc from org.xml.sax.helpers.DefaultHandler.warning. 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. Parameters e:SAXParseException The warning information encoded as an exception. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

warning

back to summary

public void warning(SAXParseException e) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.warning.

Implements org.xml.sax.ErrorHandler.warning.

Doc from org.xml.sax.helpers.DefaultHandler.warning.

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.

Parameters

e:SAXParseException: The warning information encoded as an exception.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

writeStartDocument	back to summary
pack-priv void writeStartDocument() throws SAXException

com.sun.org.apache.xalan.internal.xsltc.trax back to summary

private final Class SAX2StAXBaseWriter.SAXLocation

Class Inheritance

extends Object
implements Location

java.lang.Object
com.sun.org.apache.xalan.internal.xsltc.trax.SAX2StAXBaseWriter.SAXLocation

All Implemented Interfaces

javax.xml.stream.Location

Locationimplementation used to expose details from a SAX Locator.

Author: christian

Field Summary

Modifier and Type	Field and Description
private int	columnNumber
private int	lineNumber
private String	publicId
private String	systemId

Constructor Summary

Access	Constructor and Description
private	SAXLocation(Locator locator)

Method Summary

Modifier and Type	Method and Description
public int	getCharacterOffset() Implements javax.xml.stream.Location.getCharacterOffset. Return the byte or character offset into the input source this location is pointing to.
public int	getColumnNumber() Implements javax.xml.stream.Location.getColumnNumber. Return the column number where the current event ends, returns -1 if none is available.
public int	getLineNumber() Implements javax.xml.stream.Location.getLineNumber. Return the line number where the current event ends, returns -1 if none is available.
public String	getPublicId() Implements javax.xml.stream.Location.getPublicId. Returns the public ID of the XML
public String	getSystemId() Implements javax.xml.stream.Location.getSystemId. Returns the system ID of the XML

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

columnNumber	back to summary
private int columnNumber

lineNumber	back to summary
private int lineNumber

publicId	back to summary
private String publicId

systemId	back to summary
private String systemId

Constructor Detail

SAXLocation	back to summary
private SAXLocation(Locator locator)

Method Detail

getCharacterOffset	back to summary
public int getCharacterOffset() Implements javax.xml.stream.Location.getCharacterOffset. Doc from javax.xml.stream.Location.getCharacterOffset. Return the byte or character offset into the input source this location is pointing to. If the input source is a file or a byte stream then this is the byte offset into that stream, but if the input source is a character media then the offset is the character offset. Returns -1 if there is no offset available. Returns:int the current offset

getCharacterOffset

back to summary

public int getCharacterOffset()

Implements javax.xml.stream.Location.getCharacterOffset.

Doc from javax.xml.stream.Location.getCharacterOffset.

Return the byte or character offset into the input source this location is pointing to. If the input source is a file or a byte stream then this is the byte offset into that stream, but if the input source is a character media then the offset is the character offset. Returns -1 if there is no offset available.

Returns:int: the current offset

getColumnNumber	back to summary
public int getColumnNumber() Implements javax.xml.stream.Location.getColumnNumber. Doc from javax.xml.stream.Location.getColumnNumber. Return the column number where the current event ends, returns -1 if none is available. Returns:int the current column number

getColumnNumber

back to summary

public int getColumnNumber()

Implements javax.xml.stream.Location.getColumnNumber.

Doc from javax.xml.stream.Location.getColumnNumber.

Return the column number where the current event ends, returns -1 if none is available.

Returns:int: the current column number

getLineNumber	back to summary
public int getLineNumber() Implements javax.xml.stream.Location.getLineNumber. Doc from javax.xml.stream.Location.getLineNumber. Return the line number where the current event ends, returns -1 if none is available. Returns:int the current line number

getLineNumber

back to summary

public int getLineNumber()

Implements javax.xml.stream.Location.getLineNumber.

Doc from javax.xml.stream.Location.getLineNumber.

Return the line number where the current event ends, returns -1 if none is available.