libgist.java

Libgist is an implementation of the Generalized Search Tree, a template index structure that makes i

writeAnalysis() throws LibgistException
{
    libWriteAnalysis();
}


///////////////////////////////////////////////////////////////////////////////
// getAnalysisInfo - return info about progress of analysis, etc.
//
// Description:
//
///////////////////////////////////////////////////////////////////////////////

public static void
getAnalysisInfo(
    AnalysisInfo info)
    throws OutOfMemoryError
{
    //LibgistException exc = new LibgistException();
    //exc.printStackTrace();
    libGetAnalysisInfo(info);
}


///////////////////////////////////////////////////////////////////////////////
// getQueryStats - get query stats from analysis
//
// Description:
//
///////////////////////////////////////////////////////////////////////////////

public static void
getQueryStats(
    int queryNo, // in: number of query; = 0: cumulative stats
    QueryStats stats) // out
{
    stats.reset();
    libGetQueryStats(queryNo, stats);
}

///////////////////////////////////////////////////////////////////////////////
// getSplitStats - get split stats from analysis
//
// Description:
//
///////////////////////////////////////////////////////////////////////////////

public static void
getSplitStats(
    int leafNo, // in: page # of split leaf; = 0: cumulative stats
    boolean weighted, // in: if true, return weighted I/O values
    SplitStats stats) // out
{
    stats.reset();
    libGetSplitStats(leafNo, weighted, stats);
}

///////////////////////////////////////////////////////////////////////////////
// getSplitLeaves - returns page numbers of leaves whose split was analyzed
//
// Description:
//
///////////////////////////////////////////////////////////////////////////////

public static void
getSplitLeaves(
    int[] leafNos) // out
{
    libGetSplitLeaves(leafNos);
}


///////////////////////////////////////////////////////////////////////////////
// getPenaltyStats - get penalty stats from analysis
//
// Description:
//
///////////////////////////////////////////////////////////////////////////////

public static void
getPenaltyStats(
    int keyNo, // in: # of key used for insertion
    boolean weighted, // in: if true, return weighted I/O values
    PenaltyStats stats) // out
{
    stats.reset();
    libGetPenaltyStats(keyNo, weighted, stats);
}

///////////////////////////////////////////////////////////////////////////////
// getNumInsertions - get # of insertions analyzed in penalty stats
//
// Description:
//
///////////////////////////////////////////////////////////////////////////////

public static int
getNumInsertions()
{
    return(libGetNumInsertions());
}


///////////////////////////////////////////////////////////////////////////////
// getWkldNodeStats - get per-node stats from amdb_wkldprofile/-stats
//
// Description:
//	- resize displayStats and nodeStats to match the number of 
//	  pages in the tree
///////////////////////////////////////////////////////////////////////////////

static public final int TRAVERSALS = 		0;
    // amdb_wkldprofile::TraversalStats.traversalCnt
static public final int RETRIEVALS = 		1;
    // amdb_wkldprofile::TraversalStats.retrievalCnt
static public final int EMPTYSUBTREES = 	2;
    // amdb_wkldprofile::TraversalStats.emptySubtree
static public final int CLUSTERLOSS = 		3;
    // amdb_wkldstats::NodeStats.[min|opt]ClusterLoss
static public final int CLUSTEROH = 		4;
    // amdb_wkldstats::NodeStats.[min|opt]ClusterOh
static public final int UTILLOSS = 		5;
    // amdb_wkldstats::NodeStats.[min|opt]UtilLoss
static public final int UTILOH = 		6;
    // amdb_wkldstats::NodeStats.[min|opt]UtilOh
static public final int EXCCOVLOSS = 		7;
    // amdb_wkldstats::NodeStats.[min|opt]ExcCovLoss
static public final int EXCCOVOH = 		8;
    // amdb_wkldstats::NodeStats.[min|opt]ExcCovOh
static public final int NODEUTIL = 		9;
    // amdb_treemap::PageInfo.util
static public final int SLOTCNT = 		10;
    // amdb_treemap::PageInfo.itemCnt
static public final int PREDSIZE = 		11;
    // amdb_treemap::PageInfo.avgPredLen

public static void
getWkldNodeStats(
    int statType, // in: one of the above constants
    int queryNo, // in: number of query, = 0: cumulative stats
    boolean minBased) // in: if true, return min-, not opt-based statistic
{
    if (nodeCnt < libPageCount()) {
        nodeCnt = libPageCount();
	displayStats = new float[nodeCnt];
	//nodeStats = new NodeStats[nodeCnt];
    }
    libGetWkldNodeStats(statType, queryNo, minBased, displayStats);
}


///////////////////////////////////////////////////////////////////////////////
// getSplitNodeStats - get per-node stats from amdb_splitstats
//
// Description:
//	- resize displayStats and nodeStats to match the number of 
//	  pages in the tree
//	- split stats are always aggregates over all queries
///////////////////////////////////////////////////////////////////////////////

static public final int SPLITCLUSTLOSS = 	0;
    // amdb_splitstats::FullSplitStats::clustLoss()
static public final int SPLITEXCCOVLOSS = 	1;
    // amdb_splitstats::FullSplitStats::excCovLoss()
static public final int SPLITCLUSTSUCC = 	2;
    // amdb_splitstats::FullSplitStats::clustSuccess()
