| com.microstar.xml.XmlHandler
All known Subclasses: com.microstar.xml.HandlerBase,
| XmlHandler | | public interface XmlHandler (Code) | | XML Processing Interface.
Whenever you parse an XML document, you must provide an object
from a class that implements this interface to receive the parsing
events.
If you do not want to implement this entire interface, you
can extend the HandlerBase convenience class and
then implement only what you need.
If you are using SAX, you should implement the SAX handler
interfaces rather than this one.
author:
Copyright (c) 1997, 1998 by Microstar Software Ltd.
author:
written by David Megginson <dmeggins@microstar.com>
version:
1.1
See Also: XmlParser
See Also: HandlerBase
See Also: org.xml.sax.EntityHandler
See Also: org.xml.sax.DocumentHandler
See Also: org.xml.sax.ErrorHandler |
| Method Summary | |
| public void | attribute(String aname, String value, boolean isSpecified)
Attribute. | | public void | charData(char ch, int start, int length)
Character data.
Ælfred will call this method once for each chunk of
character data found in the contents of elements. | | public void | doctypeDecl(String name, String publicId, String systemId)
Document type declaration. | | public void | endDocument()
End the document. | | public void | endElement(String elname)
End an element. | | public void | endExternalEntity(String systemId)
End an external entity. | | public void | error(String message, String systemId, int line, int column)
Fatal XML parsing error.
Ælfred will call this method whenever it encounters
a serious error. | | public void | ignorableWhitespace(char ch, int start, int length)
Ignorable whitespace. | | public void | processingInstruction(String target, String data)
Processing instruction.
Ælfred will call this method once for each
processing instruction. | | public Object | resolveEntity(String publicId, String systemId)
Resolve an External Entity.
Give the handler a chance to redirect external entities
to different URIs. | | public void | startDocument()
Start the document. | | public void | startElement(String elname)
Start an element.
Ælfred will call this method at the beginning of each
element. | | public void | startExternalEntity(String systemId)
Begin an external entity. |
| attribute | | public void attribute(String aname, String value, boolean isSpecified) throws java.lang.Exception(Code) | | Attribute.
Ælfred will call this method once for each attribute
(specified or defaulted) before reporting a startElement event.
It is up to your handler to collect the attributes, if
necessary.
You may use XmlParser.getAttributeType() to find the attribute's
declared type.
Parameters:
name - The name of the attribute.
Parameters:
type - The type of the attribute (see below).
Parameters:
value - The value of the attribute, or null if the attributeis #IMPLIED.
Parameters:
isSpecified - True if the value was specified, false if itwas defaulted from the DTD.
exception:
java.lang.Exception - The handler may throw any exception.
See Also: XmlHandler.startElement
See Also: XmlParser.declaredAttributes
See Also: XmlParser.getAttributeType
See Also: XmlParser.getAttributeDefaultValue |
| charData | | public void charData(char ch, int start, int length) throws java.lang.Exception(Code) | | Character data.
Ælfred will call this method once for each chunk of
character data found in the contents of elements. Note that
the parser may break up a long sequence of characters into
smaller chunks and call this method once for each chunk.
Do not attempt to read more than length
characters from the array, or to read before the
start position.
Parameters:
ch - The character data.
Parameters:
start - The starting position in the array.
Parameters:
length - The number of characters available.
exception:
java.lang.Exception - The handler may throw any exception. |
| doctypeDecl | | public void doctypeDecl(String name, String publicId, String systemId) throws java.lang.Exception(Code) | | Document type declaration.
Ælfred will call this method when or if it encounters
the document type (DOCTYPE) declaration.
Please note that the public and system identifiers will
not always be a reliable indication of the DTD in use.
Parameters:
name - The document type name.
Parameters:
publicId - The public identifier, or null if unspecified.
Parameters:
systemId - The system identifier, or null if unspecified.
exception:
java.lang.Exception - The handler may throw any exception. |
| endExternalEntity | | public void endExternalEntity(String systemId) throws java.lang.Exception(Code) | | End an external entity.
Ælfred will call this method at the end of
each external entity, including the top-level document entity
and the external DTD subset.
If necessary, you can use this method to track the location
of the current entity so that you can resolve relative URIs
correctly.
Parameters:
systemId - The URI of the external entity that is ending.
exception:
java.lang.Exception - The handler may throw any exception.
See Also: XmlHandler.startExternalEntity
See Also: XmlHandler.resolveEntity |
| error | | public void error(String message, String systemId, int line, int column) throws java.lang.Exception(Code) | | Fatal XML parsing error.
Ælfred will call this method whenever it encounters
a serious error. The parser will attempt to continue past this
point so that you can find more possible error points, but if
this method is called you should assume that the document is
corrupt and you should not try to use its contents.
Note that you can use the XmlException class
to encapsulate all of the information provided, though the
use of the class is not mandatory.
Parameters:
message - The error message.
Parameters:
systemId - The system identifier of the entity that contains the error.
Parameters:
line - The approximate line number of the error.
Parameters:
column - The approximate column number of the error.
exception:
java.lang.Exception - The handler may throw any exception.
See Also: XmlException |
| ignorableWhitespace | | public void ignorableWhitespace(char ch, int start, int length) throws java.lang.Exception(Code) | | Ignorable whitespace.
Ælfred will call this method once for each sequence
of ignorable whitespace in element content (never in mixed content).
For details, see section 2.10 of the XML 1.0 recommendation.
Do not attempt to read more than length
characters from the array or to read before the start
position.
Parameters:
ch - The literal whitespace characters.
Parameters:
start - The starting position in the array.
Parameters:
length - The number of whitespace characters available.
exception:
java.lang.Exception - The handler may throw any exception. |
| processingInstruction | | public void processingInstruction(String target, String data) throws java.lang.Exception(Code) | | Processing instruction.
Ælfred will call this method once for each
processing instruction. Note that processing instructions may
appear outside of the top-level element. The
Parameters:
target - The target (the name at the start of the PI).
Parameters:
data - The data, if any (the rest of the PI).
exception:
java.lang.Exception - The handler may throw any exception. |
| resolveEntity | | public Object resolveEntity(String publicId, String systemId) throws java.lang.Exception(Code) | | Resolve an External Entity.
Give the handler a chance to redirect external entities
to different URIs. Ælfred will call this method for the
top-level document entity, for external text (XML) entities,
and the external DTD subset (if any).
Parameters:
publicId - The public identifier, or null if none was supplied.
Parameters:
systemId - The system identifier. The replacement system identifier, or null to usethe default.
exception:
java.lang.Exception - The handler may throw any exception.
See Also: XmlHandler.startExternalEntity
See Also: XmlHandler.endExternalEntity |
| startDocument | | public void startDocument() throws java.lang.Exception(Code) | | Start the document.
Ælfred will call this method just before it
attempts to read the first entity (the root of the document).
It is guaranteed that this will be the first method called.
exception:
java.lang.Exception - The handler may throw any exception.
See Also: XmlHandler.endDocument |
| startExternalEntity | | public void startExternalEntity(String systemId) throws java.lang.Exception(Code) | | Begin an external entity.
Ælfred will call this method at the beginning of
each external entity, including the top-level document entity
and the external DTD subset (if any).
If necessary, you can use this method to track the location
of the current entity so that you can resolve relative URIs
correctly.
Parameters:
systemId - The URI of the external entity that is starting.
exception:
java.lang.Exception - The handler may throw any exception.
See Also: XmlHandler.endExternalEntity
See Also: XmlHandler.resolveEntity |
|
|