6.8.11 XBRLTaxonomyComplexTypeDefinitionインターフェース

public interface XBRLTaxonomyComplexTypeDefinition
extends XBRLTaxonomyTypeDefinition

XBRLのバージョン:
2.1
説明:
complexTypeの型定義を表します。
フィールドの概要:
XBRLTaxonomyComplexTypeDefinitionインターフェースのフィールドの概要を次の表に示します。

表6-100 XBRL XBRLTaxonomyComplexTypeDefinitionインターフェースのフィールドの概要

項番説明
1static intCOMPOSITOR_ALL
  モデルグループallを示します。
2static intCOMPOSITOR_CHOICE
  モデルグループchoiceを示します。
3static intCOMPOSITOR_SEQUENCE
  モデルグループsequenceを示します。
4static intCOMPOSITOR_NONE
  モデルグループが存在しないことを示します。
メソッドの概要:
XBRLTaxonomyComplexTypeDefinitionインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョン
1booleangetAbstract()
  型定義のabstract属性の値を取得します。
2.1
2intgetBlock()
  型定義のblock属性の値を表すコードを取得します。
2.1
3intgetCompositor()
  型定義のモデルグループを表すコードを取得します。
2.1
4java.util.List<XBRLTaxonomyElement>getElements()
  型定義の要素宣言のリストを取得します。
2.1
5java.util.List<XBRLTaxonomyAttributeDeclaration>getTaxonomyAttributeDeclarations()
  型定義の属性宣言のリストを取得します。
2.1
6XBRLTaxonomyAttributeDeclarationgetTaxonomyAttributeDeclaration(java.lang.String namespaceURI, java.lang.String name)
  指定された名前を持つ属性宣言を取得します。
2.1
7java.util.List<org.w3c.dom.Node>getElementDeclarationsW3CDOMNode()
  型定義の要素宣言に対応するorg.w3c.dom.Nodeオブジェクトのリストを取得します。
2.1
8intgetDerivationMethod()
  型定義の派生方法を表すコードを取得します。
2.1
<この項の構成>
(1) getAbstract
(2) getBlock
(3) getCompositor
(4) getElements
(5) getTaxonomyAttributeDeclarations
(6) getTaxonomyAttributeDeclaration
(7) getElementDeclarationsW3CDOMNode
(8) getDerivationMethod

(1) getAbstract

public boolean getAbstract()

XBRLのバージョン:
2.1
説明:
型定義のabstract属性の値を取得します。
戻り値:
この型定義のabstract属性の値を返します。この型定義にabstract属性がない場合は,名前空間” http://www.w3.org/2001/XMLSchema”に属するcomplexTypeの定義のデフォルト値が返ります。

(2) getBlock

public int getBlock()

XBRLのバージョン:
2.1
説明:
型定義のblock属性の値を表すコードを取得します。
戻り値:
この型定義のblock属性の値を表すコードを返します。block属性の指定がなく,<xsd:schema>要素のblockDefault属性の指定がある場合は,blockDefault属性の値を表すコードを返します。
値はXBRLTaxonomyTypeDefinition.DERIVATION_NONE,またはXBRLTaxonomyTypeDefinition.DERIVATION_EXTENSION,XBRLTaxonomyTypeDefinition.DERIVATION_RESTRICTIONの組み合わせによる論理和です(単一の場合も含みます)。#allを指定した場合は,XBRLTaxonomyTypeDefinition.DERIVATION_EXTENSION,XBRLTaxonomyTypeDefinition.DERIVATION_RESTRICTIONの論理和です。

(3) getCompositor

public int getCompositor()

XBRLのバージョン:
2.1
説明:
型定義のモデルグループを表すコードを取得します。対象となるモデルグループは,以下のいずれかの条件に該当する<xsd:all>要素,<xsd:choice>要素,<xsd:sequence>要素,<xsd:group>要素が参照するモデルグループです。
  • <xsd:complexType>要素の第1子孫
  • <xsd:complexContent>要素の第1子孫の<xsd:restriction>の第1子孫
  • <xsd:complexContent>要素の第1子孫の<xsd:extension>の第1子孫
戻り値:
この型定義のモデルグループを表すコードを返します。<xsd:all>要素,<xsd:choice>要素,<xsd:sequence>要素,モデルグループが存在しないことのいずれかを表すコードとなります。

(4) getElements

public java.util.List<XBRLTaxonomyElement> getElements()

