net.java.ao.SchemaConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of activeobjects Show documentation

This is the full Active Objects library, if you don't know which one to use, you probably want this one.

There is a newer version: 6.1.1

package net.java.ao;

/**
 * This interface represents the configuration to be used when Active Objects works with database schemas. It includes
 * constraints that Active Objects should work with when dealing with schemas. For example when using
 * {@link net.java.ao.EntityManager#migrate(Class[])}
 * For example the {@link #shouldManageTable(String, boolean)} tells Active Objects whether it is allowed to update/delete a given table
 * present in the database.
 *
 * @see net.java.ao.EntityManager#migrate(Class[])
 */
public interface SchemaConfiguration {
    /**
     * Tells whether the table with the given table name should be managed by Active Objects.
     *
     * @param tableName     the name of the table to be managed (or not)
     * @param caseSensitive whether or not the case of the table name should be taken in account
     * @return {@code true} if Active Objects is allowed to manage the table named {@code tableName}
     */
    boolean shouldManageTable(String tableName, boolean caseSensitive);
}