6.8.10 XBRLTaxonomyBodyインターフェース

public interface XBRLTaxonomyBody
extends XBRLTaxonomyComponent

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書を構成するXML文書の一つであるタクソノミー本体を表します。
メソッドの概要:
XBRLTaxonomyBodyインターフェースのメソッドの概要を次の表に示します。

表6-99 XBRLTaxonomyBodyインターフェースのメソッドの概要

項番説明XBRLのバージョン
1java.lang.StringgetTargetNamespaceURI()
  タクソノミー本体の対象名前空間URIを取得します。
2.0および2.1
2java.lang.StringgetElementFormDefault()
  タクソノミー本体のelementFormDefault属性の値を取得します。
2.1
3java.lang.StringgetAttributeFormDefault()
  タクソノミー本体のattributeFormDefault属性の値を取得します。
2.1
4java.util.List<XBRLTaxonomyBody>getImportBodies()
  タクソノミー本体で<xsd:import>要素によりインポートするタクソノミー本体を取得します。
2.1
5java.util.List<XBRLTaxonomyBody>getIncludeBodies()
  タクソノミー本体で<xsd:include>要素によりインクルードするタクソノミー本体を取得します。
2.1
<この項の構成>
(1) getTargetNamespaceURI
(2) getElementFormDefault
(3) getAttributeFormDefault
(4) getImportBodies
(5) getIncludeBodies

(1) getTargetNamespaceURI

public java.lang.String getTargetNamespaceURI()

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー本体の対象名前空間URIを取得します。対象名前空間URIは,<xsd:schema>要素のtargetNamespace属性の値です。
戻り値:
このタクソノミー本体の対象名前空間URIを返します。

(2) getElementFormDefault

public java.lang.String getElementFormDefault()

XBRLのバージョン:
2.1
説明:
タクソノミー本体のelementFormDefault属性の値を取得します。
タクソノミー文書の解析時に妥当性の検証を行うように設定されている場合は,このメソッドによりnullが返ることはありません。名前空間” http://www.w3.org/2001/XMLSchema”に属するschemaの定義のデフォルト値が返ります。
戻り値:
このタクソノミー本体のelementFormDefault属性の値(“qualified”または“unqualified”)を返します。妥当性の検証を行わない場合で,かつこのタクソノミー本体にelementFormDefault属性がない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • cbrp.parse.validate.frtafrisオプションがfalseに設定されている場合にスローされます。[エラーコード:22011]

(3) getAttributeFormDefault

public java.lang.String getAttributeFormDefault()

XBRLのバージョン:
2.1
説明:
タクソノミー本体のattributeFormDefault属性の値を取得します。
タクソノミー文書の解析時に妥当性の検証を行うように設定されている場合は,このメソッドによりnullが返ることはありません。名前空間” http://www.w3.org/2001/XMLSchema”に属するschemaの定義のデフォルト値が返ります。
戻り値:
このタクソノミー本体のattributeFormDefault属性の値(“qualified”または“unqualified”)を返します。妥当性の検証を行わない場合で,かつこのタクソノミー本体にattributeFormDefault属性がない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • cbrp.parse.validate.frtafrisオプションがfalseに設定されている場合にスローされます。[エラーコード:22011]

(4) getImportBodies

public java.util.List<XBRLTaxonomyBody> getImportBodies()

XBRLのバージョン:
2.1
説明:
タクソノミー本体で<xsd:import>要素によりインポートするタクソノミー本体を取得します。リストの各要素は,XBRLTaxonomyBodyへキャストすることができます。
このメソッドが返すリストには,既知のスキーマ,およびcbrp.parse.DTS.ignoringSchemasプロパティで指定したスキーマは含まれません。
また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
継承関係がループになっているタクソノミー本体での本メソッドの呼び出しには注意してください。例えば,本メソッドで取得したタクソノミー本体に対して本メソッドを呼び出すような回帰的な処理では無限ループを引き起こす可能性があるため,注意してください。
戻り値:
このタクソノミー本体で<xsd:import>要素によりインポートするタクソノミー本体のリストを返します。このタクソノミー本体にxsd:import要素が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • cbrp.parse.validate.frtafrisオプションがfalseに設定されている場合にスローされます。[エラーコード:22011]

(5) getIncludeBodies

public java.util.List<XBRLTaxonomyBody> getIncludeBodies()

XBRLのバージョン:
2.1
説明:
タクソノミー本体で<xsd:include>要素によりインクルードするタクソノミー本体を取得します。リストの各要素は,XBRLTaxonomyBodyへキャストすることができます。
また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
継承関係がループになっているタクソノミー本体での本メソッドの呼び出しには注意してください。例えば,本メソッドで取得したタクソノミー本体に対して本メソッドを呼び出すような回帰的な処理では無限ループを引き起こす可能性があるため,注意してください。
戻り値:
このタクソノミー本体で<xsd: include>要素によりインクルードするタクソノミー本体のリストを返します。このタクソノミー本体に<xsd: include>要素が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • cbrp.parse.validate.frtafrisオプションがfalseに設定されている場合にスローされます。[エラーコード:22011]