com.heliorm.Field 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.FieldOrder;

import java.util.Optional;

/**
 * A field on a table.
 *
 * @param  The type of the POJO to which the table and this field applies
 * @param  The data type of the field
 * @author gideon
 */
public interface Field extends FieldOrder {

    Table getTable();

    /**
     * Get the type of the field.
     *
     * @return The field type
     */
    FieldType getFieldType();

    /**
     * Get the java type fo the field
     *
     * @return The java type
     */
    Class getJavaType();

    /**
     * Get the java field name of the field.
     *
     * @return The field name
     */
    String getJavaName();

    /**
     * Get the SQL column name of the field.
     *
     * @return The SQL column name
     */
    String getSqlName();

    /**
     * Returns true if this field represents the table's primary key.
     *
     * @return True if it is
     */
    boolean isPrimaryKey();

    /**
     * Return true if this field is the foreign key from another table.
     *
     * @return True if it is
     */
    boolean isForeignKey();

    /**
     * Return true if this is an auto-number key
     *
     * @return True if auto-number
     */
    boolean isAutoNumber();

    /**
     * Return the table to which this field links if it is a foreign key.
     *
     * @return The linked table
     */
    Optional> getForeignTable();

    /**
     * Return the field length, if a specific length is known.
     *
     * @return The length, if known
     */
    Optional getLength();

    /**
     * Return true if the field can be null.
     *
     * @return True if it can be null
     */
    boolean isNullable();

    FieldOrder asc();

    FieldOrder desc();

    enum FieldType {
        LONG,
        INTEGER,
        SHORT,
        BYTE,
        DOUBLE,
        FLOAT,
        BOOLEAN,
        ENUM,
        STRING,
        DATE,
        INSTANT,
        LOCAL_DATE_TIME,
        BYTE_ARRAY
    }

}