Package org.neo4j.graphalgo.beta.pregel.context

Class InitContext<CONFIG extends PregelConfig>

java.lang.Object

org.neo4j.graphalgo.beta.pregel.context.PregelContext<CONFIG>

org.neo4j.graphalgo.beta.pregel.context.NodeCentricContext<CONFIG>

org.neo4j.graphalgo.beta.pregel.context.InitContext<CONFIG>

public final class InitContext<CONFIG extends PregelConfig>
extends NodeCentricContext<CONFIG>

A context that is used during the initialization phase, which is before the first superstep is being executed. The init context allows accessing node properties from the input graph which can be used to set initial node values for the Pregel computation.

Field Summary

Fields inherited from class org.neo4j.graphalgo.beta.pregel.context.NodeCentricContext

computeStep

Fields inherited from class org.neo4j.graphalgo.beta.pregel.context.PregelContext

config

Constructor Summary

Constructors

Constructor	Description
InitContext(Pregel.ComputeStep<CONFIG> computeStep, CONFIG config, NodePropertyContainer nodePropertyContainer)

Method Summary

Modifier and Type	Method	Description
NodeProperties	nodeProperties(java.lang.String key)	Returns the property values for the given property key.
java.util.Set<java.lang.String>	nodePropertyKeys()	Returns the node property keys stored in the input graph.

Methods inherited from class org.neo4j.graphalgo.beta.pregel.context.NodeCentricContext

degree, getNeighbours, getNeighbours, isMultiGraph, nodeCount, nodeId, relationshipCount, setNodeId, setNodeValue, setNodeValue, setNodeValue, setNodeValue

Methods inherited from class org.neo4j.graphalgo.beta.pregel.context.PregelContext

config

Methods inherited from class java.lang.Object

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

Constructor Detail

InitContext

public InitContext(Pregel.ComputeStep<CONFIG> computeStep,
                   CONFIG config,
                   NodePropertyContainer nodePropertyContainer)

Method Detail

nodePropertyKeys

public java.util.Set<java.lang.String> nodePropertyKeys()

Returns the node property keys stored in the input graph. These properties can be the result of previous computations or part of node projections when creating the graph.

nodeProperties

public NodeProperties nodeProperties(java.lang.String key)

Returns the property values for the given property key. Property values can be used to access individual node property values by using their node identifier.