XBRLのバージョン:
2.1
説明:
型定義の要素宣言のリストを取得します。リストの各要素は,XBRLTaxonomyElementへキャストすることができます。
このメソッドが返すリストには,以下のいずれかの条件に該当する<xsd:all>要素,<xsd:choice>要素,<xsd:sequence>要素,<xsd:group>要素が参照するモデルグループの第1子孫である要素宣言のref属性で指定された大域要素宣言のみが含まれます。
  • <xsd:complexType>要素の第1子孫
  • <xsd:complexContent>要素の第1子孫の<xsd:restriction>の第1子孫
  • <xsd:complexContent>要素の第1子孫の<xsd:extension>の第1子孫
また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
この型定義の要素宣言のリストを返します。説明に記載されている条件に該当する要素宣言が存在しない場合は,要素数が0のリストを返します。

(5) getTaxonomyAttributeDeclarations

public java.util.List<XBRLTaxonomyAttributeDeclaration> getTaxonomyAttributeDeclarations()

XBRLのバージョン:
2.1
説明:
型定義の属性宣言のリストを取得します。リストの各要素は,XBRLTaxonomyAttributeDeclarationへキャストすることができます。
このメソッドが返すリストには,base属性に指定された型定義の属性宣言は含まれません。また,<xsd:attributeGroup>要素により参照される属性宣言も含まれません。
また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
この型定義の属性宣言のリストを返します。この型定義に属性宣言が存在しない場合は,要素数が0のリストを返します。

(6) getTaxonomyAttributeDeclaration

public XBRLTaxonomyAttributeDeclaration getTaxonomyAttributeDeclaration(java.lang.String namespaceURI,java.lang.String name)

XBRLのバージョン:
2.1
説明:
指定された名前を持つ属性宣言を取得します。base属性に指定された型定義の属性宣言は取得できません。また,<xsd:attributeGroup>要素により参照される属性宣言も取得できません。
引数:
namespaceURI -属性宣言の名前空間URIを指定します。局所の属性宣言を取得する場合はnullを指定します。
name -属性宣言の名前を指定します。
戻り値:
引数namespaceURIがnullでない場合は,引数namespaceURIで指定された名前空間URIに属し,引数nameで指定された名前を持つ大域の属性宣言の参照を表すXBRLTaxonomyAttributeDeclarationオブジェクトを返します。引数namespaceURIがnullの場合は,引数nameで指定された名前を持つ局所の属性宣言を表すXBRLTaxonomyAttributeDeclarationオブジェクトを返します。指定された名前を持つ属性宣言が存在しない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 引数nameにnullを指定した場合にスローされます。[エラーコード:20002]

(7) getElementDeclarationsW3CDOMNode

public java.util.List<org.w3c.dom.Node> getElementDeclarationsW3CDOMNode()

XBRLのバージョン:
2.1
説明:
型定義の要素宣言に対応するorg.w3c.dom.Nodeオブジェクトのリストを取得します。
このメソッドが返すリストには,以下のいずれかの条件に該当する<xsd:all>要素,<xsd:choice>要素,<xsd:sequence>要素の第1子孫である要素宣言に対応するorg.w3c.dom.Nodeオブジェクトのみが含まれます。
  • <xsd:complexType>要素の第1子孫
  • <xsd:complexContent>要素の第1子孫の<xsd:restriction>の第1子孫
  • <xsd:complexContent>要素の第1子孫の<xsd:extension>の第1子孫
なお,<xsd:group>要素で指定されたモデルグループの要素宣言に対応するorg.w3c.dom.Nodeオブジェクトは含まれません。
また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
この型定義の要素宣言に対応するorg.w3c.dom.Nodeオブジェクトのリストを返します。説明に記載されている条件に該当する要素宣言が存在しない場合は,要素数が0のリストを返します。

(8) getDerivationMethod

public int getDerivationMethod()

XBRLのバージョン:
2.1
説明:
型定義の派生方法を表すコードを取得します。
戻り値:
この型定義の派生方法を表すコードを返します。値はXBRLTaxonomyTypeDefinition.DERIVATION_EXTENSION,またはXBRLTaxonomyTypeDefinition.DERIVATION_RESTRICTIONです。この型定義に<xsd:restriction> 要素も<xsd:extension> 要素も存在しない場合は,XBRLTaxonomyTypeDefinition.DERIVATION_RESTRICTIONを返します。