Package com.scitools.understand

Class Database

java.lang.Object

com.scitools.understand.Database

public class Database
extends java.lang.Object

This class represents an understand Database. With the exception of close() all functions require the database be open.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the database.
Database	comparison_db()	Get the comparison database.
Entity[]	ents(java.lang.String kinds)	Retrieve a list of all the entities in the database.
boolean	equals(java.lang.Object obj)
int	hashCode()
java.lang.String[]	language()	Return the language names of languages enabled in the database.
Entity	lookup_uniquename(java.lang.String uniquename)	Retrieve an entity by it's unique name.
java.lang.Number	metric(java.lang.String name)	Return the value of a metric for the database
java.util.Map<java.lang.String,java.lang.Number>	metric(java.lang.String[] names)	Return the values for an array of metric names as a map from name to value.
java.lang.String[]	metrics()	Return a list of metric names available for the database.
byte[]	metrics_treemap(java.lang.String sizemetric, java.lang.String colormetric, java.lang.String enttype)	Generate a metric treemap with the given metrics and enttype.
java.lang.String	name()	Retrieve the filename of the database.

Methods inherited from class java.lang.Object

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

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

name

public java.lang.String name()

Retrieve the filename of the database.

Returns:

filename of database

close

public void close()

Close the database. This must be called to release all the memory associated with the database. Once it is called, the database and all associated objects (entities, references ...) become invalid. This function can safely be called on a database that is already closed.

metrics

public java.lang.String[] metrics()

Return a list of metric names available for the database.

Returns:

metric names

metric

public java.lang.Number metric(java.lang.String name)

Return the value of a metric for the database

Parameters:

name - The name of the metric. Must be a valid metric name, and not null.

Returns:

the value. Zero is returned if there is no value for the metric.

metric

public java.util.Map<java.lang.String,java.lang.Number> metric(java.lang.String[] names)

Return the values for an array of metric names as a map from name to value.

Parameters:

names - The names of metrics to retrieve values for

Returns:

A map from metric name to metric value.

ents

public Entity[] ents(java.lang.String kinds)

Retrieve a list of all the entities in the database. If kinds is specified, returns only entities that match the kindstring. For more information on kindstrings, see the Perl API documentation.

Parameters:

kinds - An optional parameter. If null, all entities are returned.

Returns:

An array of Entities.

language

public java.lang.String[] language()

Return the language names of languages enabled in the database.

Returns:

language names.

metrics_treemap

public byte[] metrics_treemap(java.lang.String sizemetric,
                              java.lang.String colormetric,
                              java.lang.String enttype)

Generate a metric treemap with the given metrics and enttype.

Parameters:

sizemetric - The api name of the metric used for size. Must not be null.

colormetric - The api name of the metric used for color. Must not be null.

enttype - Either "file" "class" or "function", represents the type to map. If null, default is "file".

Returns:

A byte array containing the jpg of the map.

lookup_uniquename

public Entity lookup_uniquename(java.lang.String uniquename)

Retrieve an entity by it's unique name. Returns null if can't be resolved.

Parameters:

uniquename -

Returns:

An Entity, if found, null otherwise.

comparison_db

public Database comparison_db()

Get the comparison database.

Returns:

an open database or null if no comparison database is set