Neo4jDatastore (Grails 8.0.0-SNAPSHOT)

org.grails.datastore.gorm.neo4j.Neo4jDatastore

All Implemented Interfaces and Traits:

java.io.Closeable, GraphDatastore, MessageSourceAware, MultiTenantCapableDatastore, MultipleConnectionSourceCapableDatastore, Settings, StatelessDatastore, TransactionCapableDatastore
```
public class Neo4jDatastore
extends AbstractDatastore
implements java.io.Closeable, GraphDatastore, MessageSourceAware, MultiTenantCapableDatastore, MultipleConnectionSourceCapableDatastore, Settings, StatelessDatastore, TransactionCapableDatastore
```
Datastore implementation for Neo4j backend
Authors:
Stefan Armbruster (stefan@armbruster-it.de)
Graeme Rocher
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`protected AutoTimestampEventListener`	`autoTimestampEventListener`
`protected Driver`	`boltDriver`
`protected ConnectionSources<Driver, Neo4jConnectionSourceSettings>`	`connectionSources`
`protected java.util.Map<java.lang.String, Neo4jDatastore>`	`datastoresByConnectionSource`
`protected FlushModeType`	`defaultFlushMode`
`protected ConfigurableApplicationEventPublisher`	`eventPublisher`
`protected GormEnhancer`	`gormEnhancer`
`protected MultiTenancyMode`	`multiTenancyMode`
`protected boolean`	`skipIndexSetup`
`protected TenantResolver`	`tenantResolver`
`protected Neo4jDatastoreTransactionManager`	`transactionManager`

Inherited fields
Fields inherited from class	Fields
`class AbstractDatastore`	`LOG, applicationEventPublisher, cacheAdapterRepository, connectionDetails, mappingContext, serviceRegistry`

Constructor Summary

Constructors
Constructor and description
`Neo4jDatastore(ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources, Neo4jMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources, java.lang.Class classes)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(Driver boltDriver, PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(Driver boltDriver, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(Driver boltDriver, PropertyResolver configuration, java.lang.Class classes)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(Driver boltDriver, java.lang.Class classes)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(PropertyResolver configuration, Neo4jConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(PropertyResolver configuration, Neo4jConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(PropertyResolver configuration, java.lang.Class classes)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(java.lang.Class classes)` Configures a new Neo4jDatastore for the given arguments.
`Neo4jDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Class classes)` Configures a new Neo4jDatastore for the given arguments
`Neo4jDatastore(java.lang.Package packagesToScan)` Construct a Mongo datastore scanning the given packages
`Neo4jDatastore(java.lang.Package packageToScan)` Construct a Mongo datastore scanning the given packages
`Neo4jDatastore(PropertyResolver configuration, java.lang.Package packagesToScan)` Construct a Mongo datastore scanning the given packages
`Neo4jDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Package packagesToScan)` Construct a Mongo datastore scanning the given packages

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`close()`
	`protected static ConnectionSources<Driver, Neo4jConnectionSourceSettings>`	`createDefaultConnectionSources(Driver driver, PropertyResolver configuration)` Creates the connection sources for an existing Driver
	`protected static Neo4jMappingContext`	`createMappingContext(ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources, java.lang.Class classes)`
	`protected Session`	`createSession(PropertyResolver connectionDetails)`
	`public ConfigurableApplicationEventPublisher`	`getApplicationEventPublisher()`
	`public AutoTimestampEventListener`	`getAutoTimestampEventListener()`
	`public Driver`	`getBoltDriver()` Returns: The Driver used by this datastore
	`public ConnectionSources<Driver, Neo4jConnectionSourceSettings>`	`getConnectionSources()`
	`public Datastore`	`getDatastoreForConnection(java.lang.String connectionName)`
	`public Neo4jDatastore`	`getDatastoreForTenantId(java.io.Serializable tenantId)`
	`public Neo4jMappingContext`	`getMappingContext()`
	`public MultiTenancyMode`	`getMultiTenancyMode()`
	`public TenantResolver`	`getTenantResolver()`
	`public Neo4jDatastoreTransactionManager`	`getTransactionManager()` Returns: The transaction manager
	`protected GormEnhancer`	`initialize(Neo4jConnectionSourceSettings settings)`
	`protected GormEnhancer`	`initialize(Neo4jConnectionSourceSettings settings)`
	`public void`	`persistentEntityAdded(PersistentEntity entity)`
	`protected void`	`registerEventListeners(ConfigurableApplicationEventPublisher eventPublisher)`
	`public void`	`setMessageSource(MessageSource messageSource)`
	`public void`	`setSkipIndexSetup(boolean skipIndexSetup)`
	`public void`	`setupIndexing()`
