Files, Samples and Documentation - Data Access API

The Data Access API includes the following directories and files.

Directory Contains...

config

Configuration files, including administrationServerCatalog.xml, which is used to configure the connection between the Data Access API and SuperSERVER/SuperADMIN.

docs Javadoc documentation of the available methods and interfaces. To view the documentation, open docs\index.html in a web browser.

endorsed

Third-party open source software that is required to use the API.

When you execute your application, you must use the command line option -Djava.endorsed.dirs and pass in the location of the endorsed directory.

lib Third-party libraries that are required to use the API.

samples

Sample code demonstrating the use of the API. This directory contains:

File/Directory	Description
au	The source code for the samples. See below for more details.
build.xml	An Ant build file for compiling the same code.
dataAccessAPISamples.jar	The sample code compiled into a JAR file.
jacorb.properties	The properties file for the CORBA communication between the Data Access API and SuperSTAR.
runSamples.bat	A script for executing the sample code.
txd01.txd	A table definition (TXD) file for use with the sample code.

Sample Code

The following samples are provided with the API:

Sample File	Demonstrates...	Code Summary
samples\au\com\str\samples\query\SimpleTxdQuery.java	How to submit a static query using a TXD and output the results to a Comma Separated Values (CSV) file.	Gets an authenticated connection to SuperSTAR. Submits a table query using the specified TXD file(s). Writes the cross-tabulation output to a CSV file. Closes the connection to SuperSTAR.
samples\au\com\str\samples\schema\SinglebranchNavigation.java	How to access a single branch of a hierarchy. The example code outputs the hierarchy of the Area field from the sample Retail Banking Database. This technique can also be used for a flat field branch and multiple branches.	Gets an authenticated connection to SuperSTAR. Gets a handle to the database (by default, Retail Banking). Gets a handle to a classification field (by default, Area). Recursively retrieves the classification fields and prints them. Closes the connection to SuperSTAR.
samples\au\com\str\samples\schema\SummationGroupNavigation.java	How to navigate a summation group. The example code outputs a list of the measures from a database.	Gets an authenticated connection to SuperSTAR. Gets a handle to the database. Recursively retrieves the measures from the database and prints them. Closes the connection to SuperSTAR
samples\au\com\str\samples\util\CSVWriter.java	Code for writing output to a CSV file. This code is called by SimpleTxdQuery to write the results to a CSV file.	Writes the table results to a CSV file.