com.heliorm.Table Maven / Gradle / Ivy

Go to download
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 java.util.List;
import java.util.Optional;
import java.util.Set;

/**
 * The interface that must be implemented to define a database table for use by
 * the ORM
 *
 * @param  The type of Object stored in the table.
 * @author gideon
 */
public interface Table {

    /**
     * Return the type of the POJOs supported by this table.
     *
     * @return The type
     */
    Class getObjectClass();

    /**
     * Return the persisted fields defined on POJOs for this table.
     *
     * @return The fields
     */
    List> getFields();

    /**
     * Return the primary key field (if defined) for this table.
     *
     * @return The primary key field
     */
    Optional> getPrimaryKey();

    /**
     * Return the SQL table name for this table.
     *
     * @return The table name
     */
    String getSqlTable();

    /**
     * Return tables which support POJOs which are concrete subclasses of the POJO
     * supported by this table.
     *
     * @return The sub tables
     */
    Set> getSubTables();

    /**
     * Return the database within which this table exists.
     *
     * @return The database
     */
    Database getDatabase();

    /**
     * Return true if this table refers to an abstract POJO and not to a concrete
     * POJO with a database table.
     *
     * @return true if abstract
     */
    boolean isAbstract();

    /** Return true if this table refers to a Java Record and not a POJO
     *
     * @return True if the underlying type is a record
     */
    boolean isRecord();

    /**
     * Return the indexes for this POJO
     *
     * @return The indexes
     */
    List> getIndexes();
}