charger

Class GraphMetrics

Object

charger.GraphMetrics

public class GraphMetrics
extends Object

Class to collect and organize various conceptual graph metrics for research purposes. Names of each metric don't use "camel-case" -- they use underscore-connected words so that each metric's name can be output to a text file and parsed as a single word with no spaces.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	actors
(package private) int	all_node_degrees
(package private) int	concept_degrees
(package private) int	concepts
(package private) TreeSet<String>	conceptTypeLabels
(package private) int	contexts
(package private) int	corefs
(package private) Graph	currentGraph
(package private) NumberFormat	nformat
(package private) int	relations
(package private) TreeSet<String>	relationTypeLabels
(package private) int	reltypes
private boolean	suppressZeroes
(package private) int	types

Constructor Summary

Constructors

Constructor and Description
GraphMetrics(Graph g) Instantiate a set of metrics for the given graph.

Method Summary

Modifier and Type	Method and Description
int	diameter(Graph g) Returns the "diameter" of the graph, which is defined as the longest shortest path between any two nodes of the graph.
String	getGraphMetrics(boolean compress) Create a text string containing tab-separated metrics and observations about the graph.
void	makeAllMetrics() Perform all the counts necessary for displaying the metrics.
String	showAllMetrics() Display the results of collecting all the measurements.
protected String	showOneMetric(String name, float value)
protected String	showString(String name, String value)

Methods inherited from class Object

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

Field Detail

currentGraph

Graph currentGraph

concepts

int concepts

relations

int relations

actors

int actors

contexts

int contexts

types

int types

reltypes

int reltypes

corefs

int corefs

concept_degrees

int concept_degrees

all_node_degrees

int all_node_degrees

conceptTypeLabels

TreeSet<String> conceptTypeLabels

relationTypeLabels

TreeSet<String> relationTypeLabels

nformat

NumberFormat nformat

suppressZeroes

private boolean suppressZeroes

Constructor Detail

GraphMetrics

public GraphMetrics(Graph g)

Instantiate a set of metrics for the given graph.

Parameters:

g - the top-level graph being measured. May include type/relation hierarchies, etc.

Method Detail

getGraphMetrics

public String getGraphMetrics(boolean compress)

Create a text string containing tab-separated metrics and observations about the graph. The set of metrics is currently fixed and cannot be changed by the programmer. Text filters such as perl can be used to manipulate the results. * @param compress whether to suppress zero values or not

makeAllMetrics

public void makeAllMetrics()

Perform all the counts necessary for displaying the metrics.

showString

protected String showString(String name,
                            String value)

showOneMetric

protected String showOneMetric(String name,
                               float value)

Parameters:

name - The human-readable name of the metric

value - The metric value to be printed

Returns:

HTML tagged string for a single metric

See Also:

suppressZeroes

showAllMetrics

public String showAllMetrics()

Display the results of collecting all the measurements. Will generate exception on an empty graph. The meaning of each of the metrics is as follows:

total_concept_instances	Number of concept instances (boxes) in the graph
total_relation_instances	Number of relation instances (ovals) in the graph
total_actor_instances	Number of actor instances (diamonds) in the graph
total_type_hierarchy_labels	Number of type label instances (underlined types) whether in hierarchies or not
total_relation_hierarchy_labels	Number of relation label instances (underlined relations) whether in hierarchies or not
total_lines_of_identity	Number of lines of identity (dashed lines) in the graph
total_contexts	Number of contexts (rectangular borders) in the graph
average_node_degree	Average number of arrows/lines-of-identity connected to each concept/relation/actor/context/etc.
average_concept_context_degree	Average number of arrows/lines-of-identity connected to concept or context only
number_of_unique_concept_types	Number of unique concept types (regardless of referent)
unique_concept_type_names	List of unique concept type names (ignoring referent)
number_of_unique_relation_types	Number of unique relation types
unique_relation_type_names	List of unique concept types (regardless of referent)
concept_type_variability	total_concept_instances / number_of_unique_concept_types
relation_type_variability	total_relation_instances / number_of_unique_relation_types

diameter

public int diameter(Graph g)

Returns the "diameter" of the graph, which is defined as the longest shortest path between any two nodes of the graph. Based on Dijkstra's algorithm.