|
Gephi Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StatisticsUI
Statistics and Metrics UI integration information. Implement this interface for defining a new metric in the user interface.
One could define multiple StatisticsUI
that relies on a single
algorithm. StatisticsUIs therefore exist in the system alone, and wait for
setup()
method to be called to turn on with a compatible
Statistics instance.
Implementors must add @ServiceProvider annotation to be found by the system.
StatisticsBuilder
Field Summary | |
---|---|
static java.lang.String |
CATEGORY_EDGE_OVERVIEW
|
static java.lang.String |
CATEGORY_NETWORK_OVERVIEW
|
static java.lang.String |
CATEGORY_NODE_OVERVIEW
|
Method Summary | |
---|---|
java.lang.String |
getCategory()
Returns the category of this metric. |
java.lang.String |
getDisplayName()
Returns this statistics display name |
int |
getPosition()
Returns a position value, around 1 and 1000, that indicates the position of the Statistics in the UI. |
javax.swing.JPanel |
getSettingsPanel()
Returns a settings panel instance. |
java.lang.Class<? extends Statistics> |
getStatisticsClass()
Returns the statistics' class this UI belongs to. |
java.lang.String |
getValue()
Returns this statistics result as a String, if exists |
void |
setup(Statistics statistics)
Push a statistics instance to the UI to load its settings. |
void |
unsetup()
Notify the settings panel has been closed and that the settings values can be saved to the statistics instance. |
Field Detail |
---|
static final java.lang.String CATEGORY_NETWORK_OVERVIEW
static final java.lang.String CATEGORY_NODE_OVERVIEW
static final java.lang.String CATEGORY_EDGE_OVERVIEW
Method Detail |
---|
javax.swing.JPanel getSettingsPanel()
void setup(Statistics statistics)
getSettingsPanel
and before the
panel is displayed.
statistics
- the statistics instance that is linked to the UIvoid unsetup()
java.lang.Class<? extends Statistics> getStatisticsClass()
java.lang.String getValue()
java.lang.String getDisplayName()
java.lang.String getCategory()
int getPosition()
|
Gephi Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |