Gephi Toolkit Javadoc

org.gephi.dynamic.api
Interface DynamicGraph


public interface DynamicGraph

The wrapper for graph and time interval.

Author:
Cezary Bartosiak

Method Summary
 java.lang.Object[] getAttributesValues(Edge edge, double point)
          Returns values of attributes of the given Edge in the given point of time using Estimator.FIRST for each dynamic attribute.
 java.lang.Object[] getAttributesValues(Edge edge, double low, double high)
          Returns values of attributes of the given Edge in the given time interval of time using Estimator.FIRST for each dynamic attribute.
 java.lang.Object[] getAttributesValues(Edge edge, double low, double high, Estimator[] estimators)
          Returns values of attributes of the given Edge in the given time interval of time using given Estimators.
 java.lang.Object[] getAttributesValues(Edge edge, double point, Estimator[] estimators)
          Returns values of attributes of the given Edge in the given point of time using given Estimators.
 java.lang.Object[] getAttributesValues(Edge edge, Interval interval)
          Returns values of attributes of the given Edge in the given time interval of time using Estimator.FIRST for each dynamic attribute.
 java.lang.Object[] getAttributesValues(Edge edge, Interval interval, Estimator[] estimators)
          Returns values of attributes of the given Edge in the given time interval of time using given Estimators.
 java.lang.Object[] getAttributesValues(Node node, double point)
          Returns values of attributes of the given Node in the given point of time using Estimator.FIRST for each dynamic attribute.
 java.lang.Object[] getAttributesValues(Node node, double low, double high)
          Returns values of attributes of the given Node in the given time interval of time using Estimator.FIRST for each dynamic attribute.
 java.lang.Object[] getAttributesValues(Node node, double low, double high, Estimator[] estimators)
          Returns values of attributes of the given Node in the given time interval of time using given Estimators.
 java.lang.Object[] getAttributesValues(Node node, double point, Estimator[] estimators)
          Returns values of attributes of the given Node in the given point of time using given Estimators.
 java.lang.Object[] getAttributesValues(Node node, Interval interval)
          Returns values of attributes of the given Node in the given time interval of time using Estimator.FIRST for each dynamic attribute.
 java.lang.Object[] getAttributesValues(Node node, Interval interval, Estimator[] estimators)
          Returns values of attributes of the given Node in the given time interval of time using given Estimators.
 double getHigh()
          Returns the right endpoint of the time interval wrapped by this DynamicGraph.
 TimeInterval getInterval()
          Returns the time interval wrapped by this DynamicGraph.
 double getLow()
          Returns the left endpoint of the time interval wrapped by this DynamicGraph.
 Graph getSnapshotGraph(double point)
          Returns a "snapshot graph", i.e.
 Graph getSnapshotGraph(double low, double high)
          Returns a "snapshot graph", i.e.
 Graph getSnapshotGraph(double low, double high, Estimator estimator)
          Returns a "snapshot graph", i.e.
 Graph getSnapshotGraph(double point, Estimator estimator)
          Returns a "snapshot graph", i.e.
 Graph getSnapshotGraph(Interval interval)
          Returns a "snapshot graph", i.e.
 Graph getSnapshotGraph(Interval interval, Estimator estimator)
          Returns a "snapshot graph", i.e.
 Graph getStrongSnapshotGraph(double point)
          Returns a "strong snapshot graph", i.e.
 Graph getStrongSnapshotGraph(double low, double high)
          Returns a "strong snapshot graph", i.e.
 Graph getStrongSnapshotGraph(Interval interval)
          Returns a "strong snapshot graph", i.e.
 Graph getUnderlyingGraph()
          Returns the wrapped graph.
 void setInterval(double low, double high)
          Sets the time interval wrapped by this DynamicGraph.
 void setInterval(TimeInterval interval)
          Sets the time interval wrapped by this DynamicGraph.
 

Method Detail

getAttributesValues

java.lang.Object[] getAttributesValues(Node node,
                                       double point)
Returns values of attributes of the given Node in the given point of time using Estimator.FIRST for each dynamic attribute.

Parameters:
node - the given Node
point - the given point of time
Returns:
values of attributes of the given Node in the given point of time using Estimator.FIRST for each dynamic attribute.
Throws:
java.lang.IllegalArgumentException - if point is out of range wrapped by this DynamicGraph.

getAttributesValues

