org.sirix.access.DatabaseManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sirix-core Show documentation

SirixDB is a hybrid on-disk and in-memory document oriented, versioned database system. It has a lightweight buffer manager, stores everything in a huge persistent and durable tree and allows efficient reconstruction of every revision. Furthermore, SirixDB implements change tracking, diffing and supports time travel queries.

There is a newer version: 0.11.0

Show newest version

package org.sirix.access;

import dagger.Component;
import org.sirix.access.json.JsonLocalDatabaseComponent;
import org.sirix.access.xml.XmlLocalDatabaseComponent;
import org.sirix.api.Database;
import org.sirix.api.json.JsonResourceManager;
import org.sirix.api.xml.XmlResourceManager;

import javax.inject.Singleton;

/**
 * The Dagger component that manages database dependencies. This class is internal and managed by {@link Databases}.
 *
 * @author Joao Sousa
 */
@Component(modules = DatabaseModule.class)
@Singleton
public interface DatabaseManager {

    /**
     * Creates a new Json database subcomponent.
     *
     * This method is declare here in order to create a link between this component and
     * {@link JsonLocalDatabaseComponent}, as parent component and sub-component, respectively.
     * Hence, it should not be called. Use {@link #jsonDatabaseFactory()} instead.
     *
     * @return A builder, used to create a new json database subcomponent.
     */
    @SuppressWarnings("unused")
    JsonLocalDatabaseComponent.Builder jsonDatabaseBuilder();

    /**
     * Creates a new Json database subcomponent.
     *
     * This method is declare here in order to create a link between this component and
     * {@link XmlLocalDatabaseComponent}, as parent component and sub-component, respectively.
     * Hence, it should not be called. Use {@link #xmlDatabaseFactory()} instead.
     *
     * @return A builder, used to create a new json database subcomponent.
     */
    @SuppressWarnings("unused")
    XmlLocalDatabaseComponent.Builder xmlDatabaseBuilder();

    LocalDatabaseFactory jsonDatabaseFactory();

    LocalDatabaseFactory xmlDatabaseFactory();

    PathBasedPool> sessions();

}