com.github.naoghuman.lib.database.api.ILibDatabase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lib-database-objectdb Show documentation

Lib-Database-ObjectDB is a library for easy accessing an ObjectDB database in a JavaFX & Maven desktop application. See https://github.com/Naoghuman/lib-database-objectdb for more details.

There is a newer version: 0.6.0

Show newest version

/*
 * Copyright (C) 2014 PRo
 *
 * This program 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 com.github.naoghuman.lib.database.api;

import javax.persistence.EntityManager;

/**
 * The Interface for the class {@link com.github.naoghuman.lib.database.LibDatabase}.

 * Over the facade {@link com.github.naoghuman.lib.database.api.DatabaseFacade} you can access
 * the methods in this Interface.
 *
 * @author PRo
 * @see com.github.naoghuman.lib.database.LibDatabase
 * @see com.github.naoghuman.lib.database.api.DatabaseFacade
 */
public interface ILibDatabase {
    
    /**
     * Allowed the developer to drop the defined database.

     * This method can be used for testing purpose.
     * 
     * @param database The database which should be dropped.
     */
    public void drop(String database);
    
    /**
     * Returns a {@link com.github.naoghuman.lib.database.api.ICrudService} with 
     * the name DEFAULT which allowed all sql operations.
     * 
     * @return The crud service.
     */
    public ICrudService getCrudService();
    
    /**
     * Returns a named {@link com.github.naoghuman.lib.database.api.ICrudService} 
     * which allowed all sql operations.
     * 
     * @param name The name from the ICrudService.
     * @return The ICrudService.
     */
    public ICrudService getCrudService(String name);
    
    /**
     * Returns a named {@link javax.persistence.EntityManager} which allowed 
     * all sql operations.
     * 
     * @param name The name from the EntityManager.
     * @return The EntityManager.
     */
    public EntityManager getEntityManager(String name);
    
    /**
     * Create a database with the specific parameter in the folder
     * System.getProperty("user.dir") + File.separator + 
     * "database" if it not exists.

     * If the parameter have no suffix .odb then it will be
     * automaticaly added, otherwise not.
     * 
     * @param database The name for the database which should be created.
     */
    public void register(String database);
    
    /**
     * Remove a {@link com.github.naoghuman.lib.database.api.ICrudService} with 
     * the given name. Also the associated {@link javax.persistence.EntityManager} 
     * will be removed.
     * 
     * @param name The name for the ICrudService which should be removed.
     * @see com.github.naoghuman.lib.database.api.ILibDatabase#removeEntityManager(java.lang.String)
     */
    public void removeCrudService(String name);
    
    /**
     * Remove a {@link javax.persistence.EntityManager} with the given name. Also
     * the associated {@link com.github.naoghuman.lib.database.api.ICrudService} 
     * will be removed.
     * 
     * @param name The name for the EntityManager which should be removed.
     * @see com.github.naoghuman.lib.database.api.ILibDatabase#removeCrudService(java.lang.String)
     */
    public void removeEntityManager(String name);
    
    /**
     * Close the previous registered database.
     * 
     * @see com.github.naoghuman.lib.database.api.ILibDatabase#register(java.lang.String)
     */
    public void shutdown();
    
}