Deklaration

Beschreibung

DocumentHandler ist ein zentrales Interface der SAX-API. XML-Applikationen, die von Ereignissen bei der Baum-Traversierung benachrichtigt werden wollen, müssen dieses Interface implementieren und die Implementierung mit der Methode setDocumentHandler() beim verwendeten Parser registrieren. Nach der Registrierung erhält die XML-Applikation Callbacks vom Parser, wenn die entsprechenden Ereignisse eintreten. Die folgenden Ereignistypen werden unterstützt:

• Anfang und Ende des Dokuments
• Anfang und Ende eines Elements
• Antreffen einer Processing Instruction
• Antreffen von Zeichendaten
• Antreffen von vernachlässigbaren Whitespace-Zeichen

Methoden im Detail

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

Benachrichtigt die XML-Applikation vom Antreffen von Zeichendaten. Die Zeichendaten befinden sind in den ersten length Zeichen ab der Position start in ch. Die XML-Applikation darf nur den durch start und length definierten Bereich von ch auslesen.

Exception: SAXException

• Wenn bei der Verarbeitung ein Fehler auftritt.

public void endDocument()

Wird aufgerufen, wenn das Ende des Dokuments erreicht wird.

Exception: SAXException

• Wenn bei der Verarbeitung ein Fehler auftritt.

public void endElement(String name)

Wird aufgerufen, wenn das Ende des Elements name erreicht wird.

Exception: SAXException

• Wenn bei der Verarbeitung ein Fehler auftritt.

public void ignorableWhitespace(char[] ch, int start, int length)

Benachrichtigt die XML-Applikation vom Antreffen von Whitespace-Zeichen, die nach der Spezifikation ignoriert werden können. Die Zeichen befinden sind in den ersten length Zeichen ab der Position start in ch enthalten. Die XML-Applikation darf nur den durch start und length definierten Bereich von ch auslesen.

Exception: SAXException

• Wenn bei der Verarbeitung ein Fehler auftritt.

public void processingInstruction(String target, String data)

Wird aufgerufen, wenn eine Processing Instruction angetroffen wird. target ist das Target, für data wird die Anweisung übergeben.

Exception: SAXException

• Wenn bei der Verarbeitung ein Fehler auftritt.

public void setDocumentLocator(Locator locator)

Mit dieser Methode liefert der Parser der XML-Applikation ein Locator-Objekt, mit dem die sie bei der Traversierung des Parse-Baums die Position der einzelnen Events im Dokument (Zeile und Spalte) ermitteln kann. Die SAX-API schreibt nicht zwingend vor daß der Parser diese Methode aufrufen muß. Falls er diese Methode aber unterstützt, muß sie vor allen anderen Methoden dieses Interface aufgerufen werden. Das übergebene Locator-Objekt enthält nur während des Aufrufs der Event-Handler-Methoden gültige Werte.

public void startDocument()

Wird aufgerufen, wenn der Anfang des Dokuments erreicht wird.

Exception: SAXException

• Wenn bei der Verarbeitung ein Fehler auftritt.

public void startElement(String name, AttributeList atts)

Wird aufgerufen, wenn der Anfang des Elements name erreicht wird. In atts werden die Attribute übergeben. Dieses Objekt ist nur während der Ausführung dieser Methode gültig. Falls es darüber hinaus gespeichert werden soll, kann mit dem parameterbehafteten Konstruktor der Klasse AttributeListImpl im Unterpaket helpers eine Kopie erzeugt werden.

Exception: SAXException

• Wenn bei der Verarbeitung ein Fehler auftritt.