Package org.gephi.appearance.api

Interface AppearanceModel

  • public interface AppearanceModel
    Entry point to access the appearance functions.

    One model exists for each workspace.

    • Method Detail

      • getWorkspace

        Workspace getWorkspace()
        Return the workspace this model is associated with
        Returns:
        the workspace of this model

      • isRankingLocalScale

        boolean isRankingLocalScale()
        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.
        Returns:
        true if using a local scale, false if global scale

      • isPartitionLocalScale

        boolean isPartitionLocalScale()
        Returns true if partitions are using the currently visible graph as a source. If false the complete graph is used to determine partitions.
        Returns:
        true if using a local scale, false if global scale

      • isTransformNullValues

        boolean isTransformNullValues()
        Returns true if null values are considered in functions. If false elements with null values will be transformed as well. Default value is false.

        When using a ranking function, null values will receive the lowest normalised value.

        Returns:
        true if null values are transformed, false otherwise

      • getNodePartition

        Partition getNodePartition​(Column column)
        Returns the node partition for thid column.
        Parameters:
        column - column
        Returns:
        node partition of null if it doesn't exist

      • getEdgePartition

        Partition getEdgePartition​(Column column)
        Returns the edge partition for this column.
        Parameters:
        column - column
        Returns:
        edge partition of null if it doesn't exist

      • getNodeFunctions

        Function[] getNodeFunctions()
        Returns all node functions for the given graph.
        Returns:
        all node functions

      • getNodeFunction

        Function getNodeFunction​(Column column,
                         Class<? extends Transformer> transformer)
        Returns the node function for the given column and transformer.
        Parameters:
        column - column
        transformer - transformer
        Returns:
        node function or null if not found

      • getEdgeFunction

        Function getEdgeFunction​(Column column,
                         Class<? extends Transformer> transformer)
        Returns the edge function for the given column and transformer.
        Parameters:
        column - column
        transformer - transformer
        Returns:
        edge function or null if not found

      • getEdgeFunctions

        Function[] getEdgeFunctions()
        Returns all edge functions for the given graph.
        Returns:
        all edge functions

      • getGraphModel

        GraphModel getGraphModel()
        Returns the graph model this model is associated with.
        Returns:
        the graph model