java.lang.Object[] getAttributesValues(Node node,
                                       double point,
                                       Estimator[] estimators)
Returns values of attributes of the given Node in the given point of time using given Estimators. The length of the estimators table must be the same as the count of attributes. Otherwise an IllegalArgumentException will be thrown.

Note that it doesn't matter what estimators you give for 'static' attributes.

Parameters:
node - the given Node
point - the given point of time
estimators - determine how to estimate individual values
Returns:
values of attributes of the given Node in the given point of time using given Estimators.
Throws:
java.lang.IllegalArgumentException - if point is out of range wrapped by this DynamicGraph.
java.lang.IllegalArgumentException - if the length of the estimators table differ from the count of attributes.

getAttributesValues

java.lang.Object[] getAttributesValues(Node node,
                                       double low,
                                       double high)
Returns values of attributes of the given Node in the given time interval of time using Estimator.FIRST for each dynamic attribute. Both bounds are included by default.

Parameters:
node - the given Node
low - the left endpoint of the given time interval
high - the right endpoint of the given time interval
Returns:
values of attributes of the given Node in the given time interval of time using Estimator.FIRST for each dynamic attribute.
Throws:
java.lang.IllegalArgumentException - if low > high or the time interval [low, high] is out of range wrapped by this DynamicGraph.

getAttributesValues

java.lang.Object[] getAttributesValues(Node node,
                                       Interval interval)
Returns values of attributes of the given Node in the given time interval of time using Estimator.FIRST for each dynamic attribute.

Parameters:
node - the given Node
interval - the given time interval
Returns:
values of attributes of the given Node in the given time interval of time using Estimator.FIRST for each dynamic attribute.
Throws:
java.lang.IllegalArgumentException - if the given time interval is out of range wrapped by this DynamicGraph.

getAttributesValues

java.lang.Object[] getAttributesValues(Node node,
                                       double low,
                                       double high,
                                       Estimator[] estimators)
Returns values of attributes of the given Node in the given time interval of time using given Estimators. The length of the estimators table must be the same as the count of attributes. Otherwise an IllegalArgumentException will be thrown. Both bounds are included by default.

Note that it doesn't matter what estimators you give for 'static' attributes.

Parameters:
node - the given Node
low - the left endpoint of the given time interval
high - the right endpoint of the given time interval
estimators - determine how to estimate individual values
Returns:
values of attributes of the given Node in the given time interval of time using given Estimators.
Throws:
java.lang.IllegalArgumentException - if low > high or the time interval [low, high] is out of range wrapped by this DynamicGraph.
java.lang.IllegalArgumentException - if the length of the estimators table differ from the count of attributes.

getAttributesValues

java.lang.Object[] getAttributesValues(Node node,
                                       Interval interval,
                                       Estimator[] estimators)
Returns values of attributes of the given Node in the given time interval of time using given Estimators. The length of the estimators table must be the same as the count of attributes. Otherwise an IllegalArgumentException will be thrown.

Note that it doesn't matter what estimators you give for 'static' attributes.

Parameters:
node - the given Node
interval - the given time interval
estimators - determine how to estimate individual values
Returns:
values of attributes of the given Node in the given time interval of time using given Estimators.
Throws:
java.lang.IllegalArgumentException - if the given time interval is out of range wrapped by this DynamicGraph.
java.lang.IllegalArgumentException - if the length of the estimators table differ from the count of attributes.

getAttributesValues

java.lang.Object[] getAttributesValues(Edge edge,
                                       double point)
Returns values of attributes of the given Edge in the given point of time using Estimator.FIRST for each dynamic attribute.

Parameters:
edge - the given Edge
point - the given point of time
Returns:
values of attributes of the given Edge in the given point of time using Estimator.FIRST for each dynamic attribute.
Throws:
java.lang.IllegalArgumentException - if point is out of range wrapped by this DynamicGraph.

getAttributesValues

java.lang.Object[] getAttributesValues(Edge edge,
                                       double point,
                                       Estimator[] estimators)
Returns values of attributes of the given Edge in the given point of time using given Estimators. The length of the estimators table must be the same as the count of attributes. Otherwise an IllegalArgumentException will be thrown.

Note that it doesn't matter what estimators you give for 'static' attributes.

