Streaming API for XML

Streaming API for XML（StAX）は、JavaでXML文書を読み書きするためのAPIである。

従来のXML APIは、次のどちらかである。

これらはそれぞれに利点がある。前者（例えばDOM）は文書へのランダムアクセスが可能であり、後者（例えばSAX）は使用メモリが少なくより高速に動作する場合が多い。

この2つは対極に位置するアクセス手法であると言える。ツリーベースのAPIは制約のないランダムアクセスとデータの操作が可能である一方、イベントベースのAPIは文書を1回スキャンするだけである。

StAXは、その中間の手法として設計された。StAXの考え方では、プログラムの操作点は文書内のある地点を指すカーソルである。アプリケーションがカーソルを進めるということは、必要に応じて自分がパーサーから情報を取り出すことになる（pull型）。これはSAXのようなイベントベースのAPIとは異なる。SAXではパーサーがアプリケーションにデータを送りつけるので（push型）、アプリケーション側が文書内の位置を追跡しなければならない場合は必要に応じてイベントとイベントの間で状態を保持しておく必要がある。

起源

StAXは、互換性のない多数のpull型XML APIにその起源を持つ。これらAPIのうち最も有名なXMLPULLの作者（Stefan HausteinとAleksandr Slominski）と、その他のAPIの作者であるBEAシステムズやオラクル、サン、Breeze Factor、ジェームズ・クラークの協働により誕生した。

例

JSR-173の最終仕様、V1.0より（フェアユースに基づき使用）

以下、引用:

下記のJava APIは、カーソルの手法でXMLを読むための主要なメソッドである。
// Java 
public interface XMLStreamReader { 
  public int next() throws XMLStreamException; 
  public boolean hasNext() throws XMLStreamException; 
  public String getText(); 
  public String getLocalName(); 
  public String getNamespaceURI(); 
  // ...以下のメソッドは省略
}
書き込み用のAPIは、イベントベースのAPIにおける“StartElement”と“EndElement”に対応するメソッドを持っている。
// Java 
public interface XMLStreamWriter { 
  public void writeStartElement(String localName) throws XMLStreamException;
  public void writeEndElement() throws XMLStreamException; 
  public void writeCharacters(String text) throws XMLStreamException; 
  // ...以下のメソッドは省略
}
5.3.1 XMLStreamReader
この例では、InputFactoryをどのようにインスタンス化し、Readerを生成してXML文書中の要素を繰り返し処理するかを示す。
XMLInputFactory f = XMLInputFactory.newInstance(); 
XMLStreamReader r = f.createXMLStreamReader(... ); 
while (r.hasNext()) { 
    r.next(); 
}

実装

関連項目

JavaでXMLを構文解析するための他の方法としては、以下のものがある。