com.heliorm.Orm Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
The newest version!
package com.heliorm;

import com.heliorm.def.Join;
import com.heliorm.def.Select;
import com.heliorm.def.Where;
import com.heliorm.impl.Selector;

public interface Orm extends AutoCloseable {

    /**
     * Persist a new POJO to the database.
     *
     * @param   The type of the POJO
     * @param pojo The POJO to persist
     * @return The updated POJO
     * @throws OrmException Thrown if there is an error creating the POJO
     */
     O create(O pojo) throws OrmException;

    /**
     * Persist an existing POJO to the database.
     *
     * @param   The type of the POJO
     * @param pojo The POJO to persist
     * @return The updated POJO
     * @throws OrmException Thrown if there is an error updating the POJO
     */
     O update(O pojo) throws OrmException;

    /**
     * Delete a POJO from the database.
     *
     * @param   The type of the POJO
     * @param pojo The POJO to delete
     * @throws OrmException Thrown if there is an error deleting the POJO
     */
     void delete(O pojo) throws OrmException;

    /**
     * Create a query builder pattern to select data from the database.
     *
     * @param    The type of the POJOs selected
     * @param table The table to use as starting point for building the query.
     * @return The Select object that can be used to expand the query or to
     * query data.
     */
     Select select(Table table);

    /**
     * Create a query builder pattern to select data from the database.
     *
     * @param    The type of the POJOs selected
     * @param table The table to use as starting point for building the query.
     * @param where The where clause to use
     * @return The Select object that can be used to expand the query or to
     * query data.
     */
     Select select(Table table, Where where);

    /**
     * Create a query builder pattern to select data from the database.
     *
     * @param    The type of the POJOs selected
     * @param table The table to use as starting point for building the query.
     * @param joins The joins to do
     * @return The Select object that can be used to expand the query or to
     * query data.
     */
     Select select(Table table, Join... joins);

    /**
     * Create a query builder pattern to select data from the database.
     *
     * @param    The type of the POJOs selected
     * @param table The table to use as starting point for building the query.
     * @param where The where clause to use
     * @param joins The joins to do
     * @return The Select object that can be used to expand the query or to
     * query data.
     */
     Select select(Table table, Where where, Join... joins);

    /**
     * Open a new transaction.
     *
     * @return The transaction
     * @throws OrmException Thrown if the driver doesn't support transactions of if there is a problem opening one
     */
    OrmTransaction openTransaction() throws OrmException;

    @Override
    void close();

    /**
     * Find the table definition for the given POJO.
     *
     * @param   The type of the POJO
     * @param pojo The pojo
     * @return The table
     * @throws OrmException Thrown if there is an error finding the table the POJO
     */
     Table tableFor(O pojo) throws OrmException;

    /**
     * Find the table definition for the given POJO.
     *
     * @param   The type of the POJO
     * @param type The type of pojo
     * @return The table
     * @throws OrmException Thrown if there is an error finding the table the POJO
     */
     Table tableFor(Class type) throws OrmException;

    /**
     * Return the selector that is used to select data.
     *
     * @return The selector
     */
    Selector selector();

}