org.neo4j.graphdb.factory

Class GraphDatabaseBuilder

java.lang.Object

org.neo4j.graphdb.factory.GraphDatabaseBuilder

Direct Known Subclasses:

GraphDatabaseBuilder.Delegator

public class GraphDatabaseBuilder
extends Object

Builder for GraphDatabaseServices that allows for setting and loading configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GraphDatabaseBuilder.DatabaseCreator
static class	GraphDatabaseBuilder.Delegator

Constructor Summary

Constructors

Constructor and Description
GraphDatabaseBuilder(GraphDatabaseBuilder.DatabaseCreator creator)

Method Summary

Modifier and Type	Method and Description
GraphDatabaseBuilder	loadPropertiesFromFile(String fileName) Load a Properties file from a given file, and add the settings to the builder.
GraphDatabaseBuilder	loadPropertiesFromURL(URL url) Load Properties file from a given URL, and add the settings to the builder.
org.neo4j.graphdb.GraphDatabaseService	newGraphDatabase() Create a new database with the configuration registered through the builder.
GraphDatabaseBuilder	setConfig(Map<String,String> config) Deprecated. Use setConfig with explicit Setting instead
GraphDatabaseBuilder	setConfig(org.neo4j.graphdb.config.Setting<?> setting, String value) Set a database setting to a particular value.
GraphDatabaseBuilder	setConfig(String name, String value) Deprecated. Use setConfig with explicit Setting instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphDatabaseBuilder

public GraphDatabaseBuilder(GraphDatabaseBuilder.DatabaseCreator creator)

Method Detail

setConfig

public GraphDatabaseBuilder setConfig(org.neo4j.graphdb.config.Setting<?> setting,
                                      String value)

Set a database setting to a particular value.

Parameters:

setting - Database setting to set

value - New value of the setting

Returns:

the builder

setConfig

@Deprecated
public GraphDatabaseBuilder setConfig(String name,
                                                  String value)

Deprecated. Use setConfig with explicit Setting instead.

Set an unvalidated configuration option.

Parameters:

name - Name of the setting

value - New value of the setting

Returns:

the builder

setConfig

@Deprecated
public GraphDatabaseBuilder setConfig(Map<String,String> config)

Deprecated. Use setConfig with explicit Setting instead

Set a map of configuration settings into the builder. Overwrites any existing values.

Parameters:

config - Map of configuration settings

Returns:

the builder

loadPropertiesFromFile

public GraphDatabaseBuilder loadPropertiesFromFile(String fileName)
                                            throws IllegalArgumentException

Load a Properties file from a given file, and add the settings to the builder.

Parameters:

fileName - Filename of properties file to use

Returns:

the builder

Throws:

IllegalArgumentException - if the builder was unable to load from the given filename

loadPropertiesFromURL

public GraphDatabaseBuilder loadPropertiesFromURL(URL url)
                                           throws IllegalArgumentException

Load Properties file from a given URL, and add the settings to the builder.

Parameters:

url - URL of properties file to use

Returns:

the builder

Throws:

IllegalArgumentException

newGraphDatabase

public org.neo4j.graphdb.GraphDatabaseService newGraphDatabase()

Create a new database with the configuration registered through the builder.

Returns:

an instance of GraphDatabaseService