Package org.neo4j.graphalgo.api

Class GraphStoreFactory<CONFIG extends GraphCreateConfig>

java.lang.Object

org.neo4j.graphalgo.api.GraphStoreFactory<CONFIG>

All Implemented Interfaces:

Assessable

Direct Known Subclasses:

CypherFactory, NativeFactory

public abstract class GraphStoreFactory<CONFIG extends GraphCreateConfig>
extends java.lang.Object
implements Assessable

The Abstract Factory defines the construction of the graph

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GraphStoreFactory.ImportResult
static interface	GraphStoreFactory.RelationshipImportResult
static interface	GraphStoreFactory.Supplier

Field Summary

Fields

Modifier and Type	Field	Description
protected GraphDimensions	dimensions
protected CONFIG	graphCreateConfig
protected GraphLoaderContext	loadingContext
protected ProgressLogger	progressLogger
static java.lang.String	TASK_LOADING

Constructor Summary

Constructors

Constructor	Description
GraphStoreFactory(CONFIG graphCreateConfig, GraphLoaderContext loadingContext, GraphDimensions dimensions)

Method Summary

Modifier and Type	Method	Description
abstract GraphStoreFactory.ImportResult	build()
protected GraphStore	createGraphStore(IdsAndProperties idsAndProperties, GraphStoreFactory.RelationshipImportResult relationshipImportResult, AllocationTracker tracker, GraphDimensions dimensions)
GraphDimensions	dimensions()
GraphDimensions	estimationDimensions()
protected abstract ProgressLogger	initProgressLogger()
abstract MemoryEstimation	memoryEstimation()	Returns an estimation about the memory consumption of that algorithm.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.neo4j.graphalgo.core.utils.mem.Assessable

memoryEstimation

Field Detail

TASK_LOADING

public static final java.lang.String TASK_LOADING

See Also:

Constant Field Values

graphCreateConfig

protected final CONFIG extends GraphCreateConfig graphCreateConfig

loadingContext

protected final GraphLoaderContext loadingContext

dimensions

protected final GraphDimensions dimensions

progressLogger

protected final ProgressLogger progressLogger

Constructor Detail

GraphStoreFactory

public GraphStoreFactory(CONFIG graphCreateConfig,
                         GraphLoaderContext loadingContext,
                         GraphDimensions dimensions)

Method Detail

build

public abstract GraphStoreFactory.ImportResult build()

memoryEstimation

public abstract MemoryEstimation memoryEstimation()

Description copied from interface: Assessable

Returns an estimation about the memory consumption of that algorithm. The memory estimation can be used to compute the actual consumption depending on GraphDimensions and concurrency.

Specified by:

memoryEstimation in interface Assessable

Returns:

memory estimation

See Also:

MemoryEstimations, MemoryEstimation.estimate(GraphDimensions, int)

dimensions

public GraphDimensions dimensions()

estimationDimensions

public GraphDimensions estimationDimensions()

initProgressLogger

protected abstract ProgressLogger initProgressLogger()

createGraphStore

protected GraphStore createGraphStore(IdsAndProperties idsAndProperties,
                                      GraphStoreFactory.RelationshipImportResult relationshipImportResult,
                                      AllocationTracker tracker,
                                      GraphDimensions dimensions)