Parameters:
edge - the given Edge
point - the given point of time
estimators - determine how to estimate individual values
Returns:
values of attributes of the given Edge in the given point of time using given Estimators.
Throws:
java.lang.IllegalArgumentException - if point is out of range wrapped by this DynamicGraph.
java.lang.IllegalArgumentException - if the length of the estimators table differ from the count of attributes.

getAttributesValues

java.lang.Object[] getAttributesValues(Edge edge,
                                       double low,
                                       double high)
Returns values of attributes of the given Edge in the given time interval of time using Estimator.FIRST for each dynamic attribute. Both bounds are included by default.

Parameters:
edge - the given Edge
low - the left endpoint of the given time interval
high - the right endpoint of the given time interval
Returns:
values of attributes of the given Edge in the given time interval of time using Estimator.FIRST for each dynamic attribute.
Throws:
java.lang.IllegalArgumentException - if low > high or the time interval [low, high] is out of range wrapped by this DynamicGraph.

getAttributesValues

java.lang.Object[] getAttributesValues(Edge edge,
                                       Interval interval)
Returns values of attributes of the given Edge in the given time interval of time using Estimator.FIRST for each dynamic attribute.

Parameters:
edge - the given Edge
interval - the given time interval
Returns:
values of attributes of the given Edge in the given time interval of time using Estimator.FIRST for each dynamic attribute.
Throws:
java.lang.IllegalArgumentException - if the given time interval is out of range wrapped by this DynamicGraph.

getAttributesValues

java.lang.Object[] getAttributesValues(Edge edge,
                                       double low,
                                       double high,
                                       Estimator[] estimators)
Returns values of attributes of the given Edge in the given time interval of time using given Estimators. The length of the estimators table must be the same as the count of attributes. Otherwise an IllegalArgumentException will be thrown.

Note that it doesn't matter what estimators you give for 'static' attributes.

Parameters:
edge - the given Edge
low - the left endpoint of the given time interval
high - the right endpoint of the given time interval
estimators - determine how to estimate individual values
Returns:
values of attributes of the given Edge in the given time interval of time using given Estimators.
Throws:
java.lang.IllegalArgumentException - if low > high or the time interval [low, high] is out of range wrapped by this DynamicGraph.
java.lang.IllegalArgumentException - if the length of the estimators table differ from the count of attributes.

getAttributesValues

java.lang.Object[] getAttributesValues(Edge edge,
                                       Interval interval,
                                       Estimator[] estimators)
Returns values of attributes of the given Edge in the given time interval of time using given Estimators. The length of the estimators table must be the same as the count of attributes. Otherwise an IllegalArgumentException will be thrown.

Note that it doesn't matter what estimators you give for 'static' attributes.

Parameters:
edge - the given Edge
interval - the given time interval
estimators - determine how to estimate individual values
Returns:
values of attributes of the given Edge in the given time interval of time using given Estimators.
Throws:
java.lang.IllegalArgumentException - if the given time interval is out of range wrapped by this DynamicGraph.
java.lang.IllegalArgumentException - if the length of the estimators table differ from the count of attributes.

getLow

double getLow()
Returns the left endpoint of the time interval wrapped by this DynamicGraph.

Returns:
the left endpoint of the time interval wrapped by this DynamicGraph.

getHigh

double getHigh()
Returns the right endpoint of the time interval wrapped by this DynamicGraph.

Returns:
the right endpoint of the time interval wrapped by this DynamicGraph.

getSnapshotGraph

Graph getSnapshotGraph(double point)
Returns a "snapshot graph", i.e. a graph for the given point of time. The default estimator is used (Estimator.FIRST). It means that the first time intervals of nodes/edges are checked for overlapping with the point.

Parameters:
point - the given point of time
Returns:
a "snapshot graph", i.e. a graph for the given point of time.
Throws:
java.lang.IllegalArgumentException - if point is out of range wrapped by this DynamicGraph.

getSnapshotGraph

Graph getSnapshotGraph(double point,
                       Estimator estimator)
Returns a "snapshot graph", i.e. a graph for the given point of time using the given Estimator. It means that time intervals of nodes/edges determined by the Estimator are checked for overlapping with the point.

Parameters:
point - the given point of time
estimator - determines how to estimate a snapshot
Returns:
a "snapshot graph", i.e. a graph for the given point of time.
Throws:
java.lang.IllegalArgumentException - if point is out of range wrapped by this DynamicGraph.

getSnapshotGraph

Graph getSnapshotGraph(double low,
                       double high)
