Package org.gephi.appearance

Class RankingImpl

java.lang.Object

org.gephi.appearance.RankingImpl

All Implemented Interfaces:

Ranking

Direct Known Subclasses:

AttributeRankingImpl, DegreeRankingImpl, EdgeWeightRankingImpl

public abstract class RankingImpl
extends Object
implements Ranking

Author:

mbastian

Field Summary

Fields

Modifier and Type	Field	Description
static Interpolator	DEFAULT_INTERPOLATOR
protected Interpolator	interpolator

Constructor Summary

Constructors

Constructor	Description
RankingImpl()

Method Summary

Modifier and Type	Method	Description
org.gephi.graph.api.Column	getColumn()	Returns the column associated with this partition.
Interpolator	getInterpolator()
float	getNormalizedValue(org.gephi.graph.api.Element element, org.gephi.graph.api.Graph graph)	Returns the element's normalized value for this ranking.
abstract boolean	isValid(org.gephi.graph.api.Graph graph)
float	normalize(Number value, Interpolator interpolator, Number minValue, Number maxValue)	Normalizes the given value with the interpolator.
void	setInterpolator(Interpolator interpolator)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gephi.appearance.api.Ranking

getMaxValue, getMinValue, getValue

Field Detail

DEFAULT_INTERPOLATOR

public static Interpolator DEFAULT_INTERPOLATOR

interpolator

protected Interpolator interpolator

Constructor Detail

RankingImpl

public RankingImpl()

Method Detail

getInterpolator

public Interpolator getInterpolator()

setInterpolator

public void setInterpolator(Interpolator interpolator)

getNormalizedValue

public float getNormalizedValue(org.gephi.graph.api.Element element,
                                org.gephi.graph.api.Graph graph)

Description copied from interface: Ranking

Returns the element's normalized value for this ranking.

Specified by:

getNormalizedValue in interface Ranking

Parameters:

element - element to get the value for

graph - graph this element belongs to

Returns:

the normalized value for this ranking

normalize

public float normalize(Number value,
                       Interpolator interpolator,
                       Number minValue,
                       Number maxValue)

Description copied from interface: Ranking

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.

Specified by:

normalize in interface Ranking

Parameters:

value - value to normalize

interpolator - interpolator

Returns:

normalized value

isValid

public abstract boolean isValid(org.gephi.graph.api.Graph graph)

getColumn

public org.gephi.graph.api.Column getColumn()

Description copied from interface: Ranking

Returns the column associated with this partition.

Specified by:

getColumn in interface Ranking

Returns:

column or null if partition not based on a column