Package org.neo4j.gds.config

Interface GraphProjectFromStoreConfig

All Superinterfaces:

org.neo4j.gds.config.BaseConfig, GraphProjectConfig, JobIdConfig, org.neo4j.gds.config.ToMapConvertible

@Configuration
public interface GraphProjectFromStoreConfig
extends GraphProjectConfig

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.gds.config.GraphProjectConfig

GraphProjectConfig.Cases<R>, GraphProjectConfig.Visitor

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NODE_PROJECTION_KEY
static java.lang.String	NODE_PROPERTIES_KEY
static java.lang.String	RELATIONSHIP_PROJECTION_KEY
static java.lang.String	RELATIONSHIP_PROPERTIES_KEY

Fields inherited from interface org.neo4j.gds.config.BaseConfig

SUDO_KEY

Fields inherited from interface org.neo4j.gds.config.GraphProjectConfig

IMPLICIT_GRAPH_NAME, NODE_COUNT_KEY, READ_CONCURRENCY_KEY, RELATIONSHIP_COUNT_KEY, VALIDATE_RELATIONSHIPS_KEY

Method Summary

Modifier and Type	Method	Description
default <R> R	accept(GraphProjectConfig.Cases<R> visitor)
static GraphProjectFromStoreConfig	all(java.lang.String userName, java.lang.String graphName)
static GraphProjectFromStoreConfig	emptyWithName(java.lang.String userName, java.lang.String graphName)
static GraphProjectFromStoreConfig	fromProcedureConfig(java.lang.String username, org.neo4j.gds.core.CypherMapWrapper config)
default GraphStoreFactory.Supplier	graphStoreFactory()
org.neo4j.gds.NodeProjections	nodeProjections()
default org.neo4j.gds.PropertyMappings	nodeProperties()
static GraphProjectFromStoreConfig	of(java.lang.String userName, java.lang.String graphName, java.lang.Object nodeProjections, java.lang.Object relationshipProjections, org.neo4j.gds.core.CypherMapWrapper config)
default java.util.Set<java.lang.String>	outputFieldDenylist()
org.neo4j.gds.RelationshipProjections	relationshipProjections()
default org.neo4j.gds.PropertyMappings	relationshipProperties()
default void	validateProjectionsAreNotEmpty()
default void	verifyProperties(java.util.Set<java.lang.String> propertiesFromMapping, java.util.Set<java.lang.String> propertiesFromProjection, java.lang.String type)
default GraphProjectFromStoreConfig	withNormalizedPropertyMappings()

Methods inherited from interface org.neo4j.gds.config.BaseConfig

configKeys, sudo, toMap, usernameOverride

Methods inherited from interface org.neo4j.gds.config.GraphProjectConfig

creationTime, graphName, isFictitiousLoading, nodeCount, readConcurrency, relationshipCount, username, validateReadConcurrency, validateRelationships

Methods inherited from interface org.neo4j.gds.config.JobIdConfig

jobId

Field Detail

NODE_PROJECTION_KEY

static final java.lang.String NODE_PROJECTION_KEY

See Also:

Constant Field Values

RELATIONSHIP_PROJECTION_KEY

static final java.lang.String RELATIONSHIP_PROJECTION_KEY

See Also:

Constant Field Values

NODE_PROPERTIES_KEY

static final java.lang.String NODE_PROPERTIES_KEY

See Also:

Constant Field Values

RELATIONSHIP_PROPERTIES_KEY

static final java.lang.String RELATIONSHIP_PROPERTIES_KEY

See Also:

Constant Field Values

Method Detail

nodeProjections

@Key("nodeProjection")
@ConvertWith("org.neo4j.gds.AbstractNodeProjections#fromObject")
@ToMapValue("org.neo4j.gds.AbstractNodeProjections#toObject")
org.neo4j.gds.NodeProjections nodeProjections()

relationshipProjections

@Key("relationshipProjection")
@ConvertWith("org.neo4j.gds.AbstractRelationshipProjections#fromObject")
@ToMapValue("org.neo4j.gds.AbstractRelationshipProjections#toObject")
org.neo4j.gds.RelationshipProjections relationshipProjections()

nodeProperties

@Default
@Parameter(false)
@ConvertWith("org.neo4j.gds.AbstractPropertyMappings#fromObject")
default org.neo4j.gds.PropertyMappings nodeProperties()

relationshipProperties

@Default
@Parameter(false)
@ConvertWith("org.neo4j.gds.AbstractPropertyMappings#fromObject")
default org.neo4j.gds.PropertyMappings relationshipProperties()

graphStoreFactory

@Ignore
default GraphStoreFactory.Supplier graphStoreFactory()

Specified by:

graphStoreFactory in interface GraphProjectConfig

validateProjectionsAreNotEmpty

@Check
default void validateProjectionsAreNotEmpty()

withNormalizedPropertyMappings

@Check
default GraphProjectFromStoreConfig withNormalizedPropertyMappings()

verifyProperties

@Ignore
default void verifyProperties(java.util.Set<java.lang.String> propertiesFromMapping,
                              java.util.Set<java.lang.String> propertiesFromProjection,
                              java.lang.String type)

accept

@Ignore
default <R> R accept(GraphProjectConfig.Cases<R> visitor)

Specified by:

accept in interface GraphProjectConfig

outputFieldDenylist

@Derived
@Ignore
default java.util.Set<java.lang.String> outputFieldDenylist()

emptyWithName

static GraphProjectFromStoreConfig emptyWithName(java.lang.String userName,
                                                 java.lang.String graphName)

of

static GraphProjectFromStoreConfig of(java.lang.String userName,
                                      java.lang.String graphName,
                                      java.lang.Object nodeProjections,
                                      java.lang.Object relationshipProjections,
                                      org.neo4j.gds.core.CypherMapWrapper config)

all

static GraphProjectFromStoreConfig all(java.lang.String userName,
                                       java.lang.String graphName)

fromProcedureConfig

static GraphProjectFromStoreConfig fromProcedureConfig(java.lang.String username,
                                                       org.neo4j.gds.core.CypherMapWrapper config)