RaptorXML+XBRL Engine Java API documentation

The RaptorXML+XBRL Server Java API has support for the following specifications:

• AVRO
• JSON
• JSON Schema
• OASIS XML Catalogs 1.1
• XML 1.0 and XML 1.1
• XMLSchema 1.0 and XMLSchema 1.1
• XBRL 2.1
• XBRL Dimensions 1.0
• XBRL Formula 1.0
• XBRL Table 1.0
• XBRL Extensible Enumerations 1.0 and 2.0
• XBRL Generic Links 1.0
• XBRL Generic Labels 1.0
• XBRL Generic References 1.0
• XBRL Generic Preferred Label 1.0
• XBRL Units Registry 1.0
• Inline XBRL 1.0 and 1.1
• Taxonomy Packages 1.0
• XPath 1.0, XPath 2.0 and XPath 3.1
• XQuery 1.0 and XQuery 3.1
• XSLT 1.0, XSLT 2.0 and XSLT 3.0

Getting Started

The RaptorXML Java API is provided as a Java/Jni wrapper that exposes the functionality of the installed RaptorXML binaries. The RaptorXML+XBRL Engine Java API provides access the internal data model of Altova RaptorXML Server for DTD, XML, XML Schema, XBRL and documents.

All examples are available as eclipse projects but can be easily compiled and run from command line, as well. You have to add the path to the raptorxmlxbrlapi.jar file, located in the binary folder of your RaptorXML installation, to the class path when compiling your java code. To run a sample you have to pass the location of the JNI-library to Java, in addition.

Example for Windows command line:

   xcopy "C:\Program Files\Altova\RaptorXMLXBRLServer2026\examples\EngineAPI\java\XQuery_ExternalFunction" /E C:\tmp\XQueryTest

   cd C:\tmp\XQUeryTest

   javac -d bin -cp "C:\Program Files\Altova\RaptorXMLXBRLServer2026\bin\raptorxmlxbrlapi.jar" src\XQuery_ExternalFunction.java

   java -cp "C:\Program Files\Altova\RaptorXMLXBRLServer2026\bin\raptorxmlxbrlapi.jar;bin" -Djava.library.path="C:\Program Files\Altova\RaptorXMLXBRLServer2026\bin" XQuery_ExternalFunction}

Example for Linux command line:

  cp -r /opt/Altova/RaptorXMLXBRLServer2026/examples/EngineAPI/java/XQuery_ExternalFunction ~/XQueryTest

   cd ~/XQueryTest

   javac -d bin -cp /opt/Altova/RaptorXMLXBRLServer2026/bin/raptorxmlxbrlapi.jar src/XQuery_ExternalFunction.java

   sudo java -cp /opt/Altova/RaptorXMLXBRLServer2026/bin/raptorxmlxbrlapi.jar:bin -Djava.library.path=/opt/Altova/RaptorXMLXBRLServer2026/bin XQuery_ExternalFunction

		 

The RaptorXML+XBRL Java API requires the JDK 17 or newer. All classes and types provided by the RaptorXML+XBRL Java API are located in the com.altova.raptorxml package and it's sub packages.

To load XML, DTD, XSD or XBRL files use one of the following CreateFromUrl or CreateFromBuffer methods:

• To load an OASIS XML Catalog object use Catalog.CreateFromUrl(java.lang.String, com.altova.raptorxml.ErrorLog, com.altova.raptorxml.xml.CatalogSettings) .
• To load an XML Instance object use Instance.CreateFromUrl(java.lang.String, com.altova.raptorxml.ErrorLog, com.altova.raptorxml.xml.InstanceSettings) .
• To load an XML Dtd object use Dtd.CreateFromUrl(java.lang.String, com.altova.raptorxml.ErrorLog, com.altova.raptorxml.xml.dtd.DtdSettings) .
• To load an XML Schema object use Schema.CreateFromUrl(java.lang.String, com.altova.raptorxml.ErrorLog, com.altova.raptorxml.xsd.SchemaSettings) .
• To load an XBRL Instance object use Instance.CreateFromUrl(java.lang.String, com.altova.raptorxml.ErrorLog, com.altova.raptorxml.xbrl.InstanceSettings) .
• To transform an inline XBRL Instance object use InlineXbrlDocumentSet.TransformXbrlFromUrl(java.lang.String, com.altova.raptorxml.ErrorLog, com.altova.raptorxml.xbrl.InlineXbrlSettings) .
• To load an XBRL Dts object use Dts.CreateFromUrl(java.lang.String, com.altova.raptorxml.ErrorLog, com.altova.raptorxml.xbrl.taxonomy.DtsSettings) .

Examples

Example Eclipse projects are installed within the examples folder of the RaptorXML+XBRL installation directory. Further examples are hosted on Altova's GitHub page.

Modules

Module	Description
raptorxmlxbrlapi_java