org.neo4j.kernel.EmbeddedGraphDatabase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-kernel Show documentation
Neo4j kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see http://neo4j.org.
There is a newer version: 5.26.0
Show newest version
/**
 * Copyright (c) 2002-2013 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.kernel;

import java.util.HashMap;
import java.util.Map;

import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.graphdb.index.IndexProvider;
import org.neo4j.helpers.Service;
import org.neo4j.helpers.collection.Iterables;
import org.neo4j.kernel.extension.KernelExtensionFactory;
import org.neo4j.kernel.impl.cache.CacheProvider;
import org.neo4j.kernel.impl.transaction.xaframework.TransactionInterceptorProvider;

/**
 * An implementation of {@link GraphDatabaseService} that is used to embed Neo4j
 * in an application. You typically instantiate it by using
 * {@link GraphDatabaseFactory} like so:
 * 
 * 
 * 
 * 
 * GraphDatabaseService graphDb = new GraphDatabaseFactory().newEmbeddedDatabase( "var/graphdb" );
 * // ... use Neo4j
 * graphDb.shutdown();
 * 
 * 
 * 
 * For more information, see {@link GraphDatabaseService}.
 */
public class EmbeddedGraphDatabase extends InternalAbstractGraphDatabase
{
    /**
     * Creates an embedded {@link GraphDatabaseService} with a store located in
     * storeDir, which will be created if it doesn't already exist.
     * 
     * This is deprecated. Use {@link GraphDatabaseFactory} instead.
     * 
     * @param storeDir the store directory for the Neo4j store files
     */
    @Deprecated
    public EmbeddedGraphDatabase( String storeDir )
    {
        this( storeDir, new HashMap() );
    }

    /**
     * A non-standard way of creating an embedded {@link GraphDatabaseService}
     * with a set of configuration parameters.
     * 
     * Creates an embedded {@link GraphDatabaseService} with a store located in
     * storeDir, which will be created if it doesn't already exist.
     * 
     * This is deprecated. Use {@link GraphDatabaseFactory} instead.
     * 
     * @param storeDir the store directory for the db files
     * @param params configuration parameters
     */
    @Deprecated
    public EmbeddedGraphDatabase( String storeDir, Map params )
    {
        this( storeDir, params,
                Service.load( IndexProvider.class ),
                Iterables.,KernelExtensionFactory>cast( Service.load( KernelExtensionFactory.class ) ),
                Service.load( CacheProvider.class ),
                Service.load( TransactionInterceptorProvider.class ) );
    }

    /**
     * Internal constructor used by {@link org.neo4j.graphdb.factory.GraphDatabaseFactory}
     *
     * @param storeDir
     * @param params
     * @param indexProviders
     * @param kernelExtensions
     * @param cacheProviders
     * @param txInterceptorProviders
     */
    public EmbeddedGraphDatabase( String storeDir, Map params, Iterable indexProviders,
                                  Iterable> kernelExtensions,
                                  Iterable cacheProviders,
                                  Iterable txInterceptorProviders )
    {
        super( storeDir, params, Iterables., Class>iterable( (Class) GraphDatabaseSettings.class ),
                indexProviders, kernelExtensions, cacheProviders, txInterceptorProviders );

        run();
    }
}