static public final int SPLITEXCCOVSUCC = 	3;
    // amdb_splitstats::FullSplitStats::excCovSuccess()
static public final int OPTCLUSTDELTA = 	4;
    // amdb_splitstats::FullSplitStats::optClustDelta()
static public final int ACTCLUSTDELTA = 	5;
    // amdb_splitstats::FullSplitStats::actualClustDelta
static public final int EXCCOVDELTA = 		6;
    // amdb_splitstats::FullSplitStats::excCovDelta()

public static void
getSplitNodeStats(
    int statType, // in: one of the above constants
    boolean delta, // in: if true, return deltas, not abs. values
    boolean weighted) // in: if true, return weighted I/O numbers
{
    if (nodeCnt < libPageCount()) {
        nodeCnt = libPageCount();
	displayStats = new float[nodeCnt];
	//nodeStats = new NodeStats[nodeCnt];
    }
    libGetSplitNodeStats(statType, delta, weighted, displayStats);
}



/*
 * Scripts
 */

// returns script ID
public static int
openScript(String filename) throws LibgistException
{
    return libOpenScript(filename);
}


///////////////////////////////////////////////////////////////////////////////
// gist::insert - insert a new entry into the tree
//
// Description:
//
// Exceptions:
//
// Return Values:
//	< 0: error
//	>= 0: cmd
///////////////////////////////////////////////////////////////////////////////

// command constants (return values of getCommand())
static final int FILEERROR =  -3;
static final int PARSEERROR =  -2;
static final int EOF =  -1;

public static int
getCommand(int scriptId, LibgistCommand cmd) throws LibgistException
{
    cmd.reset();
    return libGetCommand(scriptId, cmd);
}


/*
 * Scripts
 */

public static void
setDbgLevel(int dbgLevel)
{
    libSetDbgLevel(dbgLevel);
}

/*
 * JNI stuff
 */

private static native ExtensionInfo[]
libGetExtensionInfo();

private static native void
libCreate(String fileName, int extId) throws LibgistException;

private static native void
libOpen(String fileName) throws LibgistException; 

private static native void
libClose() throws LibgistException;

private static native void
libFlush() throws LibgistException;

private static native void
libSave(String filename) throws LibgistException; 

private static native void
libInsert(String key, String data) throws LibgistException;

private static native void
libRemove(String query) throws LibgistException;

private static native void
libFetch(String query, int limit, ResultProcessor procResult) throws LibgistException;

private static native void
libCheck() throws LibgistException;

private static native int
libDump(JTextArea area, int pgNo) throws LibgistException;

private static native void
libDisplayPreds(Graphics g, int width, int height, Color[] colors)
    throws LibgistException;

// returns root page no
private static native int
libGetRoot();

// returns root page no
private static native int
libGetPageCount();

// returns pageno of parent
private static native int
libGetParent(int pgNo);

// returns level of page (leaf level = 1)
private static native int
libGetLevel(int pgNo);

// returns position in  parent
private static native int
libGetParentPos(int pgNo) throws LibgistException;

// returns pgnos of all children
private static native int
libGetChildren(int parent, int[] children) throws LibgistException;

private static native int
libMaxChildren();

// returns path from root to node with pgNo
private static native int
libGetPath(int pgNo, int[] path) throws LibgistException;

// returns the nonce of the node with pgNo
private static native int
libGetNonce(int pgNo) throws LibgistException;

private static native void
libInit();

private static native void
libSetBreakHandler(BreakHandler handler);

private static native void
libSingleStep();

private static native void
libDeleteBps();

private static native void
libCreateBp(Breakpoint bp);

private static native void
libDisableAll(boolean disable);

private static native void
libOpenAnalysis(String name);

private static native void
libCloseAnalysis();

private static native void
libWriteAnalysis() throws LibgistException;

private static native void
libGetAnalysisInfo(AnalysisInfo info);

private static native void
libGetQueryStats(int queryNo, QueryStats stats);

private static native void
libGetSplitStats(int leafNo, boolean weighted, SplitStats stats);

private static native void
libGetSplitLeaves(int[] leafNos);

private static native void
libGetPenaltyStats(int keyNo, boolean weighted, PenaltyStats stats);

private static native void
libGetWkldNodeStats(int statsType, int queryNo, boolean minBased,
    float[] stats);

private static native void
libGetSplitNodeStats(int statsType, boolean delta, boolean weighted,
    float[] stats);

private static native int
libPageCount();

private static native int
libPickSplit(int pgno, int splitItems[]);

private static native int
libOpenScript(String filename) throws LibgistException;

private static native int
libGetCommand(int scriptId, LibgistCommand cmd) throws LibgistException;

// ignore LibgistException in this case, we're exiting
private static native void
libCleanup();

private static native void
libGetPredInfo(int root, int levels);

private static native void
libDisplay(int pgno, int highlights[], int numHighlights, Graphics g,
    Color normalColor, Color highlightColor, int width, int height)
    throws LibgistException;

private static native int
libGetNumInsertions();

private static native void
libSetDbgLevel(int dbgLevel);

private static native void
libHighlightSubtree(int root, int levels, int color);

private static native void
libHighlightSplit(int[] rightEntries, int numRight, int color);

private static native void
libHighlightPath(int topNode, int bottomNode, int color);

}