com.yworks.yfiles.algorithms

Class DataProviders

java.lang.Object

com.yworks.yfiles.algorithms.DataProviders

public final class DataProviders
extends Object

This class provides convenience and transformation services for DataProviders.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataProviders.DataProviderOverlayManager This helper class can be used to overlay DataProviders registered at a graph with another DataProvider.

Method Summary

Modifier and Type	Method and Description
static IDataProvider	createConstantDataProvider(Object data) Returns a DataProvider that returns the given value for each key.
static IDataProvider	createEdgeDataProvider(boolean[] data) Returns a DataProvider view of a boolean array defined for edges.
static IDataProvider	createEdgeDataProvider(double[] data) Returns a DataProvider view of a double array defined for edges.
static IDataProvider	createEdgeDataProvider(double[] doubleData, int[] intData, boolean[] boolData, Object[] objectData) Returns a DataProvider view of a double, int, boolean and Object array defined for edges.
static IDataProvider	createEdgeDataProvider(int[] data) Returns a DataProvider view of an int array defined for edges.
static IDataProvider	createEdgeDataProvider(Object[] data) Returns a DataProvider view of an Object array defined for edges.
static IDataProvider	createNegatedDataProvider(IDataProvider data) Returns a DataProvider that returns the negated boolean values provided by another data provider.
static IDataProvider	createNodeDataProvider(boolean[] data) Returns a DataProvider view of a boolean array defined for nodes.
static IDataProvider	createNodeDataProvider(double[] data) Returns a DataProvider view of a double array defined for nodes.
static IDataProvider	createNodeDataProvider(double[] doubleData, int[] intData, boolean[] boolData, Object[] objectData) Returns a DataProvider view of a double, int, boolean and Object array defined for nodes.
static IDataProvider	createNodeDataProvider(int[] data) Returns a DataProvider view of an int array defined for nodes.
static IDataProvider	createNodeDataProvider(Object[] data) Returns a DataProvider view of an Object array defined for nodes.
static IDataProvider	createSourceDataProvider(IDataProvider nodeData) Returns a DataProvider for edges that return the data provider values bound to their source nodes.
static IDataProvider	createTargetDataProvider(IDataProvider nodeData) Returns a DataProvider for edges that return the data provider values bound to their target nodes.

Methods inherited from class java.lang.Object

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

Method Detail

createConstantDataProvider

public static final IDataProvider createConstantDataProvider(Object data)

Returns a DataProvider that returns the given value for each key.

Parameters:

data - constant Object data returned by the created data provider.

Returns:

a data provider view of a single value.

createEdgeDataProvider

public static final IDataProvider createEdgeDataProvider(boolean[] data)

Returns a DataProvider view of a boolean array defined for edges.

The boolean value data[edge.index()] will be returned by the data provider upon the method call getBool(edge).

Parameters:

data - array data for each edge of a static graph

Returns:

a data provider view of the given array

createEdgeDataProvider

public static final IDataProvider createEdgeDataProvider(double[] data)

Returns a DataProvider view of a double array defined for edges.

The double value data[edge.index()] will be returned by the data provider upon the method call getDouble(edge).

Parameters:

data - array data for each edge of a static graph

Returns:

a data provider view of the given array

createEdgeDataProvider

public static final IDataProvider createEdgeDataProvider(double[] doubleData,
                                                         int[] intData,
                                                         boolean[] boolData,
                                                         Object[] objectData)

Returns a DataProvider view of a double, int, boolean and Object array defined for edges.

The double value doubleData[edge.index()] will be returned by the data provider upon the method call getDouble(edge).

The int value intData[edge.index()] will be returned by the data provider upon the method call getInt(edge).

The boolean value boolData[edge.index()] will be returned by the data provider upon the method call getBool(edge).

The Object value objectData[edge.index()] will be returned by the data provider upon the method call get(edge).

Parameters:

doubleData - double data for each edge of a static graph

intData - int data for each edge of a static graph

boolData - boolean data for each edge of a static graph

objectData - Object data for each edge of a static graph

Returns:

a data provider view of the given arrays

createEdgeDataProvider

public static final IDataProvider createEdgeDataProvider(int[] data)

Returns a DataProvider view of an int array defined for edges.

The int value data[edge.index()] will be returned by the data provider upon the method call getInt(edge).

Parameters:

data - array data for each edge of a static graph

Returns:

a data provider view of the given array

createEdgeDataProvider

public static final IDataProvider createEdgeDataProvider(Object[] data)

Returns a DataProvider view of an Object array defined for edges.

The Object value data[edge.index()] will be returned by the data provider upon the method call get(edge).

Parameters:

data - array data for each edge of a static graph

Returns:

a data provider view of the given array

createNegatedDataProvider

public static final IDataProvider createNegatedDataProvider(IDataProvider data)

Returns a DataProvider that returns the negated boolean values provided by another data provider.

createNodeDataProvider

public static final IDataProvider createNodeDataProvider(boolean[] data)

Returns a DataProvider view of a boolean array defined for nodes.

The boolean value data[node.index()] will be returned by the data provider upon the method call getBool(node).

Parameters:

data - array data for each node of a static graph

Returns:

a data provider view of the given array

createNodeDataProvider

public static final IDataProvider createNodeDataProvider(double[] data)

Returns a DataProvider view of a double array defined for nodes.

The double value data[node.index()] will be returned by the data provider upon the method call getDouble(node).

Parameters:

data - array data for each node of a static graph

Returns:

a data provider view of the given array

createNodeDataProvider

public static final IDataProvider createNodeDataProvider(double[] doubleData,
                                                         int[] intData,
                                                         boolean[] boolData,
                                                         Object[] objectData)

Returns a DataProvider view of a double, int, boolean and Object array defined for nodes.

The double value doubleData[node.index()] will be returned by the data provider upon the method call getDouble(node).

The int value intData[node.index()] will be returned by the data provider upon the method call getInt(node).

The boolean value boolData[node.index()] will be returned by the data provider upon the method call getBool(node).

The Object value objectData[node.index()] will be returned by the data provider upon the method call get(node).

Parameters:

doubleData - double data for each node of a static graph

intData - int data for each node of a static graph

boolData - boolean data for each node of a static graph

objectData - Object data for each node of a static graph

Returns:

a data provider view of the given arrays

createNodeDataProvider

public static final IDataProvider createNodeDataProvider(int[] data)

Returns a DataProvider view of an int array defined for nodes.

The int value data[node.index()] will be returned by the data provider upon the method call getInt(node).

Parameters:

data - array data for each node of a static graph

Returns:

a data provider view of the given array

createNodeDataProvider

public static final IDataProvider createNodeDataProvider(Object[] data)

Returns a DataProvider view of an Object array defined for nodes.

The Object value data[node.index()] will be returned by the data provider upon the method call get(node).

Parameters:

data - array data for each node of a static graph

Returns:

a data provider view of the given array

createSourceDataProvider

public static final IDataProvider createSourceDataProvider(IDataProvider nodeData)

Returns a DataProvider for edges that return the data provider values bound to their source nodes.

createTargetDataProvider

public static final IDataProvider createTargetDataProvider(IDataProvider nodeData)

Returns a DataProvider for edges that return the data provider values bound to their target nodes.