org.w3c.dom.ls
インタフェース LSInput

public interface LSInput

このインタフェースはデータの入力ソースを表します。

このインタフェースを使用すると、アプリケーションで、入力ソースに関する情報を単一のオブジェクトにカプセル化できます。 このオブジェクトには、公開識別子、システム識別子、バイトストリーム (エンコーディングが指定されている場合もある)、ベース URI、あるいは文字ストリームなどが含まれます。

バイトストリームと文字ストリームの正確な定義は、バインディングによって異なります。

アプリケーションは、前述のようなオブジェクトが必要なときはいつでも、このインタフェースを実装するオブジェクトを持つことが求められます。アプリケーションでは、このインタフェースを実装する独自のオブジェクトを備えたり、一般のファクトリメソッドの DOMImplementationLS.createLSInput() を使用したりして、このインタフェースを実装するオブジェクトを作成できます。

LSParser は、LSInput オブジェクトを使用して、データを読み取る方法を決定します。LSParser は、LSInput で指定された異なる入力を次の順に検索し、読み取る入力を認識します。 次に、null ではなくかつ空の文字列ではない最初の入力を使用します。

1. LSInput.characterStream
2. LSInput.byteStream
3. LSInput.stringData
4. LSInput.systemId
5. LSInput.publicId

入力がすべて null の場合、LSParser は 「no-input-specified」 に設定された DOMError.type と DOMError.SEVERITY_FATAL_ERROR に設定されたその DOMError.severity で DOMError を報告します。

アプリケーションに所属する LSInput オブジェクト。DOM 実装では、LSOutput オブジェクトを変更することはありません (必要に応じて、コピーを作成して変更することは可能)。

「Document Object Model (DOM) Level 3 Load and Save Specification」も参照してください。

メソッドの概要

String	getBaseURI() 相対 systemId を絶対 URI に対して解決するときに使用されるベース URI です (「IETF RFC 2396」のセクション 5.1.4 を参照)。
InputStream	getByteStream() 言語の属性およびバイトのストリームを表すバインディング依存の型です。
boolean	getCertifiedText() true に設定する場合、入力は解析時 (「XML 1.1」) に証明されることを前提とします (「XML 1.1」のセクション 2.13 を参照)。
Reader	getCharacterStream() 言語の属性および 16 ビット単位のストリームを表すバインディング依存の型です。
String	getEncoding() 既知の場合は、文字エンコーディングです。
String	getPublicId() この入力ソースの公開識別子です。
String	getStringData() 構文解析する文字列データです。
String	getSystemId() この入力ソースのシステム識別子、URI 参照「IETF RFC 2396」です。
void	setBaseURI(String baseURI) 相対 systemId を絶対 URI に対して解決するときに使用されるベース URI です (「IETF RFC 2396」のセクション 5.1.4 を参照)。
void	setByteStream(InputStream byteStream) 言語の属性およびバイトのストリームを表すバインディング依存の型です。
void	setCertifiedText(boolean certifiedText) true に設定する場合、入力は解析時 (「XML 1.1」) に証明されることを前提とします (「XML 1.1」のセクション 2.13 を参照)。
void	setCharacterStream(Reader characterStream) 言語の属性および 16 ビット単位のストリームを表すバインディング依存の型です。
void	setEncoding(String encoding) 既知の場合は、文字エンコーディングです。
void	setPublicId(String publicId) この入力ソースの公開識別子です。
void	setStringData(String stringData) 構文解析する文字列データです。
void	setSystemId(String systemId) この入力ソースのシステム識別子、URI 参照「IETF RFC 2396」です。

メソッドの詳細

getCharacterStream

Reader getCharacterStream()

言語の属性および 16 ビット単位のストリームを表すバインディング依存の型です。アプリケーションは、UTF-16 (「Unicode」、「ISO/IEC 10646」で定義されている) を使用するストリームを符号化する必要があります。文字ストリームを使用する場合、XML 宣言は必要ありません。XML 宣言が存在する場合、エンコーディング属性の値は無視されます。

setCharacterStream

void setCharacterStream(Reader characterStream)

言語の属性および 16 ビット単位のストリームを表すバインディング依存の型です。アプリケーションは、UTF-16 (「Unicode」、「ISO/IEC 10646」で定義されている) を使用するストリームを符号化する必要があります。文字ストリームを使用する場合、XML 宣言は必要ありません。XML 宣言が存在する場合、エンコーディング属性の値は無視されます。

getByteStream

InputStream getByteStream()

言語の属性およびバイトのストリームを表すバインディング依存の型です。
アプリケーションがバイトストリームの文字エンコーディングを認識している場合、アプリケーションではエンコーディング属性を設定する必要があります。データの XML 宣言で指定されているエンコーディングは、この方法によるエンコーディングの設定によりオーバーライドされます。

setByteStream

void setByteStream(InputStream byteStream)

言語の属性およびバイトのストリームを表すバインディング依存の型です。
アプリケーションがバイトストリームの文字エンコーディングを認識している場合、アプリケーションではエンコーディング属性を設定する必要があります。データの XML 宣言で指定されているエンコーディングは、この方法によるエンコーディングの設定によりオーバーライドされます。

getStringData

String getStringData()