`<T1>`	`public T1`	`withNewSession(java.io.Serializable tenantId, groovy.lang.Closure<T1> callable)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractDatastore`	`connect, connect, connectStateless, createSession, createStatelessSession, destroy, doInSession, getApplicationContext, getApplicationEventPublisher, getCurrentSession, getMappingContext, getService, getServices, getSessionResolver, hasCurrentSession, initializeConverters, isIndexed, isSchemaless, mapToPropertyResolver, retrieveSession, retrieveSession, setApplicationContext, withSession`

- Field Detail
  - protected final AutoTimestampEventListener autoTimestampEventListener
  - protected final Driver boltDriver
  - protected final ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources
  - protected final java.util.Map<java.lang.String, Neo4jDatastore> datastoresByConnectionSource
  - protected final FlushModeType defaultFlushMode
  - protected final ConfigurableApplicationEventPublisher eventPublisher
  - protected final GormEnhancer gormEnhancer
  - protected final MultiTenancyMode multiTenancyMode
  - protected boolean skipIndexSetup
  - protected final TenantResolver tenantResolver
  - protected final Neo4jDatastoreTransactionManager transactionManager
- Constructor Detail
  - public Neo4jDatastore(ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources, Neo4jMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    mappingContext - The MappingContext which contains information about the mapped classes
    eventPublisher - The Spring ApplicationContext
  - public Neo4jDatastore(ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    eventPublisher - The Spring ApplicationContext
    classes - The persistent classes
  - public Neo4jDatastore(ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources, java.lang.Class classes)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    classes - The persistent classes
  - public Neo4jDatastore(Driver boltDriver, PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    boltDriver - The driver
    configuration - The configuration for the datastore
    eventPublisher - The Spring ApplicationContext
    classes - The persistent classes
  - public Neo4jDatastore(Driver boltDriver, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    boltDriver - The driver
    eventPublisher - The Spring ApplicationContext
    classes - The persistent classes
  - public Neo4jDatastore(Driver boltDriver, PropertyResolver configuration, java.lang.Class classes)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    boltDriver - The driver
    configuration - The configuration for the datastore
    classes - The persistent classes
  - public Neo4jDatastore(Driver boltDriver, java.lang.Class classes)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    boltDriver - The driver
    classes - The persistent classes
  - public Neo4jDatastore(PropertyResolver configuration, Neo4jConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    configuration - The configuration for the datastore
    connectionSourceFactory - The Neo4jConnectionSourceFactory to use to configure Neo4j
    eventPublisher - The Spring ApplicationContext
    classes - The persistent classes
  - public Neo4jDatastore(PropertyResolver configuration, Neo4jConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    configuration - The configuration for the datastore
    eventPublisher - The Spring ApplicationContext
    packagesToScan - The packages to scan
  - public Neo4jDatastore(PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    configuration - The configuration for the datastore
    eventPublisher - The Spring ApplicationContext
    classes - The persistent classes
  - public Neo4jDatastore(PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    configuration - The configuration for the datastore
    eventPublisher - The Spring ApplicationContext
    packagesToScan - The packages to scan
  - public Neo4jDatastore(PropertyResolver configuration, java.lang.Class classes)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    configuration - The configuration for the datastore
    classes - The persistent classes
  - public Neo4jDatastore(java.lang.Class classes)
    
    Configures a new Neo4jDatastore for the given arguments. This constructor is mainly used for testing, since no configuration is supplied it will be default try to create an embedded server
    Parameters:
    classes - The persistent classes
  - public Neo4jDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    configuration - The configuration
    classes - The persistent classes
  - public Neo4jDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Class classes)
    
    Configures a new Neo4jDatastore for the given arguments
    Parameters:
    configuration - The configuration
    classes - The persistent classes
  - public Neo4jDatastore(java.lang.Package packagesToScan)
    
    Construct a Mongo datastore scanning the given packages
    Parameters:
    packagesToScan - The packages to scan
  - public Neo4jDatastore(java.lang.Package packageToScan)
    
    Construct a Mongo datastore scanning the given packages
    Parameters:
    packageToScan - The packages to scan
  - public Neo4jDatastore(PropertyResolver configuration, java.lang.Package packagesToScan)
    
    Construct a Mongo datastore scanning the given packages
    Parameters:
    configuration - The configuration
    packagesToScan - The packages to scan
  - public Neo4jDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Package packagesToScan)
    
    Construct a Mongo datastore scanning the given packages
    Parameters:
    configuration - The configuration
    packagesToScan - The packages to scan
- Method Detail
  - @java.lang.Override
    @jakarta.annotation.PreDestroy
    public void close()
  - protected static ConnectionSources<Driver, Neo4jConnectionSourceSettings> createDefaultConnectionSources(Driver driver, PropertyResolver configuration)
    
    Creates the connection sources for an existing Driver
    Parameters:
    driver - The Driver
    configuration - The configuration
    Returns:
    The ConnectionSources
  - protected static Neo4jMappingContext createMappingContext(ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources, java.lang.Class classes)
  - @java.lang.Override
    protected Session createSession(PropertyResolver connectionDetails)
  - @java.lang.Override
    public ConfigurableApplicationEventPublisher getApplicationEventPublisher()
  - public AutoTimestampEventListener getAutoTimestampEventListener()
  - public Driver getBoltDriver()
    
    Returns:
    The Driver used by this datastore
  - @java.lang.Override
    public ConnectionSources<Driver, Neo4jConnectionSourceSettings> getConnectionSources()
  - @java.lang.Override
    public Datastore getDatastoreForConnection(java.lang.String connectionName)
  - @java.lang.Override
    public Neo4jDatastore getDatastoreForTenantId(java.io.Serializable tenantId)
  - @java.lang.Override
    public Neo4jMappingContext getMappingContext()
  - @java.lang.Override
    public MultiTenancyMode getMultiTenancyMode()
  - @java.lang.Override
    public TenantResolver getTenantResolver()
  - @java.lang.Override
    public Neo4jDatastoreTransactionManager getTransactionManager()
    
    Returns:
    The transaction manager
  - @java.lang.Override
    protected GormEnhancer initialize(Neo4jConnectionSourceSettings settings)
  - protected GormEnhancer initialize(Neo4jConnectionSourceSettings settings)
  - @java.lang.Override
    public void persistentEntityAdded(PersistentEntity entity)
  - protected void registerEventListeners(ConfigurableApplicationEventPublisher eventPublisher)
  - @java.lang.Override
    public void setMessageSource(MessageSource messageSource)
  - public void setSkipIndexSetup(boolean skipIndexSetup)
  - public void setupIndexing()
  - <T1> @java.lang.Override
    public T1 withNewSession(java.io.Serializable tenantId, groovy.lang.Closure<T1> callable)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class Neo4jDatastore

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final AutoTimestampEventListener autoTimestampEventListener

protected final Driver boltDriver

protected final ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources

protected final java.util.Map<java.lang.String, Neo4jDatastore> datastoresByConnectionSource

protected final FlushModeType defaultFlushMode

protected final ConfigurableApplicationEventPublisher eventPublisher

protected final GormEnhancer gormEnhancer

protected final MultiTenancyMode multiTenancyMode

protected boolean skipIndexSetup

protected final TenantResolver tenantResolver

protected final Neo4jDatastoreTransactionManager transactionManager

Constructor Detail

public Neo4jDatastore(ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources, Neo4jMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)

public Neo4jDatastore(ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

public Neo4jDatastore(ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources, java.lang.Class classes)

public Neo4jDatastore(Driver boltDriver, PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

public Neo4jDatastore(Driver boltDriver, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

public Neo4jDatastore(Driver boltDriver, PropertyResolver configuration, java.lang.Class classes)

public Neo4jDatastore(Driver boltDriver, java.lang.Class classes)

public Neo4jDatastore(PropertyResolver configuration, Neo4jConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

public Neo4jDatastore(PropertyResolver configuration, Neo4jConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)

public Neo4jDatastore(PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

public Neo4jDatastore(PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)

public Neo4jDatastore(PropertyResolver configuration, java.lang.Class classes)

public Neo4jDatastore(java.lang.Class classes)

public Neo4jDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

public Neo4jDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Class classes)

public Neo4jDatastore(java.lang.Package packagesToScan)

public Neo4jDatastore(java.lang.Package packageToScan)

public Neo4jDatastore(PropertyResolver configuration, java.lang.Package packagesToScan)

public Neo4jDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Package packagesToScan)

Method Detail

@java.lang.Override@jakarta.annotation.PreDestroypublic void close()

protected static ConnectionSources<Driver, Neo4jConnectionSourceSettings> createDefaultConnectionSources(Driver driver, PropertyResolver configuration)

protected static Neo4jMappingContext createMappingContext(ConnectionSources<Driver, Neo4jConnectionSourceSettings> connectionSources, java.lang.Class classes)

@java.lang.Overrideprotected Session createSession(PropertyResolver connectionDetails)

@java.lang.Overridepublic ConfigurableApplicationEventPublisher getApplicationEventPublisher()

public AutoTimestampEventListener getAutoTimestampEventListener()

public Driver getBoltDriver()

@java.lang.Overridepublic ConnectionSources<Driver, Neo4jConnectionSourceSettings> getConnectionSources()

@java.lang.Overridepublic Datastore getDatastoreForConnection(java.lang.String connectionName)

@java.lang.Overridepublic Neo4jDatastore getDatastoreForTenantId(java.io.Serializable tenantId)

@java.lang.Overridepublic Neo4jMappingContext getMappingContext()

@java.lang.Overridepublic MultiTenancyMode getMultiTenancyMode()

@java.lang.Overridepublic TenantResolver getTenantResolver()

@java.lang.Overridepublic Neo4jDatastoreTransactionManager getTransactionManager()

@java.lang.Overrideprotected GormEnhancer initialize(Neo4jConnectionSourceSettings settings)

protected GormEnhancer initialize(Neo4jConnectionSourceSettings settings)

@java.lang.Overridepublic void persistentEntityAdded(PersistentEntity entity)

protected void registerEventListeners(ConfigurableApplicationEventPublisher eventPublisher)

@java.lang.Overridepublic void setMessageSource(MessageSource messageSource)

public void setSkipIndexSetup(boolean skipIndexSetup)

public void setupIndexing()

<T1> @java.lang.Overridepublic T1 withNewSession(java.io.Serializable tenantId, groovy.lang.Closure<T1> callable)

@java.lang.Override
@jakarta.annotation.PreDestroy
public void close()

@java.lang.Override
protected Session createSession(PropertyResolver connectionDetails)

@java.lang.Override
public ConfigurableApplicationEventPublisher getApplicationEventPublisher()

@java.lang.Override
public ConnectionSources<Driver, Neo4jConnectionSourceSettings> getConnectionSources()

@java.lang.Override
public Datastore getDatastoreForConnection(java.lang.String connectionName)

@java.lang.Override
public Neo4jDatastore getDatastoreForTenantId(java.io.Serializable tenantId)

@java.lang.Override
public Neo4jMappingContext getMappingContext()

@java.lang.Override
public MultiTenancyMode getMultiTenancyMode()

@java.lang.Override
public TenantResolver getTenantResolver()

@java.lang.Override
public Neo4jDatastoreTransactionManager getTransactionManager()

@java.lang.Override
protected GormEnhancer initialize(Neo4jConnectionSourceSettings settings)

@java.lang.Override
public void persistentEntityAdded(PersistentEntity entity)

@java.lang.Override
public void setMessageSource(MessageSource messageSource)

<T1> @java.lang.Override
public T1 withNewSession(java.io.Serializable tenantId, groovy.lang.Closure<T1> callable)