XmlHandler

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> microstar >> [ xml overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.microstar.xml.XmlHandler

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.microstar.xml
Interface XmlHandler

All Known Implementing Classes:: HandlerBase

public interface XmlHandler

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.

Version:: 1.1

Method Summary

void attribute(java.lang.String aname, java.lang.String value, boolean isSpecified)
          Attribute.

void charData(char[] ch, int start, int length)
          Character data.

void doctypeDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
          Document type declaration.

void endDocument()
          End the document.

void endElement(java.lang.String elname)
          End an element.

void endExternalEntity(java.lang.String systemId)
          End an external entity.

void error(java.lang.String message, java.lang.String systemId, int line, int column)
          Fatal XML parsing error.

void ignorableWhitespace(char[] ch, int start, int length)
          Ignorable whitespace.

void processingInstruction(java.lang.String target, java.lang.String data)
          Processing instruction.

java.lang.Object resolveEntity(java.lang.String publicId, java.lang.String systemId)
          Resolve an External Entity.

void startDocument()
          Start the document.

void startElement(java.lang.String elname)
          Start an element.

void startExternalEntity(java.lang.String systemId)
          Begin an external entity.

Method Detail

startDocument

public void startDocument()
                   throws java.lang.Exception

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.

endDocument

public void endDocument()
                 throws java.lang.Exception

End the document.

Ælfred will call this method once, when it has finished parsing the XML document. It is guaranteed that this will be the last method called.

resolveEntity

public java.lang.Object resolveEntity(java.lang.String publicId,
                                      java.lang.String systemId)
                               throws java.lang.Exception

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

startExternalEntity

public void startExternalEntity(java.lang.String systemId)
                         throws java.lang.Exception

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.

endExternalEntity

public void endExternalEntity(java.lang.String systemId)
                       throws java.lang.Exception

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.

doctypeDecl

public void doctypeDecl(java.lang.String name,
                        java.lang.String publicId,
                        java.lang.String systemId)
                 throws java.lang.Exception

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.

attribute

public void attribute(java.lang.String aname,
                      java.lang.String value,
                      boolean isSpecified)
               throws java.lang.Exception

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.

startElement

public void startElement(java.lang.String elname)
                  throws java.lang.Exception

Start an element.

Ælfred will call this method at the beginning of each element. By the time this is called, all of the attributes for the element will already have been reported using the attribute method.

endElement

public void endElement(java.lang.String elname)
                throws java.lang.Exception

End an element.

Ælfred will call this method at the end of each element (including EMPTY elements).

charData

public void charData(char[] ch,
                     int start,
                     int length)
              throws java.lang.Exception

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.

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws java.lang.Exception

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.

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws java.lang.Exception

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

error

public void error(java.lang.String message,
                  java.lang.String systemId,
                  int line,
                  int column)
           throws java.lang.Exception

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.