comirva.config
Class SunburstConfig

java.lang.Object
  extended by comirva.config.SunburstConfig
Direct Known Subclasses:
SunburstDefaultConfig

public class SunburstConfig
extends Object

This class represents a configuration for a Sunburst-Calculation.


Constructor Summary
SunburstConfig(int maxItemsPerNode, int maxDepth, double minImportance, Vector<String> rootTerms, int minFontSize, int maxFontSize)
          Creates a new instance of a Sunburst-Configuration.
 
Method Summary
 int getMaxDepth()
          Returns the maximum depth of the hierarchy to be included in the sunburst.
 int getMaxFontSize()
          Returns the maximum font size for labels.
 int getMaxItemsPerNode()
          Returns the maximum number of subnodes per sunburst-node.
 int getMinFontSize()
          Returns the minimun font size for labels.
 double getMinImportance()
          Returns the threshold for the importance of a node in degrees.
 Vector<String> getRootTerms()
          Returns a list of terms that are included in the root node.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SunburstConfig

public SunburstConfig(int maxItemsPerNode,
                      int maxDepth,
                      double minImportance,
                      Vector<String> rootTerms,
                      int minFontSize,
                      int maxFontSize)
Creates a new instance of a Sunburst-Configuration.

Parameters:
maxItemsPerNode - maximum children per node
maxDepth - maximum depth of hierarchy
minImportance - threshold for importance (nodes with importance below it will be excluded from the sunburst)
rootTerms - a Vector containing the terms that must be included in the root node
See Also:
SunburstNode
Method Detail

getMaxDepth

public int getMaxDepth()
Returns the maximum depth of the hierarchy to be included in the sunburst.

Returns:
returns the maximum hierarchy depth

getMaxItemsPerNode

public int getMaxItemsPerNode()
Returns the maximum number of subnodes per sunburst-node.

Returns:
returns the maximum number of subnodes for every node of the sunburst.

getMinImportance

public double getMinImportance()
Returns the threshold for the importance of a node in degrees.

Returns:
returns the minimum importance of a node (so that it will still be included in the sunburst)

getRootTerms

public Vector<String> getRootTerms()
Returns a list of terms that are included in the root node. Based on these terms, the sunburst will be constructed.

Returns:
returns the terms of the root node

getMaxFontSize

public int getMaxFontSize()
Returns the maximum font size for labels.

Returns:
returns the maximum font size in pt

getMinFontSize

public int getMinFontSize()
Returns the minimun font size for labels.

Returns:
returns the minimum font size in pt