6.8.13 XBRLTaxonomyDocumentインターフェース

public interface XBRLTaxonomyDocument
extends XBRLTaxonomyNode

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書全体を表します。
メソッドの概要:
XBRLTaxonomyDocumentインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョンXBRL Dimensionsのバージョン
1XBRLDocumentManagergetOwnerDocumentManager()
  タクソノミー文書を所有するXBRLDocumentManagerオブジェクトを取得します。
2.0および2.1該当しない
2intgetXBRLVersion()
  タクソノミー文書が準拠するXBRLバージョンを取得します。
2.0および2.1該当しない
3PTVLinkbasegetPTVLinkbase()
  タクソノミー文書の解析時に生成されたPTVLIを取得します。
2.1該当しない
4java.util.List<XBRLTaxonomyComponent>getTaxonomyComponents()
  タクソノミー文書を構成するXML文書のリストを取得します。
2.0および2.1該当しない
5java.util.List<XBRLTaxonomyBody>getTaxonomyBodies()
  タクソノミー文書を構成するタクソノミー本体のリストを取得します。
2.0および2.1該当しない
6XBRLTaxonomyBodygetTaxonomyBody(java.lang.String targetNamespaceURI)
  タクソノミー文書を構成するタクソノミー本体のうち,指定した名前空間URIを持つタクソノミー本体を取得します。
2.0該当しない
7java.util.List<XBRLLinkbase>getLinkbases()
  タクソノミー文書を構成するリンクベースのリストを取得します。
2.0および2.1該当しない
8java.util.List<XBRLTaxonomyComponent>getStartingPoints()
  タクソノミー文書を構成する際の出発点となったタクソノミー本体およびリンクベースのリストを取得します。
2.1該当しない
9java.util.List<XBRLTaxonomyElement>getElements()
  タクソノミー文書に記述されている要素の要素宣言のリストを取得します。
2.0および2.1該当しない
10XBRLTaxonomyElementgetElement(java.lang.String namespaceURI, java.lang.String name)
  指定した名前の要素の要素宣言を取得します。
2.0および2.1該当しない
11java.util.List<XBRLRoleType>getRoleTypes()
  タクソノミー文書に記述されている<link:roleType>要素のリストを取得します。
2.1該当しない
12java.util.List<XBRLRoleType>getRoleTypes(java.lang.String roleURI)
  タクソノミー文書に記述されている<link:roleType>要素のうち,指定した値のカスタムロールを定義している<link:roleType>要素のリストを取得します。
2.1該当しない
13java.util.List<XBRLArcroleType>getArcroleTypes()
  タクソノミー文書に記述されている<link:arcroleType>要素のリストを取得します。
2.1該当しない
14java.util.List<XBRLArcroleType>getArcroleTypes(java.lang.String arcroleURI)
  タクソノミー文書に記述されている<link:arcroleType>要素のうち,指定した値のカスタムアークロールを定義している<link:arcroleType>要素のリストを取得します。
2.1該当しない
15java.util.List<XBRLLabel>getLabels()
  タクソノミー文書に記述されているラベルのリストを取得します。
2.0および2.1該当しない
16java.util.List<XBRLLabel>getLabelsByLang(java.lang.String lang)
  タクソノミー文書に記述されているラベルのうち,指定した言語のラベルのリストを取得します。
2.0および2.1該当しない
17java.util.List<XBRLLabel>getLabelsByRole(java.lang.String role)
  タクソノミー文書に記述されているラベルのうち,指定したロールを持つラベルのリストを取得します。
2.0および2.1該当しない
18java.util.List<XBRLLabel>getLabels(java.lang.String lang, java.lang.String role)
  タクソノミー文書に記述されているラベルのうち,指定した言語およびロールを持つラベルのリストを取得します。
2.0および2.1該当しない
19java.util.List<XBRLReference>getReferences()
  タクソノミー文書に記述されている文献への参照のリストを取得します。
2.0および2.1該当しない
20java.util.List<XBRLReference>getReferences(java.lang.String role)
  タクソノミー文書に記述されている文献への参照のうち,指定したロールを持つ文献への参照のリストを取得します。
2.0および2.1該当しない
21XBRLTaxonomyElement[]findCalculationRootElements(java.lang.String extendedLinkRole, java.lang.String arcrole)
  計算リンクで定義された関係のネットワークでルートとなる要素宣言を検索します。
