org.gephi.appearance.api

Interface AppearanceModel

All Known Implementing Classes:

AppearanceModelImpl

public interface AppearanceModel

Entry point to access the appearance functions.

One model exists for each workspace.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AppearanceModel.GraphFunction Identifies the non-column-based functions.

Method Summary

Modifier and Type	Method and Description
Function	getEdgeFunction(org.gephi.graph.api.Graph graph, AppearanceModel.GraphFunction graphFunction, Class<? extends Transformer> transformer) Returns the edge function for the given graph function identifier and transformer.
Function	getEdgeFunction(org.gephi.graph.api.Graph graph, org.gephi.graph.api.Column column, Class<? extends Transformer> transformer) Returns the node function for the given column and transformer.
Function[]	getEdgeFunctions(org.gephi.graph.api.Graph graph) Returns all edge functions for the given graph.
Partition	getEdgePartition(org.gephi.graph.api.Graph graph, org.gephi.graph.api.Column column) Returns the edge partition for this graph and column.
Function	getNodeFunction(org.gephi.graph.api.Graph graph, AppearanceModel.GraphFunction graphFunction, Class<? extends Transformer> transformer) Returns the node function for the given graph function identifier and transformer.
Function	getNodeFunction(org.gephi.graph.api.Graph graph, org.gephi.graph.api.Column column, Class<? extends Transformer> transformer) Returns the node function for the given column and transformer.
Function[]	getNodeFunctions(org.gephi.graph.api.Graph graph) Returns all node functions for the given graph.
Partition	getNodePartition(org.gephi.graph.api.Graph graph, org.gephi.graph.api.Column column) Returns the node partition for this graph and column.
Workspace	getWorkspace() Return the workspace this model is associated with
boolean	isLocalScale() Returns true if rankings are using the currently visible graph as a scale.

Method Detail

getWorkspace

Workspace getWorkspace()

Return the workspace this model is associated with

Returns:

the workspace of this model

isLocalScale

boolean isLocalScale()

Returns true if rankings are using the currently visible graph as a scale. If false the complete graph is used to determine minimum and maximum values, the ranking scale.

Returns:

true if using a local scale, false if global scale

getNodePartition

Partition getNodePartition(org.gephi.graph.api.Graph graph,
                           org.gephi.graph.api.Column column)

Returns the node partition for this graph and column.

Parameters:

graph - graph

column - column

Returns:

node partition of null if it doesn't exist

getEdgePartition

Partition getEdgePartition(org.gephi.graph.api.Graph graph,
                           org.gephi.graph.api.Column column)

Returns the edge partition for this graph and column.

Parameters:

graph - graph

column - column

Returns:

edge partition of null if it doesn't exist

getNodeFunctions

Function[] getNodeFunctions(org.gephi.graph.api.Graph graph)

Returns all node functions for the given graph.

Parameters:

graph - graph

Returns:

all node functions

getNodeFunction

Function getNodeFunction(org.gephi.graph.api.Graph graph,
                         org.gephi.graph.api.Column column,
                         Class<? extends Transformer> transformer)

Returns the node function for the given column and transformer.

Parameters:

graph - graph

column - column

transformer - transformer class

Returns:

node function or null if not found

getNodeFunction

Function getNodeFunction(org.gephi.graph.api.Graph graph,
                         AppearanceModel.GraphFunction graphFunction,
                         Class<? extends Transformer> transformer)

Returns the node function for the given graph function identifier and transformer.

Parameters:

graph - graph

graphFunction - graphFunction

transformer - transformer class

Returns:

node function or null if not found

getEdgeFunctions

Function[] getEdgeFunctions(org.gephi.graph.api.Graph graph)

Returns all edge functions for the given graph.

Parameters:

graph - graph

Returns:

all edge functions

getEdgeFunction

Function getEdgeFunction(org.gephi.graph.api.Graph graph,
                         org.gephi.graph.api.Column column,
                         Class<? extends Transformer> transformer)

Returns the node function for the given column and transformer.

Parameters:

graph - graph

column - column

transformer - transformer class

Returns:

edge function or null if not found

getEdgeFunction

Function getEdgeFunction(org.gephi.graph.api.Graph graph,
                         AppearanceModel.GraphFunction graphFunction,
                         Class<? extends Transformer> transformer)

Returns the edge function for the given graph function identifier and transformer.

Parameters:

graph - graph

graphFunction - graphFunction

transformer - transformer class

Returns:

edge function or null if not found