GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

11.20.19 Taxonomy — References

References with in a taxonomy specify additional information for concepts. The data can be used for meta data or as authoritative links to information outside the taxonomy. The linkbase information consists of four main components:

–  Reference Links (link group)

–  Reference Items (referred to as the “reference”)

–  Reference Data (actual reference information)

–  Locators and Arcs to Associate the Reference Item with a Concept

All references are contained within various linkbases. The data is grouped under one or more reference links. This allows data to be organized for multiple taxonomies or to be internally separated. Generally, once a taxonomy is loaded for an instance, the actual links are not important to the reference data.

Within each link group, the association of a reference item to the concept is performed used the locator and arcs. The post processor will perform this task and load the concept name and the concept record position as part of the data returned for the reference item,

Each reference item contains one or more data items formatted with developer specific XML elements.

The linking of the references is performed during post processing, as such the XBRLPostProcess function must be called prior to using any of these functions. In addition, since this is a taxonomy set of functions, the XBRLLoadTaxonomy function must also be called as part of the initialization.

After post processing, the internal reference item list is sorted by concept name.

High Level Functionality

There are three functions of interest to access reference data from a high level:

XBRLGetReference — This function allows the reference item to be retrieved either by concept name or by list position. Since the concept name does not need to be unique, it is necessary to search for the concept and then enumerate each item.

XBRLGetReferences — This function allows for all the reference links to enumerated or to be filtered for a specific concept.

XBRLGetReferenceData — This function enumerates the reference data, i.e., the actual taxonomy reference data as pointed to by the reference item key name “f_data_index”.

The remaining functions allow access to the details of the taxonomy linkbase construction and coding.

Functions

XBRLGetReference — Returns the properties for a specified reference (reference item).

XBRLGetReferenceArcs — Returns all the reference arcs.

XBRLGetReferenceCount — Returns a count of all references.

XBRLGetReferenceData — Returns the data elements for a specified reference.

XBRLGetReferenceLink — Returns a specified reference link.

XBRLGetReferenceLinkCount — Returns the number of items in the reference link table.

XBRLGetReferenceLinks — Returns all the reference links.

XBRLGetReferenceLocators — Returns all reference locators.

XBRLGetReferences — Returns all references or only those items associated with a specified concept.

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.