SAX的使用方法简介(一)

SAX的使用方法简介(一)

写在前面的例子sam.xml

<?xml version="1.0" encoding="UTF-8"?>
<session>
   <committee type="monetary">
       <title>Finance</title>
       <number>17</number>
       <subject>Donut Costs</subject>
       <date>7/15/2005</date>
       <attendees>
           <senator status="present">
               <firstName>Thomas</firstName>
               <lastName>Smith</lastName>
           </senator>
           <senator status="absent">
               <firstName>Frank</firstName>
               <lastName>McCoy</lastName>
           </senator>
           <senator status="present">
               <firstName>Jay</firstName>
               <lastName>Jones</lastName>
           </senator>
       </attendees>
   </committee>
</session>

我们来编写一个程序，把这个XML文件读进来，然后在控制台打印

源文件：

import java.io.*;
import org.xml.sax.*;
import javax.xml.parsers.*;
import org.xml.sax.helpers.DefaultHandler;

public class ch17_02 extends DefaultHandler
{
    static?int numberLines = 0;
    static?String indentation = "";
    static?String displayText[] = new?String[1000];

//程序开始执行main方法，调用childLoop，childLoop填充一个字符数组displayText，并把字符串数量
//记录到numberLines中。childLoop执行完以后，只要打印数组displayText的内容就可以实现程序的目标。

    public?static void main(String args[])
    {
        ch17_02 parser = new ch17_02();
        parser.childLoop(args[0]);

        for(int loopIndex = 0; loopIndex < numberLines; loopIndex++){
            System.out.println(displayText[loopIndex]);
        }
    }

    public void childLoop(String uri)
    {

//第一步需要创建一个DefaultHandler
//DefaultHandler 告诉SAX遇到各种类型的节点时应该调用那个object来处理，因为我们这个类
//ch17_02 extends DefaultHandler，而且在类里面提供了处理各种节点的程序，所以使用类自己
//来处理，这里使用java关键字this代表自己，如果有另外的一个类如mySaxHandler来处理，就应该
//是DefaultHandler saxHandler = mySaxHandler();
        DefaultHandler saxHandler = this;

//第二步需要创建一个SAXParserFactory object，这是使用SAX方法解释XML规定的，记住这样做就可以了
        SAXParserFactory saxFactory = SAXParserFactory.newInstance();

//第三步创建一个saxParser来解释XML就可以了，这也是一般规则，调用saxFactory的newSAXParser()
//方法创建一个SAXParser object，关于saxFactory的其他常用方法见[saxFactory的常用方法]
        try {
            SAXParser saxParser = saxFactory.newSAXParser();

//在这里我们看到使用了我们刚才创建的DefaultHandler，通过调用saxParser的parse方法开始XML文件的解释，
//我们可以看到，解释通过命令行指定的文件，调用saxHandler（就是刚才我们创建的DefaultHandler）来响应
//SAX的各种事件，关于saxParser的其他常用方法，见[saxParser的常用方法]。
            saxParser.parse(new File(uri), saxHandler); 
        } catch (Throwable t) {}
    }

//接下来就是响应SAX的一些事件，因为我们这个类extends DefaultHandler，所以这些响应SAX事件的方法
//都直接写到类里面了，像我们刚才说的如果打算用mySaxHandler来处理，下面的这些方法就是出现在
//mySaxHandler中的，当然我们的mySaxHandler也要extends DefaultHandler 。
//下面的一些方法都是DefaultHandler 中预先定义的，用来对应SAX的不同事件，关于DefaultHandler 都有
//哪些常用的方法见[DefaultHandler常用方法]


//startDocument方法是DefaultHandler 中的方法，SAX调用这个方法的时候，说明它已经开始处理一个文档
//因为我们这个程序的目的是打印一个完整的xml文件，所以在这里我们做添加xml文件头的工作
    public void startDocument()
    {
        displayText[numberLines] = indentation;
        displayText[numberLines] += ""1.0/" encoding=/""+
            "UTF-8" + "/"?>";
        numberLines++;
    }

//这个方法还没有搞明白！英文原文为：
//We can handle processing instructions by using the DefaultHandler processingInstruction method, 
//which is called automatically when the SAX parser finds a processing instruction. The target of 
//the processing instruction is passed to us, as is the data for the processing instruction, which
// means you can handle processing instructions like this

    public void processingInstruction(String target, String data)
    {
        displayText[numberLines] = indentation;
        displayText[numberLines] += ";
        displayText[numberLines] += target;
        if (data != null && data.length() > 0) {
            displayText[numberLines] += ' ';
            displayText[numberLines] += data;
        }
        displayText[numberLines] += "?>";
        numberLines++;
    }

//startElement是DefaultHandler 中的方法，到SAX遇到一个元素（节点）的时候会调用这个方法
//如遇到节点"oracle">，其中database是节点名，type="oracle"是节点属性
//该方法传递一些参数，这里我们关心的主要有qualifiedName（节点名称），attributes（节点的属性集合）
//如果我们要查找一个名字为database的节点，并处理它的属性值，只要if(qualifiedName=="database")
//就可以找到这个节点了
    public void startElement(String uri, String localName,
        String qualifiedName, Attributes attributes)
    {
        displayText[numberLines] = indentation;

        indentation += "    ";

        displayText[numberLines] += '<';
        displayText[numberLines] += qualifiedName;

//如果有属性，就传递一个attributes对象，我们解释这个对象，就可以得到所有的属性
//关于Attributes 的各种方法，见[Attributes的常用方法]
        if (attributes != null) {
            int numberAttributes = attributes.getLength();//调用这个方法得到属性的个数
            for (int loopIndex = 0; loopIndex < numberAttributes; loopIndex++){
                displayText[numberLines] += ' ';
                displayText[numberLines] += attributes.getQName(loopIndex);//调用这个方法得到属性名称
                displayText[numberLines] += "=/"";
                displayText[numberLines] += attributes.getValue(loopIndex);//调用这个方法得到属性值
                displayText[numberLines] += '"';
            }
        }
        displayText[numberLines] += '>';
        numberLines++;
    }

//当遇到Text类型的节点时，SAX会调用characters方法，什么是Text节点呢？
//如sa中sa就是Text类型的节点。

    public void characters(char characters[], int start, int length)
    {
        String characterData = (new?String(characters, start, length)).trim();
        if(characterData.indexOf("/n") < 0 && characterData.length() > 0) {
            displayText[numberLines] = indentation;
            displayText[numberLines] += characterData;
            numberLines++;
        }
    }

    public void ignorableWhitespace(char characters[], int start, int length)
    {
        //characters(characters, start, length);
    }

//遇到一个节点的结束，如
    public void endElement(String uri, String localName, String qualifiedName)
    {
        indentation = indentation.substring(0, indentation.length() - 4);
        displayText[numberLines] = indentation;
        displayText[numberLines] += ";
        displayText[numberLines] += qualifiedName;
        displayText[numberLines] += '>';
        numberLines++;
    }

//下面的三个方法处理Errors and Warnings，这个也是使用SAX的时候规定的，如果编写自己的
//saxHandler，也需要重载这三个方法。
    public void warning(SAXParseException exception)
    {
        System.err.println("Warning: " +
            exception.getMessage());
    }

    public void error(SAXParseException exception)
    {
        System.err.println("Error: " +
            exception.getMessage());
    }

    public void fatalError(SAXParseException exception)
    {
        System.err.println("Fatal error: " +
            exception.getMessage());
    }
}