SIS - Application Programmatic Interface, Reference Manual - ICS ...

SIS-Application Programmatic Interface, Reference Manual
Appendix E - Java Programmatic Interface
In the following we present the basic differences between the C application
programmatic interface (C-API) and Java application programmatic interface (JAPI).
The interface is built on class QClass, which provides as public member functions all
the functions of described in this document. The only difference is the functions
described in sections 6.3.3.1, 6.3.3.2, 6.3.3.3 and 6.3.3.4 are having oper as prefix
(e.g. function GET_SUPERCLASSES() was renamed to operGET_SUPERCLASSES()).
The structures defined for argument passing, such as cm_value, category_set etc.
are implemented as separate a package and all the classes and dll’s are provided in a
jar file (called “japi14.jar” for version 1.4 of the Java-API, which is the version
presented here). We use these structures as arguments to the functions described in
this document. The Java classes that replace them are:
• Int replaces int (an integer argument, whenever is used ‘pass-by-value’)
• IntegerObject replaces int* (an integer argument, whenever is used ‘passby-reference’)
• String replaces char* (a string argument, whenever is used ‘pass-by-value’)
• StringObject replaces char* (a string argument, whenever is used ‘pass-byreference’)
• CMValue replaces cm_value
• CategorySet replaces category_set
• Identifier replaces IDENTIFIER
• Time replaces TIME (not implemented yet)
Also free_sis_allocated_space() is not provided in SIS JAPI.
Below we present an example which is the Java implementation of the example
presented in “Appendix B - An Example”.
import java.io.*;
class Car {
public Car() {
QClass Q = new QClass();
IntegerObject sis_session = new IntegerObject();
Q.create_SIS_CS_Session(sis_session, "agnes",1291, "", "");
Q.open_connection(sis_session.getValue());
Q.begin_query(sis_session.getValue());
Q.reset_name_scope(sis_session.getValue());
StringObject strobject = new StringObject();
StringObject label = new StringObject();
StringObject cls = new StringObject();
CMValue cmv = new CMValue();
int ret_set1 = -1, ret_set2 = -1;
Q.reset_name_scope(sis_session.getValue());
strobject.setValue("PhysicalObj");
if (Q.set_current_node(sis_session.getValue(), strobject) != Q.APIFail)
if ((ret_set1 = Q.get_instances(sis_session.getValue(), 0)) != Q.APIFail) {
Q.reset_set(sis_session.getValue(), ret_set1);
System.out.println("\nINSTANCES OF 'PhysicalObj' : \n");
while (Q.return_nodes(sis_session.getValue(),ret_set1, label) !=
Q.APIFail)
August 2002/v2.2.2 -61- ICS-FORTH