2.1該当しない
22XBRLTaxonomyElement[]findDefinitionRootElements(java.lang.String extendedLinkRole, java.lang.String arcrole)
  定義リンクで定義された関係のネットワークでルートとなる要素宣言を検索します。
2.1該当しない
23XBRLTaxonomyElement[]findPresentationRootElements(java.lang.String extendedLinkRole, java.lang.String arcrole)
  プレゼンテーションリンクで定義された関係のネットワークでルートとなる要素宣言を検索します。
2.1該当しない
24java.util.List<XBRLNamespaceDeclaration>getNamespaceDeclarations()
  タクソノミー文書に記述されている名前空間宣言のリストを取得します。
2.1該当しない
25java.util.List<XBRLTaxonomyLinkbaseRef>getLinkbaseRefs()
  タクソノミー文書に存在する<link:linkbaseRef>要素のリストを取得します。
2.1該当しない
26java.util.List<XBRLTaxonomyRoleRef>getRoleRefs()
  タクソノミー文書に存在する<link:roleRef>要素のリストを取得します。
2.1該当しない
27java.util.List<XBRLTaxonomyTypeDefinition>getTaxonomyTypeDefinitions()
  タクソノミー文書で定義された型定義のリストを取得します。
2.1該当しない
28java.util.List<XBRLNamespaceDeclaration>getNamespaceDeclarationsByPrefix(java.lang.String prefix)
  タクソノミー文書で定義される名前空間宣言のうち,引数で指定した名前空間接頭辞の名前空間宣言のリストを取得します。
2.1該当しない
29java.util.List<XBRLNamespaceDeclaration>getNamespaceDeclarationsByURI(java.lang.String uri)
  タクソノミー文書で定義される名前空間宣言のうち,引数で指定した名前空間URIの名前空間宣言のリストを取得します。
2.1該当しない
30XBRLTaxonomyTypeDefinitiongetTaxonomyTypeDefinition(java.lang.String namespaceURI, java.lang.String name)
  引数で指定した名前の型定義を取得します。
2.1該当しない
31java.util.List<XBRLDimensionalRelationshipSet>getDimensionalRelationshipSets()
  タクソノミー文書で定義されるDRSのリストを取得します。
2.11.0
32intgetDimensionsVersion()
  タクソノミー文書が準拠しているXBRL Dimensionsのバージョンを取得します。
2.1該当しない
<この項の構成>
(1) getOwnerDocumentManager
(2) getXBRLVersion
(3) getPTVLinkbase
(4) getTaxonomyComponents
(5) getTaxonomyBodies
(6) getTaxonomyBody
(7) getLinkbases
(8) getStartingPoints
(9) getElements
(10) getElement
(11) getRoleTypes
(12) getRoleTypes
(13) getArcroleTypes
(14) getArcroleTypes
(15) getLabels
(16) getLabelsByLang
(17) getLabelsByRole
(18) getLabels
(19) getReferences
(20) getReferences
(21) findCalculationRootElements
(22) findDefinitionRootElements
(23) findPresentationRootElements
(24) getNamespaceDeclarations
(25) getLinkbaseRefs
(26) getRoleRefs
(27) getTaxonomyTypeDefinitions
(28) getNamespaceDeclarationsByPrefix
(29) getNamespaceDeclarationsByURI
(30) getTaxonomyTypeDefinition
(31) getDimensionalRelationshipSets
(32) getDimensionsVersion

(1) getOwnerDocumentManager

public XBRLDocumentManager getOwnerDocumentManager()

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書を所有するXBRLDocumentManagerオブジェクトを取得します。
戻り値:
このタクソノミー文書を所有するXBRLDocumentManagerオブジェクトを返します。

(2) getXBRLVersion

public int getXBRLVersion()

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書が準拠するXBRLバージョンを取得します。
戻り値:
このタクソノミー文書がXBRL2.0に準拠している場合はXBRLConstants.XBRL_2_0,XBRL2.1に準拠している場合はXBRLConstants.XBRL_2_1を返します。

(3) getPTVLinkbase

public PTVLinkbase getPTVLinkbase()

