Package org.neo4j.gds

Class AlgoBaseProc<ALGO extends org.neo4j.gds.Algorithm<ALGO_RESULT>,ALGO_RESULT,CONFIG extends org.neo4j.gds.config.AlgoBaseConfig,PROC_RESULT>

java.lang.Object

org.neo4j.gds.BaseProc

org.neo4j.gds.AlgoBaseProc<ALGO,ALGO_RESULT,CONFIG,PROC_RESULT>

All Implemented Interfaces:

org.neo4j.gds.executor.AlgorithmSpec<ALGO,ALGO_RESULT,CONFIG,java.util.stream.Stream<PROC_RESULT>,org.neo4j.gds.AlgorithmFactory<?,ALGO,CONFIG>>

Direct Known Subclasses:

MutateProc, NodePropertiesWriter, StatsProc, StreamOfRelationshipsWriter, StreamProc, TrainProc, WriteRelationshipsProc

public abstract class AlgoBaseProc<ALGO extends org.neo4j.gds.Algorithm<ALGO_RESULT>,ALGO_RESULT,CONFIG extends org.neo4j.gds.config.AlgoBaseConfig,PROC_RESULT>
extends BaseProc
implements org.neo4j.gds.executor.AlgorithmSpec<ALGO,ALGO_RESULT,CONFIG,java.util.stream.Stream<PROC_RESULT>,org.neo4j.gds.AlgorithmFactory<?,ALGO,CONFIG>>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	STATS_DESCRIPTION

Fields inherited from class org.neo4j.gds.BaseProc

callContext, databaseService, ESTIMATE_DESCRIPTION, internalModelCatalog, log, procedureTransaction, taskRegistryFactory, transaction, userLogRegistryFactory, username

Constructor Summary

Constructors

Constructor	Description
AlgoBaseProc()

Method Summary

Modifier and Type	Method	Description
protected org.neo4j.gds.executor.ComputationResult<ALGO,ALGO_RESULT,CONFIG>	compute(java.lang.String graphName, java.util.Map<java.lang.String,java.lang.Object> configuration)
protected org.neo4j.gds.executor.ComputationResult<ALGO,ALGO_RESULT,CONFIG>	compute(java.lang.String graphName, java.util.Map<java.lang.String,java.lang.Object> configuration, boolean releaseAlgorithm, boolean releaseTopology)
protected java.util.stream.Stream<org.neo4j.gds.results.MemoryEstimateResult>	computeEstimate(java.lang.Object graphNameOrConfiguration, java.util.Map<java.lang.String,java.lang.Object> algoConfiguration)
org.neo4j.gds.executor.ProcConfigParser<CONFIG>	configParser()
java.lang.String	name()
protected abstract CONFIG	newConfig(java.lang.String username, org.neo4j.gds.core.CypherMapWrapper config)
org.neo4j.gds.executor.NewConfigFunction<CONFIG>	newConfigFunction()
protected org.neo4j.gds.api.properties.nodes.NodePropertyValues	nodeProperties(org.neo4j.gds.executor.ComputationResult<ALGO,ALGO_RESULT,CONFIG> computationResult)	Returns a single node property that has been produced by the procedure.
org.neo4j.gds.executor.validation.ValidationConfiguration<CONFIG>	validationConfig()

Methods inherited from class org.neo4j.gds.BaseProc

databaseId, executionContext, graphLoaderContext, graphStoreFromCatalog, isGdsAdmin, memoryUsageValidator, modelCatalog, runWithExceptionLogging, runWithExceptionLogging, setModelCatalog, username, validateConfig, validateConfig, validateGraphName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.neo4j.gds.executor.AlgorithmSpec

algorithmFactory, computationResultConsumer, createDefaultExecutorSpec, withModelCatalog

Field Detail

STATS_DESCRIPTION

public static final java.lang.String STATS_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

AlgoBaseProc

public AlgoBaseProc()

Method Detail

configParser

public org.neo4j.gds.executor.ProcConfigParser<CONFIG> configParser()

newConfig

protected abstract CONFIG newConfig(java.lang.String username,
                                    org.neo4j.gds.core.CypherMapWrapper config)

compute

protected org.neo4j.gds.executor.ComputationResult<ALGO,ALGO_RESULT,CONFIG> compute(java.lang.String graphName,
                                                                                                java.util.Map<java.lang.String,java.lang.Object> configuration)

compute

protected org.neo4j.gds.executor.ComputationResult<ALGO,ALGO_RESULT,CONFIG> compute(java.lang.String graphName,
                                                                                                java.util.Map<java.lang.String,java.lang.Object> configuration,
                                                                                                boolean releaseAlgorithm,
                                                                                                boolean releaseTopology)

nodeProperties

protected org.neo4j.gds.api.properties.nodes.NodePropertyValues nodeProperties(org.neo4j.gds.executor.ComputationResult<ALGO,ALGO_RESULT,CONFIG> computationResult)

Returns a single node property that has been produced by the procedure.

computeEstimate

protected java.util.stream.Stream<org.neo4j.gds.results.MemoryEstimateResult> computeEstimate(java.lang.Object graphNameOrConfiguration,
                                                                                              java.util.Map<java.lang.String,java.lang.Object> algoConfiguration)

name

public java.lang.String name()

Specified by:

name in interface org.neo4j.gds.executor.AlgorithmSpec<ALGO extends org.neo4j.gds.Algorithm<ALGO_RESULT>,ALGO_RESULT,CONFIG extends org.neo4j.gds.config.AlgoBaseConfig,java.util.stream.Stream<PROC_RESULT>,org.neo4j.gds.AlgorithmFactory<?,ALGO extends org.neo4j.gds.Algorithm<ALGO_RESULT>,CONFIG extends org.neo4j.gds.config.AlgoBaseConfig>>

newConfigFunction

public org.neo4j.gds.executor.NewConfigFunction<CONFIG> newConfigFunction()

Specified by:

newConfigFunction in interface org.neo4j.gds.executor.AlgorithmSpec<ALGO extends org.neo4j.gds.Algorithm<ALGO_RESULT>,ALGO_RESULT,CONFIG extends org.neo4j.gds.config.AlgoBaseConfig,java.util.stream.Stream<PROC_RESULT>,org.neo4j.gds.AlgorithmFactory<?,ALGO extends org.neo4j.gds.Algorithm<ALGO_RESULT>,CONFIG extends org.neo4j.gds.config.AlgoBaseConfig>>

validationConfig

public org.neo4j.gds.executor.validation.ValidationConfiguration<CONFIG> validationConfig()

Specified by:

validationConfig in interface org.neo4j.gds.executor.AlgorithmSpec<ALGO extends org.neo4j.gds.Algorithm<ALGO_RESULT>,ALGO_RESULT,CONFIG extends org.neo4j.gds.config.AlgoBaseConfig,java.util.stream.Stream<PROC_RESULT>,org.neo4j.gds.AlgorithmFactory<?,ALGO extends org.neo4j.gds.Algorithm<ALGO_RESULT>,CONFIG extends org.neo4j.gds.config.AlgoBaseConfig>>