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

既知のサブインタフェースの一覧:

Attributes2

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

Attributes2Impl, AttributesImpl

public interface Attributes

XML 属性のリストのためのインタフェースです。

このモジュールは、ソースコード、文書ともに公開ドメインに置かれています。したがって、内容に関する保証は一切提供されません。詳細は、http://www.saxproject.org を参照してください。

このインタフェースは、3 通りの方法で属性リストへのアクセスを提供します。

1. 属性インデックスを使用する方法
2. 名前空間修飾名を使用する方法
3. 接頭辞付きの修飾名を使用する方法

#IMPLIED と宣言されていても開始タグ内に指定されていない属性は、リストには含まれません。また、名前空間宣言 (xmlns*) として使用される属性も、http://xml.org/sax/features/namespace-prefixes 機能の値を true に設定しないかぎりリストには含まれません (デフォルト値は false)。SAX2 は最初の 「Namespaces in XML」勧告に従うため、通常は名前空間宣言属性に名前空間 URI は与えられません。

SAX2 パーサによっては、オプションで機能フラグ (http://xml.org/sax/features/xmlns-uris) を使用するようにサポートし、SAX2 パーサの属性を URI に与えるように要求して下位互換できない最初の勧告の今後の改訂版に合わせるものもあります。(デフォルトによる要素名前空間を定義する場合の属性の「ローカル名」は接頭辞または「xmls」)。互換性に関しては、ハンドラコードが機能フラグの設定を変更できるパーサを要求するのではなく、常にそのコンフリクトを解決するようにする必要があります。

名前空間接頭辞の機能 (前述を参照) が false の場合、指定された名前によってアクセスできない場合があります。http://xml.org/sax/features/namespaces 機能が false の場合、名前空間修飾名によってアクセスできない場合があります。

このインタフェースは現在は非推奨に指定されている SAX1 の AttributeList インタフェースに代わるインタフェースです。このインタフェースには、SAX1 の AttributeList インタフェースではサポートされていなかった名前空間機能のほか、以下の getIndex メソッドが追加されています。

リスト内の属性の順序は未指定であり、実装ごとに異なります。

導入されたバージョン:

SAX 2.0

関連項目:

AttributesImpl, DeclHandler.attributeDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

メソッドの概要

int	getIndex(String qName) XML 修飾名 (接頭辞付き) を指定して属性のインデックスを検索します。
int	getIndex(String uri, String localName) 名前空間名を指定して属性のインデックスを検索します。
int	getLength() リスト内にある属性の数を返します。
String	getLocalName(int index) インデックスを指定して属性のローカル名を検索します。
String	getQName(int index) インデックスを指定して属性の XML 修飾名 (接頭辞付き) を検索します。
String	getType(int index) インデックスを指定して属性の型を検索します。
String	getType(String qName) XML 修飾名 (接頭辞付き) を指定して属性の型を検索します。
String	getType(String uri, String localName) 名前空間名を指定して属性の型を検索します。
String	getURI(int index) インデックスを指定して属性の名前空間 URI を検索します。
String	getValue(int index) インデックスを指定して属性の値を検索します。
String	getValue(String qName) XML 修飾名 (接頭辞付き) を指定して属性の値を検索します。
String	getValue(String uri, String localName) 名前空間名を指定して属性の値を検索します。

メソッドの詳細

getLength

int getLength()

リスト内にある属性の数を返します。

属性の数が特定されたら、このリストで繰り返し処理を行うことができます。

戻り値:

リスト内の属性の数

関連項目:

getURI(int), getLocalName(int), getQName(int), getType(int), getValue(int)

getURI

String getURI(int index)

インデックスを指定して属性の名前空間 URI を検索します。

パラメータ:

index - 属性インデックス (ゼロから始まる)

戻り値:

名前空間 URI。使用可能な名前空間 URI が存在しない場合は空文字列。インデックスが範囲外の場合は null

関連項目:

getLength()

getLocalName

String getLocalName(int index)

インデックスを指定して属性のローカル名を検索します。

パラメータ:

index - 属性インデックス (ゼロから始まる)

戻り値:

ローカル名。名前空間処理が実行されない場合は空文字列。インデックスが範囲外の場合は null

関連項目:

getLength()

getQName

String getQName(int index)

インデックスを指定して属性の XML 修飾名 (接頭辞付き) を検索します。

パラメータ:

index - 属性インデックス (ゼロから始まる)

戻り値:

XML 修飾名。使用可能な XML 修飾名が存在しない場合は空文字列。インデックスが範囲外の場合は null

関連項目:

getLength()

getType

String getType(int index)

インデックスを指定して属性の型を検索します。

属性型は、「CDATA」、「ID」、「IDREF」、「IDREFS」、「NMTOKEN」、「NMTOKENS」、「ENTITY」、「ENTITIES」、「NOTATION」のどれか 1 つになります (常に大文字を使用)。

パーサが属性の宣言を読み取らず、属性型を報告しない場合、XML 1.0 勧告 (3.3.3「属性値の正規化」) に従って、値「CDATA」が返されます。

表記法以外の列挙型属性の型は「NMTOKEN」と報告されます。

パラメータ:

index - 属性インデックス (ゼロから始まる)

戻り値:

属性型を示す文字列。インデックスが範囲外の場合は null

関連項目:

getLength()

getValue

String getValue(int index)

インデックスを指定して属性の値を検索します。

属性値が IDREFS、ENTITIES、NMTOKENS のどれかのトークンのリストである場合、トークンは空白文字で区切られた単一の文字列に連結されます。

パラメータ:

index - 属性インデックス (ゼロから始まる)

戻り値:

属性値を示す文字列。インデックスが範囲外の場合は null

関連項目:

getLength()

getIndex

int getIndex(String uri,
             String localName)

名前空間名を指定して属性のインデックスを検索します。

パラメータ:

uri - 名前空間 URI。名前が名前空間 URI を持たない場合は空文字列

localName - 属性のローカル名

戻り値:

属性インデックス。リスト内に存在しない場合は -1

getIndex

int getIndex(String qName)

XML 修飾名 (接頭辞付き) を指定して属性のインデックスを検索します。

パラメータ:

qName - 接頭辞付きの修飾名

戻り値:

属性インデックス。リスト内に存在しない場合は -1

getType

String getType(String uri,
               String localName)

名前空間名を指定して属性の型を検索します。

使用可能な型については、getType(int) の説明を参照してください。

パラメータ:

uri - 名前空間 URI。名前が名前空間 URI を持たない場合は空文字列

localName - 属性のローカル名

戻り値:

属性型を示す文字列。属性がリスト内に存在しない場合、または名前空間処理が実行されない場合は null

getType

String getType(String qName)

XML 修飾名 (接頭辞付き) を指定して属性の型を検索します。

使用可能な型については、getType(int) の説明を参照してください。

パラメータ:

qName - XML 修飾名

戻り値:

属性型を示す文字列。属性がリスト内に存在しない場合、または修飾名を使用できない場合は null

getValue

String getValue(String uri,
                String localName)

名前空間名を指定して属性の値を検索します。

使用可能な値については、getValue(int) の説明を参照してください。

パラメータ:

uri - 名前空間 URI。名前が名前空間 URI を持たない場合は空文字列

localName - 属性のローカル名

戻り値:

属性値を示す文字列。属性がリスト内に存在しない場合は null

getValue

String getValue(String qName)

XML 修飾名 (接頭辞付き) を指定して属性の値を検索します。

使用可能な値については、getValue(int) の説明を参照してください。

パラメータ:

qName - XML 修飾名

戻り値:

属性値を示す文字列。属性がリスト内に存在しない場合、または修飾名を使用できない場合は null