XBRLのバージョン:
2.1
説明:
タクソノミー文書の解析時に生成されたPTVLIを取得します。
タクソノミー文書を解析する際に完全な妥当性検証を実施した場合は,このメソッドによってPTVLIを取得できます。完全な妥当性検証が実施されていない場合は,PTVLIは生成されていないため,このメソッドでのPTVLIの取得はできません。完全な妥当性検証およびPTVLIの詳細については,「2.9 PTVLIの生成(XBRL2.1の場合)」を参照してください。
このメソッドが返すPTVLIはタクソノミー文書の解析時に生成されたもので,その後は変更されません。そのため,タクソノミー文書を参照しているインスタンス文書に<link:linkbaseRef>要素などを追加することでタクソノミー文書の内容を変更しても,その変更はPTVLIに反映されません。
戻り値:
タクソノミー文書の解析時に生成されたPTVLIを表すPTVLinkbaseオブジェクトを返します。PTVLIが生成されていない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(4) getTaxonomyComponents

public java.util.List<XBRLTaxonomyComponent> getTaxonomyComponents()

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書を構成するXML文書のリストを取得します。タクソノミー文書を構成するXML文書は,タクソノミー本体またはリンクベースです。
このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLTaxonomyComponentオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このタクソノミー文書を構成するXML文書を表すXBRLTaxonomyComponentオブジェクトのリストを返します。

(5) getTaxonomyBodies

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

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書を構成するタクソノミー本体のリストを取得します。
XBRL2.1の場合:このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLTaxonomyBodyオブジェクトに増減があった場合,その変更は直ちに反映されます。
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このタクソノミー文書を構成するタクソノミー本体を表すXBRLTaxonomyBodyオブジェクトのリストを返します。

(6) getTaxonomyBody

public XBRLTaxonomyBody getTaxonomyBody(java.lang.String targetNamespaceURI)

XBRLのバージョン:
2.0
説明:
タクソノミー文書を構成するタクソノミー本体のうち,指定した名前空間URIを持つタクソノミー本体を取得します。
引数:
targetNamespaceURI - 対象名前空間URIを指定します。
戻り値:
指定した対象名前空間URIを持つタクソノミー本体を表すXBRLTaxonomyBodyオブジェクトを返します。指定した対象名前空間URIを持つタクソノミー本体がない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.0でない場合にスローされます。[エラーコード:20100]
  • 引数targetNamespaceURIにnullを指定した場合にスローされます。[エラーコード:20002]

(7) getLinkbases

public java.util.List<XBRLLinkbase> getLinkbases()

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書を構成するリンクベースのリストを取得します。
このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLLinkbaseオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このタクソノミー文書を構成するリンクベースを表すXBRLLinkbaseオブジェクトのリストを返します。このタクソノミー文書にリンクベースがない場合は,要素数が0のリストを返します。

(8) getStartingPoints

public java.util.List<XBRLTaxonomyComponent> getStartingPoints()

XBRLのバージョン:
2.1
説明:
タクソノミー文書を構成する際の出発点となったタクソノミー本体およびリンクベースのリストを取得します。
このXBRLTaxonomyDocumentオブジェクトがXBRLTaxonomyDocumentBuilderオブジェクトによって生成されたものである場合,getStartingPoints()メソッドが返すリストには,XBRLTaxonomyDocumentBuilderオブジェクトのparse()メソッドの引数に指定したタクソノミー本体が含まれます。一方,このXBRLTaxonomyDocumentオブジェクトが,XBRLInstanceDocumentBuilderオブジェクトを使用してインスタンス文書を解析することによって生成されたものである場合は,getStartingPoints()メソッドが返すリストには,インスタンス文書に記述されている<link:schemaRef>要素,<link:linkbaseRef>要素,<link:roleRef>要素,および,<link:arcroleRef>要素が指すタクソノミー本体およびリンクベースが含まれています。
このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLTaxonomyComponentオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このタクソノミー文書を構築する際の出発点となったタクソノミー本体およびリンクベースを表すXBRLTaxonomyComponentオブジェクトのリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(9) getElements

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

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書に記述されている要素の要素宣言のリストを取得します。
XBRL2.1の場合:このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLTaxonomyElementオブジェクトに増減があった場合,その変更は直ちに反映されます。
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
要素宣言を表すXBRLTaxonomyElementオブジェクトのリストを返します。要素宣言がない場合は,要素数が0のリストを返します。

