org.gephi.appearance.api

Interface Function

All Known Subinterfaces:

AttributeFunction, GraphFunction, PartitionFunction, RankingFunction, SimpleFunction

All Known Implementing Classes:

AttributeFunctionImpl, FunctionImpl, GraphFunctionImpl, SimpleFunctionImpl

public interface Function

Functions represent the various transformations that can be applied to the graph elements. Each function is specific to an element class (i.e. nodes or edges), to a specific transformer and to a specific source (e.g. a ranking or a partition).

This interface has sub-interfaces specific to the type of function.

Method Summary

Modifier and Type	Method and Description
Class<? extends org.gephi.graph.api.Element>	getElementClass() Returns the element class this function will be applied to.
org.gephi.graph.api.Graph	getGraph() Returns the graph this function is based on.
<T extends Transformer> T	getTransformer() Returns the transformer associated with this function.
TransformerUI	getUI() Returns the transformer user interface associated with this function.
boolean	isAttribute() Returns true if this function is based on attribute column.
boolean	isPartition() Returns true if this function is a partition function.
boolean	isRanking() Returns true if this function is a ranking function.
boolean	isSimple() Returns true if this function is a simple function.
void	transform(org.gephi.graph.api.Element element, org.gephi.graph.api.Graph graph) Transforms the given element.

Method Detail

transform

void transform(org.gephi.graph.api.Element element,
               org.gephi.graph.api.Graph graph)

Transforms the given element.

Parameters:

element - element to transform

graph - the graph this element belongs to

getTransformer

<T extends Transformer> T getTransformer()

Returns the transformer associated with this function.

Type Parameters:

T - transformer class

Returns:

transformer

getUI

TransformerUI getUI()

Returns the transformer user interface associated with this function.

Returns:

transformer UI or null if not found

isSimple

boolean isSimple()

Returns true if this function is a simple function.

If true, this instance can be casted to SimpleFunction.

Returns:

true if partition, false otherwise

isAttribute

boolean isAttribute()

Returns true if this function is based on attribute column.

If true, this instance can be casted to AttributeFunction.

Returns:

true if attribute, false otherwise

isRanking

boolean isRanking()

Returns true if this function is a ranking function.

If true, this instance can be casted to RankingFunction.

Returns:

true if ranking, false otherwise

isPartition

boolean isPartition()

Returns true if this function is a partition function.

If true, this instance can be casted to PartitionFunction.

Returns:

true if partition, false otherwise

getGraph

org.gephi.graph.api.Graph getGraph()

Returns the graph this function is based on.

Returns:

graph

getElementClass

Class<? extends org.gephi.graph.api.Element> getElementClass()

Returns the element class this function will be applied to.

Returns:

element class