XBRL instance loading example.
Author: Geoff Shuetrim (geoff at galexy.net)
What is it?
This is a Java sample application to demonstrate loading data into the data store to facilitate XBRL operations using the XBRLAPI. It uses the Oracle Berkeley XML database module.
Where is it?
The home page for the XBRL API project can be found on the XBRLAPI project web site (http://www.xbrlapi.org/). There you also find information on how to download the latest release as well as all the other information you might need regarding this project.
You can browse the source code in SVN.
Requirements
- A Java 1.5 or later compatible virtual machine for your operating system.
- 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-examples 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.
You can download the required XBRLAPI JARs from Sourceforge. You can get suggestions on necessary installation and configuration steps from http://www.xbrlapi.org/.
You can get the other jar files from the XBRLAPI SVN repository.
Commandline Arguments:
Java Virtual Machine Parameters:
-Dlog4j.configuration=<location of log4j.properties> -classpath=<java class paths>
An example logging configuration file is available for download from the Sourceforge SVN respository for XBRLAPI. Download it to your file system and reference it as suggested above.
Program execution involves:
java org.xbrlapi.data.bdbxml.examples.load.Load <OPTIONS> <URLS>
Where the URLs are the URLs of additional starting points for DTS discovery and the mandatory options are:
- -database [the directory containing the Oracle Berkeley XML database]
- -container [the name of the database container in the Oracle Berkeley XML database]
- -cache [the directory containing the document cache]
The optional options are:
- -dbCacheSize [the number of megabytes of cache to use for the Oracle Berkeley XML database. Specify as an integer value.]
Note that the cache size only has an impact if you are creating the database environment when setting up the container. If the environment already exists, this option is ignored.
SEC XBRL filings loading example.
Author: Geoff Shuetrim (geoff at galexy.net)
What is it?
This is a Java sample application to demonstrate loading large data volumes into the data store. It uses the SEC voluntary filing system for the example. The documents are identified by the SEC RSS feed http://www.sec.gov/Archives/edgar/xbrlrss.xml.
Where is it?
The home page for the XBRL API project can be found on the XBRLAPI project web site (http://www.xbrlapi.org/). There you also find information on how to download the latest release as well as all the other information you might need regarding this project.
You can browse the source code in SVN.
Requirements
- A Java 1.5 or later compatible virtual machine for your operating system.
- 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-examples 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.
You can download the required XBRLAPI JARs from Sourceforge. You can get suggestions on necessary installation and configuration steps from http://www.xbrlapi.org/.
You can get the other jar files from the XBRLAPI SVN repository.
Commandline Arguments:
Java Virtual Machine Parameters:
-Dlog4j.configuration=<location of log4j.properties> -classpath=<java class paths>
Program execution involves:
java org.xbrlapi.data.bdbxml.examples.load.LoadAllSECFilings <OPTIONS>
Where the mandatory options are:
- -database [the directory containing the Oracle Berkeley XML database]
- -container [the name of the database container in the Oracle Berkeley XML database]
- -cache [the directory containing the document cache]
- -threads [integer specifying the number of threads to use for loading the data]
Licensing and legal issues
XBRLAPI examples are released under the lesser GPL license.
Thanks for using XBRLAPI.