(10) getElement

public XBRLTaxonomyElement getElement(java.lang.String namespaceURI,
                                     java.lang.String name)

XBRLのバージョン:
2.0および2.1
説明:
指定した名前の要素の要素宣言を取得します。
引数:
namespaceURI - 要素の名前空間URIを指定します。
name - 要素の名前を指定します。
戻り値:
引数namespaceURIで指定した名前空間URIに属し,引数nameで指定した名前を持つ要素の要素宣言を表すXBRLTaxonomyElementオブジェクトを返します。指定した要素の要素宣言がない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 引数namespaceURIまたはnameにnullを指定した場合にスローされます。[エラーコード:20002]

(11) getRoleTypes

public java.util.List<XBRLRoleType> getRoleTypes()

XBRLのバージョン:
2.1
説明:
タクソノミー文書に記述されている<link:roleType>要素のリストを取得します。
このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLRoleTypeオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このタクソノミー文書に記述されている<link:roleType>要素を表すXBRLRoleTypeオブジェクトのリストを返します。このタクソノミー文書に<link:roleType>要素が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(12) getRoleTypes

public java.util.List<XBRLRoleType> getRoleTypes(java.lang.String roleURI)

XBRLのバージョン:
2.1
説明:
タクソノミー文書に記述されている<link:roleType>要素のうち,指定した値のカスタムロールを定義している<link:roleType>要素のリストを取得します。
このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLRoleTypeオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
引数:
roleURI - カスタムロールの値を指定します。
戻り値:
このタクソノミー文書に記述されている<link:roleType>要素を表すXBRLRoleTypeオブジェクトのリストを返します。指定されたカスタムロールを定義する<link:roleType>要素が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数roleURIにnullを指定した場合にスローされます。[エラーコード:20002]

(13) getArcroleTypes

public java.util.List<XBRLArcroleType> getArcroleTypes()

XBRLのバージョン:
2.1
説明:
タクソノミー文書に記述されている<link:arcroleType>要素のリストを取得します。
このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLArcroleTypeオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このタクソノミー文書に記述されている<link:arcroleType>要素を表すXBRLArcroleTypeオブジェクトのリストを返します。このタクソノミー文書に<link:arcroleType>要素が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]

(14) getArcroleTypes

public java.util.List<XBRLArcroleType> getArcroleTypes(java.lang.String arcroleURI)

XBRLのバージョン:
2.1
説明:
タクソノミー文書に記述されている<link:arcroleType>要素のうち,指定した値のカスタムアークロールを定義している<link:arcroleType>要素のリストを取得します。
このメソッドが返すリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLArcroleTypeオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
引数:
arcroleURI - カスタムアークロールの値を指定します。
戻り値:
このタクソノミー文書に記述されている<link:arcroleType>要素を表すXBRLArcroleTypeオブジェクトのリストを返します。指定されたカスタムアークロールを定義する<link:arcroleType>要素が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数arcroleURIにnullを指定した場合にスローされます。[エラーコード:20002]

(15) getLabels

public java.util.List<XBRLLabel> getLabels()

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書に記述されているラベルのリストを取得します。リストの各要素は,XBRLLabelへキャストできます。
XBRLTaxonomyDocumentインターフェースのgetLabels()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得するラベルのリストに含まれます。
しかし,XBRLInstanceElementおよびXBRLTaxonomyElementインターフェースのgetLabels()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得するラベルのリストには含まれません。
このメソッドが返すXBRLLabelオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLLabelオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このタクソノミー文書で定義されるラベルを表すXBRLLabelオブジェクトのリストを返します。このタクソノミー文書で定義されるラベルがない場合は,要素数が0のリストを返します。

(16) getLabelsByLang

public java.util.List<XBRLLabel> getLabelsByLang(java.lang.String lang)

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書に記述されているラベルのうち,指定した言語のラベルのリストを取得します。
XBRLTaxonomyDocumentインターフェースのgetLabelsByLang()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得するラベルのリストに含まれます。
しかし,XBRLInstanceElementおよびXBRLTaxonomyElementインターフェースのgetLabelsByLang()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得するラベルのリストには含まれません。
このメソッドが返すXBRLLabelオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLLabelオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
lang - ラベルの言語を指定します。
戻り値:
このタクソノミー文書で定義されるラベルを表すXBRLLabelオブジェクトのリストを返します。指定した言語のラベルがない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数langにnullを指定した場合にスローされます。[エラーコード:20002]

