Interstage Shunsaku Data Manager Application Development Guide - Microsoft(R) Windows(R) 2000/ Microsoft(R) Windows Server(TM) 2003 - - UNIX -

9.1 Java API Overview

A Java API is an interface for manipulating Shunsaku data from an application written in Java.

The following table lists the Java API classes.

[Table 9-1 Java API Classes]

Class	Description
ShunConnection	Represents the connection with Shunsaku.
ShunPreparedKey	Uses direct access keys to perform data searches and update, and delete XML documents.
ShunPreparedRecordID	Uses record IDs to perform XML documents searches and update, and delete XML documents.
ShunPreparedStatement	Performs data searches and adds XML documents using search expressions.
ShunResultSet	Represents the set of search results.
ShunException	Provides information about errors that occur in the Shunsaku Java API.

Refer to the Java API Reference for more information on the Java APIs provided by Shunsaku.

The Java APIs are used to create objects. The following table shows the timing by which the objects of each class are created and released.

[Table 9-2 Timing by Which the Objects of Each Class Are Created and Released]

Object name	Creation timing	Release timing
ShunConnection	ShunConnection objects are created using a constructor.	ShunConnection objects are released using the close method of the ShunConnection class.
ShunPreparedKey	ShunPreparedKey objects are created by the prepareDeleteKey method, the prepareSearchKey method and the prepareUpdateKey method of the ShunConnection class.	ShunPreparedKey objects are released using the close method of the ShunPreparedKey class.
ShunPreparedRecordID	ShunPreparedRecordID objects are created by the prepareDeleteRecordID method, the prepareSearchRecordID method and the prepareUpdateRecordID method of the ShunConnection class.	ShunPreparedRecordID objects are released using the close method of the ShunPreparedRecordID class.
ShunPreparedStatement	ShunPreparedStatement objects are created by the prepareInsert method and the prepareSearch method of the ShunConnection class.	ShunPreparedStatement objects are released using the close method of the ShunPreparedStatement class.
ShunResultSet	ShunResultSet objects are created by the searchByRecordID method of the ShunPreparedRecordID class and the executeSearch method of the ShunPreparedStatement class.	ShunResultSet objects are released using the close method of the ShunResultSet class.
ShunException	ShunException objects are created when an error occurs in the Java API.	ShunException objects are released when the application terminates.