Returns a "snapshot graph", i.e. a graph for the given time interval. The default estimator is used (Estimator.FIRST). It means that the first time intervals of nodes/edges are checked for overlapping with the time interval [low, high].

Parameters:
low - the left endpoint of the given time interval
high - the right endpoint of the given time interval
Returns:
a "snapshot graph", i.e. a graph for the given time interval.
Throws:
java.lang.IllegalArgumentException - if low > high or the time interval [low, high] is out of range wrapped by this DynamicGraph.

getSnapshotGraph

Graph getSnapshotGraph(Interval interval)
Returns a "snapshot graph", i.e. a graph for the given time interval. The default estimator is used (Estimator.FIRST). It means that the first time intervals of nodes/edges are checked for overlapping with the given time interval.

Parameters:
interval - the given time interval
Returns:
a "snapshot graph", i.e. a graph for the given time interval.
Throws:
java.lang.IllegalArgumentException - if the given time interval is out of range wrapped by this DynamicGraph.

getSnapshotGraph

Graph getSnapshotGraph(double low,
                       double high,
                       Estimator estimator)
Returns a "snapshot graph", i.e. a graph for the given time interval using the given Estimator. It means that time intervals of nodes/edges determined by the Estimator are checked for overlapping with the time interval [low, high].

Parameters:
low - the left endpoint of the given time interval
high - the right endpoint of the given time interval
estimator - determines how to estimate a snapshot
Returns:
a "snapshot graph", i.e. a graph for the given time interval.
Throws:
java.lang.IllegalArgumentException - if low > high or the time interval [low, high] is out of range wrapped by this DynamicGraph.

getSnapshotGraph

Graph getSnapshotGraph(Interval interval,
                       Estimator estimator)
Returns a "snapshot graph", i.e. a graph for the given time interval using the given Estimator. It means that time intervals of nodes/edges determined by the Estimator are checked for overlapping with the given time interval.

Parameters:
interval - the given time interval
estimator - determines how to estimate a snapshot
Returns:
a "snapshot graph", i.e. a graph for the given time interval.
Throws:
java.lang.IllegalArgumentException - if the given time interval is out of range wrapped by this DynamicGraph.

getStrongSnapshotGraph

Graph getStrongSnapshotGraph(double point)
Returns a "strong snapshot graph", i.e. a graph for the given point of time. "Strong" means that if EVERY time interval of considered node/edge overlaps with the point it is considered as a part of snapshot.

Parameters:
point - the given point of time
Returns:
a "snapshot graph", i.e. a graph for the given point of time.
Throws:
java.lang.IllegalArgumentException - if point is out of range wrapped by this DynamicGraph.

getStrongSnapshotGraph

Graph getStrongSnapshotGraph(double low,
                             double high)
Returns a "strong snapshot graph", i.e. a graph for the given time interval. "Strong" means that if EVERY time interval of considered node/edge overlaps with the time interval [low, high] it is considered as a part of snapshot.

Parameters:
low - the left endpoint of the given time interval
high - the right endpoint of the given time interval
Returns:
a "snapshot graph", i.e. a graph for the given time interval.
Throws:
java.lang.IllegalArgumentException - if low > high or the time interval [low, high] is out of range wrapped by this DynamicGraph.

getStrongSnapshotGraph

Graph getStrongSnapshotGraph(Interval interval)
Returns a "strong snapshot graph", i.e. a graph for the given time interval. "Strong" means that if EVERY time interval of considered node/edge overlaps with the given time interval it is considered as a part of snapshot.

Parameters:
interval - the given time interval
Returns:
a "snapshot graph", i.e. a graph for the given time interval.
Throws:
java.lang.IllegalArgumentException - if the given time interval is out of range wrapped by this DynamicGraph.

getUnderlyingGraph

Graph getUnderlyingGraph()
Returns the wrapped graph.

Returns:
the wrapped graph.

getInterval

TimeInterval getInterval()
Returns the time interval wrapped by this DynamicGraph.

Returns:
the time interval wrapped by this DynamicGraph.

setInterval

void setInterval(TimeInterval interval)
Sets the time interval wrapped by this DynamicGraph.

Parameters:
interval - an object to get endpoints from

setInterval

void setInterval(double low,
                 double high)
Sets the time interval wrapped by this DynamicGraph.

Parameters:
low - the left endpoint
high - the right endpoint

Gephi Toolkit Javadoc