org.gephi.appearance.api

Interface Ranking

public interface Ranking

Ranking configuration for numerical attributes.

This interface has underlying access to the elements value so it can return the minimum and maximum values.

Method Summary

Modifier and Type	Method and Description
Number	getMaxValue() Returns the maximum value in this ranking.
Number	getMinValue() Returns the minimum value in this ranking.
Number	getValue(Element element, Graph graph) Returns the element's value for this ranking.
float	normalize(Number value, Interpolator interpolator) Normalizes the given value with the interpolator.

Method Detail

getMinValue

Number getMinValue()

Returns the minimum value in this ranking.

Returns:

minimum value

getMaxValue

Number getMaxValue()

Returns the maximum value in this ranking.

Returns:

maximum value

getValue

Number getValue(Element element,
                Graph graph)

Returns the element's value for this ranking.

Parameters:

element - element to get the value for

graph - graph this element belongs to

Returns:

the value for this ranking

normalize

float normalize(Number value,
                Interpolator interpolator)

Normalizes the given value with the interpolator.

The value is first put between zero and one by doing (value - min) / (max - min) and then passed to the given interpolator.

Parameters:

value - value to normalize

interpolator - interpolator

Returns:

normalized value