org.babyfish.jimmer.sql.fetcher.Field Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jimmer-sql Show documentation

A revolutionary ORM framework for both java and kotlin

There is a newer version: 0.9.19

package org.babyfish.jimmer.sql.fetcher;

import org.babyfish.jimmer.meta.ImmutableProp;
import org.babyfish.jimmer.meta.ImmutableType;
import org.jetbrains.annotations.Nullable;

public interface Field {

    /**
     * If the declaring type of {@link #getProp()} has id property,
     * the returned type is declaring type of {@link #getProp()},
     * otherwise(Interface decorated by MappedSuperclass and have no id property)
     * the returned type is the type that contain id property.
     * @return
     */
    ImmutableType getEntityType();

    ImmutableProp getProp();

    FieldFilter getFilter();

    int getBatchSize();

    int getLimit();

    int getOffset();

    @Nullable
    RecursionStrategy getRecursionStrategy();

    @Nullable
    Fetcher getChildFetcher();

    /**
     * Whether the property is a direct mapping to a database column(s)
     * or a formula property based on `SQL` expression(Not java/kotlin expression).
     * @return
     */
    boolean isSimpleField();

    boolean isImplicit();

    boolean isRawId();
}