(17) getLabelsByRole

public java.util.List<XBRLLabel> getLabelsByRole(java.lang.String role)

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書に記述されているラベルのうち,指定したロールを持つラベルのリストを取得します。
XBRLTaxonomyDocumentインターフェースのgetLabelsByRole()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得するラベルのリストに含まれます。
しかし,XBRLInstanceElementおよびXBRLTaxonomyElementインターフェースのgetLabelsByRole()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得するラベルのリストには含まれません。
このメソッドが返すXBRLLabelオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLLabelオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
role - ラベルのロールを指定します。ロールを持たないラベルを取得する場合はnullを指定します。
戻り値:
このタクソノミー文書で定義されるラベルを表すXBRLLabelオブジェクトのリストを返します。指定したロールを持つラベルがない場合は,要素数が0のリストを返します。

(18) getLabels

public java.util.List<XBRLLabel> getLabels(java.lang.String lang,
                               java.lang.String role)

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書に記述されているラベルのうち,指定した言語およびロールを持つラベルのリストを取得します。
XBRLTaxonomyDocumentインターフェースのgetLabels()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得するラベルのリストに含まれます。
しかし,XBRLInstanceElementおよびXBRLTaxonomyElementインターフェースのgetLabels()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得するラベルのリストには含まれません。
このメソッドが返すXBRLLabelオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLLabelオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
lang - ラベルの言語を指定します。
role - ラベルのロールを指定します。ロールを持たないラベルを取得する場合はnullを指定します。
戻り値:
このタクソノミー文書で定義されるラベルを表すXBRLLabelオブジェクトのリストを返します。指定した言語とロールを持つラベルがない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 引数langにnullを指定した場合にスローされます。[エラーコード:20002]

(19) getReferences

public java.util.List<XBRLReference> getReferences()

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書に記述されている文献への参照のリストを取得します。
XBRLTaxonomyDocumentインターフェースのgetReferences()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得するラベルのリストに含まれます。
しかし,XBRLInstanceElementおよびXBRLTaxonomyElementインターフェースのgetReferences()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得するラベルのリストには含まれません。
このメソッドが返すXBRLReferenceオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLReferenceオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
文献への参照を表すXBRLReferenceオブジェクトのリストを返します。文献への参照がない場合は,要素数が0のリストを返します。

(20) getReferences

public java.util.List<XBRLReference> getReferences(java.lang.String role)

XBRLのバージョン:
2.0および2.1
説明:
タクソノミー文書に記述されている文献への参照のうち,指定したロールを持つ文献への参照のリストを取得します。
XBRLTaxonomyDocumentインターフェースのgetReferences()では,文書中に含まれる要素の一覧を取得するため,アーク要素のuse属性がprohibitedの場合でも,取得するラベルのリストに含まれます。
しかし,XBRLInstanceElementおよびXBRLTaxonomyElementインターフェースのgetReferences()では,アーク要素のuse属性がprohibitedの場合は,関連づけられていないと判断し,取得するラベルのリストには含まれません。
このメソッドが返すXBRLReferenceオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLReferenceオブジェクトに増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
引数:
role - 文献への参照のロールを指定します。ロールを持たない文献への参照を取得する場合はnullを指定します。
戻り値:
このタクソノミー文書で定義される文献への参照を表すXBRLReferenceオブジェクトのリストを返します。指定したロールを持つ文献への参照がない場合は,要素数が0のリストを返します。

(21) findCalculationRootElements

public XBRLTaxonomyElement[] findCalculationRootElements(java.lang.String extendedLinkRole,
                                                        java.lang.String arcrole)

