com.scitools.understand

Class Understand

java.lang.Object

com.scitools.understand.Understand

public class Understand
extends java.lang.Object

This class is the entry point for using the Understand package. All other classes are only valid if returned from functions.

Constructor Summary

Constructors

Constructor and Description
Understand()

Method Summary

Methods

Modifier and Type	Method and Description
static void	loadNativeLibrary() Load and initialize the native component of this library.
static java.lang.String[]	metriclist(java.lang.String kindstring) Return a list of all valid metric names.
static Database	open(java.lang.String name) Open the database with the given name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Understand

public Understand()

Method Detail

open

public static Database open(java.lang.String name)
                     throws UnderstandException

Open the database with the given name. This is the only way to get a Database object. Possible exceptions messages are:

• DBAlreadyOpen - only one database may be open at once
• DBCorrupt - bad database file
• DBOldVersion - database needs to be rebuilt
• DBUnknownVersion - database needs to be rebuilt
• DBUnableOpen - database is unreadable or does not exist
• NoApiLicense - Understand license required

A Database must be closed using the close() method in order to release the understand resources. Once a database is closed, it and all associated objects (entities, references ...) become invalid. If you call open() more than once for a particular database (not recommended), closing one database will invalidate the other database objects, but you should still call close on each of the other database objects to fully release the memory.

Parameters:

name - The absolute filename of the database. Must not be null.

Returns:

An accessor to an understand database.

Throws:

UnderstandException - If any of the above errors occur.

metriclist

public static java.lang.String[] metriclist(java.lang.String kindstring)

Return a list of all valid metric names.

Parameters:

kindstring - If not null, return only metric names valid for entities that match the kindstring.

Returns:

a list of valid metric names.

loadNativeLibrary

public static void loadNativeLibrary()

Load and initialize the native component of this library. This function is called automatically from the other static methods in this class.