Locator (Java 2 プラットフォーム SE v1.4.0)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM 2
Platform
Std. Ed. v1.4.0

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

org.xml.sax
インタフェース Locator

既知の実装クラスの一覧:: LocatorImpl

public interface Locator

SAX イベントと文書の位置を関連付けるためのインタフェースです。

このモジュールは、ソースコード、文書ともに公開ドメインに置かれています。したがって、内容に関する保証は一切提供されません。

SAX パーサは、このインタフェースを実装し、コンテンツハンドラの setDocumentLocator メソッドを使ってインスタンスを渡すことにより、SAX アプリケーションに位置情報を提供します。SAX アプリケーションは、このオブジェクトを使って XML ソース文書内のその他のコンテンツハンドライベントの位置を突き止めることができます。

オブジェクトによって返される結果は、各コンテンツハンドラメソッドのスコープ内でだけ有効です。このスコープ外でロケータを使用しようとすると、アプリケーションに予想外の影響が及びます。

SAX パーサにロケータを提供させるのは必須条件ではありませんが、そうすることを強くお勧めします。この場合、SAX パーサは、その他の文書イベントを報告する前にロケータを提供する必要があります。アプリケーションが startDocument イベントを受け取る前にロケータを設定しておかないと、アプリケーションはロケータを利用できないと判断します。

@since SAX 1.0

関連項目:: ContentHandler.setDocumentLocator(org.xml.sax.Locator)

メソッドの概要

int getColumnNumber()
          現在の文書イベントが終了する列番号を返します。

int getLineNumber()
          現在の文書イベントが終了する行番号を返します。

String getPublicId()
          現在の文書イベントの公開識別子を返します。

String getSystemId()
          現在の文書イベントのシステム識別子を返します。

メソッドの詳細

getPublicId

public String getPublicId()

現在の文書イベントの公開識別子を返します。

戻り値は、文書エンティティの公開識別子か、イベントをトリガするマークアップを含む外部の構文解析済みエンティティの公開識別子です。

戻り値:: 公開識別子を含む文字列。使用できない場合は null
関連項目:: getSystemId()

getSystemId

public String getSystemId()

現在の文書イベントのシステム識別子を返します。

戻り値は、文書エンティティのシステム識別子か、イベントをトリガするマークアップを含む外部の構文解析済みエンティティのシステム識別子です。

システム識別子が URL の場合、パーサはこれをアプリケーションに渡す前に完全に解決する必要があります。

戻り値:: システム識別子を含む文字列。使用できない場合は null
関連項目:: getPublicId()

getLineNumber

public int getLineNumber()

現在の文書イベントが終了する行番号を返します。

警告: このメソッドの戻り値は、エラー報告で使用される近似値に過ぎません。この情報は、元の XML 文書の文字コンテンツを編集するには不十分です。

戻り値は、文書エンティティの行番号の近似値か、イベントをトリガするマークアップを含む外部の構文解析済みエンティティの行番号の近似値です。

SAX ドライバは、文書イベントに関連付けられたテキストの直後にある、最初の文字を含む行の位置を返そうとします。なお、1 行目は文書の先頭行です。

戻り値:: 行番号。使用できない場合は -1
関連項目:: getColumnNumber()

getColumnNumber

public int getColumnNumber()

現在の文書イベントが終了する列番号を返します。

戻り値は、文書エンティティの列番号の近似値か、イベントをトリガするマークアップを含む外部の構文解析済みエンティティの列番号の近似値です。

SAX ドライバは、文書イベントに関連付けられたテキストの直後にある、最初の文字を含む行の位置を返そうとします。なお、各行の最初の列が 1 列目になります。

戻り値:: 列番号。使用できない場合は -1
関連項目:: getLineNumber()

概要