XBRLのバージョン:
2.1
説明:
計算リンクで定義された関係のネットワークでルートとなる要素宣言を検索します。
検索対象となる関係を定義しているアークは,引数extendedLinkRoleで指定されたロールを持つ計算リンクに記述され,かつ,引数arcroleで指定されたアークロールを持つものとします。指定されたアークによって定義された関係がひとつも存在しない場合は,このメソッドはnullを返します。
要素宣言が関係のネットワークでルートとなる条件は,「どんな関係でもto側のリソースとして出現しない」ことです。つまり,そのネットワークで関係のto側とならない要素宣言はすべてルートとなります。また,ルートとなる要素宣言は,関係のfrom側である必要はありません。関係のネットワークでほかのどの要素宣言とも関連づけられていない要素宣言は,そのネットワークでのルートです。このメソッドが返した配列に含まれる各要素宣言が関係のfrom側となっているかどうかについては,このメソッドに指定したものと同じ引数を指定してXBRLTaxonomyElement.getCalculationRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)メソッドを呼び出すことによって調べることができます。
引数:
extendedLinkRole - 関係を定義しているアークを含む計算リンクのロールを指定します。
arcrole - 関係を定義しているアークのアークロールを指定します。
戻り値:
指定されたアークによって定義された関係のネットワークでルートとなる要素宣言をすべて含むXBRLTaxonomyElementオブジェクトの配列を返します。指定されたアークによって定義された関係のネットワークでルートが存在しない場合は,要素数が0の配列を返します。指定されたアークによって定義された関係がひとつも存在しない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数extendedLinkRoleまたはarcroleにnullを指定した場合にスローされます。[エラーコード:20002]

(22) findDefinitionRootElements

public XBRLTaxonomyElement[] findDefinitionRootElements(java.lang.String extendedLinkRole,
                                                       java.lang.String arcrole)

XBRLのバージョン:
2.1
説明:
定義リンクで定義された関係のネットワークでルートとなる要素宣言を検索します。
検索対象となる関係を定義しているアークは,引数extendedLinkRoleで指定されたロールを持つ定義リンクに記述され,かつ,引数arcroleで指定されたアークロールを持つものとします。指定されたアークによって定義された関係がひとつも存在しない場合は,このメソッドはnullを返します。
要素宣言が関係のネットワーク上でルートとなる条件は,「どんな関係にあってもto側のリソースとして出現しない」ことです。つまり,そのネットワーク上で関係のto側とならない要素宣言はすべてルートとなります。また,ルートとなる要素宣言は,関係のfrom側である必要はありません。関係のネットワーク上でほかのどの要素宣言とも関連づけられていない要素宣言は,そのネットワーク上でのルートです。このメソッドが返した配列に含まれる各要素宣言が関係のfrom側となっているかどうかについては,このメソッドに指定したものと同じ引数を指定してXBRLTaxonomyElement.getDefinitionRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)メソッドを呼び出すことによって調べることができます。
引数:
extendedLinkRole - 関係を定義しているアークを含む定義リンクのロールを指定します。
arcrole - 関係を定義しているアークのアークロールを指定します。
戻り値:
指定されたアークによって定義された関係のネットワーク上でルートとなる要素宣言をすべて含むXBRLTaxonomyElementオブジェクトの配列を返します。指定されたアークによって定義された関係のネットワーク上でルートが存在しない場合は,要素数が0の配列を返します。指定されたアークによって定義された関係がひとつも存在しない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数extendedLinkRoleまたはarcroleにnullを指定した場合にスローされます。[エラーコード:20002]

(23) findPresentationRootElements

public XBRLTaxonomyElement[] findPresentationRootElements(java.lang.String extendedLinkRole,
                                                         java.lang.String arcrole)

XBRLのバージョン:
2.1
説明:
プレゼンテーションリンクで定義された関係のネットワークでルートとなる要素宣言を検索します。
検索対象となる関係を定義しているアークは,引数extendedLinkRoleで指定されたロールを持つプレゼンテーションリンクに記述され,かつ,引数arcroleで指定されたアークロールを持つものとします。指定されたアークによって定義された関係がひとつも存在しない場合は,このメソッドはnullを返します。
要素宣言が関係のネットワーク上でルートとなる条件は,「どんな関係にあってもto側のリソースとして出現しない」ことです。つまり,そのネットワーク上で関係のto側とならない要素宣言はすべてルートとなります。また,ルートとなる要素宣言は,関係のfrom側である必要はありません。関係のネットワーク上でほかのどの要素宣言とも関連づけられていない要素宣言は,そのネットワーク上でのルートです。このメソッドが返した配列に含まれる各要素宣言が関係のfrom側となっているかどうかについては,このメソッドに指定したものと同じ引数を指定してXBRLTaxonomyElement.getPresentationRelationships(java.lang.String extendedLinkRole, java.lang.String arcrole)メソッドを呼び出すことによって調べることができます。
引数:
extendedLinkRole - 関係を定義しているアークを含むプレゼンテーションリンクのロールを指定します。
arcrole - 関係を定義しているアークのアークロールを指定します。
戻り値:
指定されたアークによって定義された関係のネットワーク上でルートとなる要素宣言をすべて含むXBRLTaxonomyElementオブジェクトの配列を返します。指定されたアークによって定義された関係のネットワーク上でルートが存在しない場合は,要素数が0の配列を返します。指定されたアークによって定義された関係がひとつも存在しない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • 引数extendedLinkRoleまたはarcroleにnullを指定した場合にスローされます。[エラーコード:20002]