構文解析する文字列データです。提供されている場合は、常に 16 ビット単位のシーケンス (UTF-16 で符号化された文字列) として処理されます。stringData を使用する場合、XML 宣言は必要ありません。XML 宣言が存在する場合、エンコーディング属性の値は無視されます。

setStringData

void setStringData(String stringData)

構文解析する文字列データです。提供されている場合は、常に 16 ビット単位のシーケンス (UTF-16 で符号化された文字列) として処理されます。stringData を使用する場合、XML 宣言は必要ありません。XML 宣言が存在する場合、エンコーディング属性の値は無視されます。

getSystemId

String getSystemId()

この入力ソースのシステム識別子、URI 参照「IETF RFC 2396」です。バイトストリーム、文字ストリーム、あるいは文字列データがある場合、システム識別子はオプションですが、アプリケーションはシステム識別子を使って相対 URI を解決し、エラーメッセージや警告に含めることができるので、システム識別子を持つと役に立ちます。LSParser は、入力ソースでほかの入力が利用できない場合のみ、URI 参照により識別したリソースを取得しようとします。
アプリケーションが、システム識別子でポイントされたオブジェクトの文字エンコーディングを認識している場合、アプリケーションは encoding 属性を使用してエンコーディングを設定できます。
指定されたシステム ID が相対 URI 参照 (「IETF RFC 2396」のセクション 5 を参照) である場合、DOM 実装は、基盤として baseURI を使用して相対 URI を解決しようとします。 これが失敗した場合、動作は実装依存です。

setSystemId

void setSystemId(String systemId)

この入力ソースのシステム識別子、URI 参照「IETF RFC 2396」です。バイトストリーム、文字ストリーム、あるいは文字列データがある場合、システム識別子はオプションですが、アプリケーションはシステム識別子を使って相対 URI を解決し、エラーメッセージや警告に含めることができるので、システム識別子を持つと役に立ちます。LSParser は、入力ソースでほかの入力が利用できない場合のみ、URI 参照により識別したリソースを取得しようとします。
アプリケーションが、システム識別子でポイントされたオブジェクトの文字エンコーディングを認識している場合、アプリケーションは encoding 属性を使用してエンコーディングを設定できます。
指定されたシステム ID が相対 URI 参照 (「IETF RFC 2396」のセクション 5 を参照) である場合、DOM 実装は、基盤として baseURI を使用して相対 URI を解決しようとします。 これが失敗した場合、動作は実装依存です。

getPublicId

String getPublicId()

この入力ソースの公開識別子です。この識別子は、実装依存のメカニズム (カタログやほかのマッピングなど) を使用して入力ソースにマップできます。指定された場合、エラー報告時の位置情報の一部として公開識別子を報告することもできます。

setPublicId

void setPublicId(String publicId)

この入力ソースの公開識別子です。この識別子は、実装依存のメカニズム (カタログやほかのマッピングなど) を使用して入力ソースにマップできます。指定された場合、エラー報告時の位置情報の一部として公開識別子を報告することもできます。

getBaseURI

String getBaseURI()

相対 systemId を絶対 URI に対して解決するときに使用されるベース URI です (「IETF RFC 2396」のセクション 5.1.4 を参照)。
使用したときに、ベース URI が相対 URI、空、文字列、または null である場合、動作は実装依存です。

setBaseURI

void setBaseURI(String baseURI)

相対 systemId を絶対 URI に対して解決するときに使用されるベース URI です (「IETF RFC 2396」のセクション 5.1.4 を参照)。
使用したときに、ベース URI が相対 URI 、空、文字列、または null である場合、動作は実装依存です。

getEncoding

String getEncoding()

既知の場合は、文字エンコーディングです。エンコーディングは、XML エンコーディング宣言 (「XML 1.0」セクション 4.3.3 「エンティティーの文字エンコーディング」) で受け入れ可能な文字列にする必要があります。
この属性は、アプリケーションが文字ストリームや文字列データを提供する場合、何も影響を与えません。ほかの入力ソースの場合、XML 宣言やテキスト宣言、あるいは HTTP 「IETF RFC 2616」といった高位レベルのプロトコルから取得されたエンコーディングは、この属性を使用して指定されたエンコーディングによりオーバーライドされます。

setEncoding

void setEncoding(String encoding)

既知の場合は、文字エンコーディングです。エンコーディングは、XML エンコーディング宣言 (「XML 1.0」セクション 4.3.3 「エンティティーの文字エンコーディング」) で受け入れ可能な文字列にする必要があります。
この属性は、アプリケーションが文字ストリームや文字列データを提供する場合、何も影響を与えません。ほかの入力ソースの場合、XML 宣言やテキスト宣言、あるいは HTTP 「IETF RFC 2616」といった高位レベルのプロトコルから取得されたエンコーディングは、この属性を使用して指定されたエンコーディングによりオーバーライドされます。

getCertifiedText

boolean getCertifiedText()

true に設定する場合、入力は解析時 (「XML 1.1」) に証明されることを前提とします (「XML 1.1」のセクション 2.13 を参照)。

setCertifiedText

void setCertifiedText(boolean certifiedText)

true に設定する場合、入力は解析時 (「XML 1.1」) に証明されることを前提とします (「XML 1.1」のセクション 2.13 を参照)。