org.gephi.ranking.api
Interface Transformer<Target>

public interface Transformer<Target>

Transformers role is to transform nodes/edges numerical attributes to visual signs (e.g. color or sizes). It uses a normalized real number between zero and one to output a meaningful value.

Transformers can be applied to a subset of values using lower/bound filter values.

Default transformers implemented in the RankingPlugin:

• RENDERABLE_COLOR: Sets node/edge color
• RENDERABLE_SIZE: Sets node/edge size. For edges, the size is the weight.
• LABEL_COLOR: Sets label color.
• LABEL_SIZE: Sets label size. Note this is a multiplier.

Author:

Mathieu Bastian

See Also:

Ranking

Field Summary

static java.lang.String	LABEL_COLOR
static java.lang.String	LABEL_SIZE
static java.lang.String	RENDERABLE_COLOR
static java.lang.String	RENDERABLE_SIZE

Method Summary

float	getLowerBound() Returns the lower bound filter value.
float	getUpperBound() Returns the upper bound filter value.
boolean	isInBounds(float value) Returns true if value is within the lower and the upper bound.
void	setLowerBound(float lowerBound) Sets the lower filter bound.
void	setUpperBound(float upperBound) Sets the upper filter bound.
java.lang.Object	transform(Target target, float normalizedValue) Transforms target with normalizedValue between zero and one.

Field Detail

RENDERABLE_COLOR

static final java.lang.String RENDERABLE_COLOR

See Also:

Constant Field Values

RENDERABLE_SIZE

static final java.lang.String RENDERABLE_SIZE

See Also:

Constant Field Values

LABEL_COLOR

static final java.lang.String LABEL_COLOR

See Also:

Constant Field Values

LABEL_SIZE

static final java.lang.String LABEL_SIZE

See Also:

Constant Field Values

Method Detail

setLowerBound

void setLowerBound(float lowerBound)

Sets the lower filter bound. Values lower than this value won't be transformed. By default the bound is set to zero, so no filtering.

Parameters:

lowerBound - the lower bound filter value

setUpperBound

void setUpperBound(float upperBound)

Sets the upper filter bound. Values upper than this value won't be transformed. By default the bound is set to one, so no filtering.

Parameters:

upperBound - the upper bound filter value

getLowerBound

float getLowerBound()

Returns the lower bound filter value. By default it's set to zero, so filtering is disabled.

Returns:

the lower bound filter value

getUpperBound

float getUpperBound()

Returns the upper bound filter value. By default it's set to one, so filtering is disabled.

Returns:

the upper bound filter value

isInBounds

boolean isInBounds(float value)

Returns true if value is within the lower and the upper bound. Typically, this is called before transform() to know if a value can be processed. By default, this always returns true, as lower bound is set ot zero and upper bound to one.

Parameters:

value - the value to test if in bounds

Returns:

true if value superior or equal to lowerBound and value inferior or equal to upperBound, false otherwise

transform

java.lang.Object transform(Target target,
                           float normalizedValue)

Transforms target with normalizedValue between zero and one. The method also returns the transformed value, like the color for instance for a color transformer.

Parameters:

target - the object to transform

normalizedValue - the ranking normalized value

Returns:

the transformed value, or null