(24) getNamespaceDeclarations

public java.util.List<XBRLNamespaceDeclaration> getNamespaceDeclarations()

XBRLのバージョン:
2.1
説明:
タクソノミー文書に記述されている名前空間宣言のリストを取得します。リストの各要素は,XBRLNamespaceDeclarationへキャストすることができます。
このメソッドが返すリストには,<xsd:schema>要素で指定された名前空間宣言,または,<link:linkbase>要素で指定された名前空間宣言のみが含まれます。ただし,タクソノミー本体に記述される<link:linkbase>要素は取得対象になりません。<xsd:include>要素でインクルードされたタクソノミー本体が重複する場合,重複するタクソノミー本体に対し名前空間宣言を重複して取得することはありません。
また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
名前空間宣言を表すXBRLNamespaceDeclarationオブジェクトのリストを返します。このタクソノミー文書に名前空間宣言の名前空間URIが存在しない場合は,要素数が0であるリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • cbrp.parse.validate.frtafrisオプションがfalseに設定されている場合にスローされます。[エラーコード:22011]

(25) getLinkbaseRefs

public java.util.List<XBRLTaxonomyLinkbaseRef> getLinkbaseRefs()

XBRLのバージョン:
2.1
説明:
タクソノミー文書に存在する<link:linkbaseRef>要素のリストを取得します。リストの各要素は,XBRLTaxonomyLinkbaseRefへキャストすることができます。
また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このタクソノミー文書に存在する<link:linkbaseRef>要素をすべて含むXBRLTaxonomyLinkbaseRefオブジェクトのリストを返します。このタクソノミー文書に<link:linkbaseRef>要素が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • cbrp.parse.validate.frtafrisオプションがfalseに設定されている場合にスローされます。[エラーコード:22011]

(26) getRoleRefs

public java.util.List<XBRLTaxonomyRoleRef> getRoleRefs()

XBRLのバージョン:
2.1
説明:
このタクソノミー文書に存在する<link:roleRef>要素のリストを取得します。リストの各要素は,XBRLTaxonomyRoleRefへキャストすることができます。
また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このタクソノミー文書に存在する<link:roleRef>要素をすべて含むXBRLTaxonomyRoleRefオブジェクトのリストを返します。このタクソノミー文書に<link:roleRef>要素が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • cbrp.parse.validate.frtafrisオプションがfalseに設定されている場合にスローされます。[エラーコード:22011]

(27) getTaxonomyTypeDefinitions

public java.util.List<XBRLTaxonomyTypeDefinition> getTaxonomyTypeDefinitions()

XBRLのバージョン:
2.1
説明:
タクソノミー文書で定義された型定義のリストを取得します。リストの各要素は,XBRLTaxonomyTypeDefinitionへキャストすることができます。
このメソッドが返すリストには,名前を持たない型定義は含まれません。名前を持たない型定義は,その型定義を含む要素宣言のXBRLTaxonomyElementインターフェースから取得することができます。
また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
型定義を表すXBRLTaxonomyTypeDefinitionオブジェクトのリストを返します。このタクソノミー文書に型定義(名前を持たない型定義を除く)が存在しない場合は,要素数が0であるリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • cbrp.parse.validate.frtafrisオプションがfalseに設定されている場合にスローされます。[エラーコード:22011]

(28) getNamespaceDeclarationsByPrefix

