Examples of how to use XBRLAPI.
This page provides links to examples showing how the XBRLAPI can be used to work with XBRL data.
Most of the examples rely on having the Oracle Berkeley XML database installed. The data store maintenance examples are simple utilities that can be run from the commandline to perform a variety of operations on the data store. Their documentation is available in the Javadoc API documentation.
- Example illustrating the basics of loading XBRL data using the API
- Example showing one way that the XBRLAPI can be used to render business reports
- Example showing how to load and work with XBRL Dimensions
- Various example utilities showing how the data store can be manipulated.
Requirements for running all examples:
- Xerces 2.6.2 or later version jar file.
- Saxon 9.0 or later version jar file.
- Saxon DOM 9.0 or later version jar file.
- Saxon S9API 9.0 or later version jar file.
- Log4j 1.2.15 or later version jar file.
- XBRLAPI module-utilities jar file.
- XBRLAPI module-xmlbase jar file.
- XBRLAPI module-xlink jar file.
- XBRLAPI module-xpointer jar file.
- XBRLAPI module-api jar file.
- XBRLAPI module-bdbxml jar file.
- XBRLAPI module-examples jar file.
- A working installation of the Oracle Berkeley XML Database.
Third-party JAR file dependencies can be found in the source repository for the XBRLAPI.
An example log4j logging configuration file is available for download from the source repository. Download it to your file system then adjust it and reference it as required.
Setting up the classpath can be nightmare in Java. If you are using the Sun Java 1.6 binaries, then it is worth taking a
look at the Oracle classpath instructions.
If those are not giving you joy, then take a look at two blogs
(dirkeiler which discusses
issues with getting the
-classpath parameter working with wildcards.
The source code for the examples can be reviewed in the source repository.