public java.util.List<XBRLNamespaceDeclaration> getNamespaceDeclarationsByPrefix(java.lang.String prefix)

XBRLのバージョン:
2.1
説明:
タクソノミー文書で定義される名前空間宣言のうち,引数で指定した名前空間接頭辞の名前空間宣言のリストを取得します。リストの各要素は,XBRLNamespaceDeclarationへキャストすることができます。
また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
引数:
prefix -名前空間接頭辞を指定します。デフォルトの名前空間の宣言を取得する場合はnullを指定します。
戻り値:
このタクソノミー文書で定義される引数prefixで指定された名前空間接頭辞の名前空間宣言を表すXBRLNamespaceDeclarationオブジェクトのリストを返します。指定された名前空間接頭辞の名前空間宣言が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • cbrp.parse.validate.frtafrisオプションがfalseに設定されている場合にスローされます。[エラーコード:22011]

(29) getNamespaceDeclarationsByURI

public java.util.List<XBRLNamespaceDeclaration> getNamespaceDeclarationsByURI(java.lang.String uri)

XBRLのバージョン:
2.1
説明:
タクソノミー文書で定義される名前空間宣言のうち,引数で指定した名前空間URIの名前空間宣言のリストを取得します。リストの各要素は,XBRLNamespaceDeclarationへキャストすることができます。
また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
引数:
uri -名前空間URIを指定します。
戻り値:
このタクソノミー文書で定義される引数uriで指定された名前空間URIの名前空間宣言を表すXBRLNamespaceDeclarationオブジェクトのリストを返します。指定された名前空間URIの名前空間宣言が存在しない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • cbrp.parse.validate.frtafrisオプションがfalseに設定されている場合にスローされます。[エラーコード:22011]
  • 引数uriにnullを指定した場合にスローされます。[エラーコード:20002]

(30) getTaxonomyTypeDefinition

public XBRLTaxonomyTypeDefinition getTaxonomyTypeDefinition(java.lang.String namespaceURI,java.lang.String name)

XBRLのバージョン:
2.1
説明:
タクソノミー文書で定義された型定義のうち,引数で指定した名前の型定義を取得します。
引数:
namespaceURI -型定義の名前空間URIを指定します。
name -型定義の名前を指定します。
戻り値:
引数namespaceURIで指定された名前空間URIに属し,引数nameで指定された名前を持つ型定義を表すXBRLTaxonomyTypeDefinitionオブジェクトを返します。指定された型定義が存在しない場合はnullを返します。
例外:
XBRLDOMRuntimeException -
  • 操作対象のタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • cbrp.parse.validate.frtafrisオプションがfalseに設定されている場合にスローされます。[エラーコード:22011]
  • 引数namespaceURIまたはnameにnullを指定した場合にスローされます。[エラーコード:20002]

(31) getDimensionalRelationshipSets

public java.util.List<XBRLDimensionalRelationshipSet> getDimensionalRelationshipSets()

XBRLのバージョン:
2.1
XBRL Dimensionsのバージョン:
1.0
説明:
タクソノミー文書で定義されるDRSのリストを取得します。
このメソッドが返すXBRLDimensionalRelationshipSetオブジェクトのリストは,ライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる必要があるXBRLDimensionalRelationshipSetオブジェクトに増減があった場合,その変更は直ちに反映されます。
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
このタクソノミー文書で定義されるDRSのリストを返します。このタクソノミー文書で定義されるDRSがない場合は,要素数が0のリストを返します。
例外:
XBRLDOMRuntimeException -
  • このタクソノミー文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
  • このタクソノミー文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]

(32) getDimensionsVersion

public int getDimensionsVersion()

XBRLのバージョン:
2.1
説明:
タクソノミー文書が準拠しているXBRL Dimensionsのバージョンを取得します。
cbrp.parse.DimensionsVersionプロパティの値は,このタクソノミー文書がXBRL2.1に準拠している場合にだけ使用されます。XBRLのバージョンが2.1以外の場合,cbrp.parse.DimensionsVersionプロパティの値は使用されません。
戻り値:
このタクソノミー文書がXBRL Dimensions1.0に準拠している場合はXBRLConstants.DIMENSIONS_1_0を返します。XBRL Dimensionsに準拠していない場合はXBRLConstants.DIMENSIONS_NONEを返します。