com.mybatisflex.annotation.RelationOneToMany Maven / Gradle / Ivy
/*
* Copyright (c) 2022-2023, Mybatis-Flex ([email protected]).
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mybatisflex.annotation;
import java.lang.annotation.*;
/**
* 一对多映射。
*
* @author michael
*/
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface RelationOneToMany {
/**
* 当前实体类的属性。
*
* @return 属性名称
*/
String selfField() default "";
/**
* 当前字段值根据字符串分割
* @return 分割字符串
*/
String selfValueSplitBy() default "";
/**
*
* 目标实体类对应的表的 schema 模式。
*
*
* 如果目标实体类没有使用 {@code @Table(schema = "...")} 指定 schema 时，
* 需要在这里指定对应表的 schema 值。一般关联数据不是 entity 对象，而是 vo、dto
* 等需要配置此项。
*
* @return schema 名称
*/
String targetSchema() default "";
/**
*
* 目标实体类对应的表名。
*
*
* 如果目标实体类没有使用 {@code @Table(value = "...")} 指定表名时，
* 需要在这里指定对应表的表名。一般关联数据不是 entity 对象，而是 vo、dto
* 等需要配置此项。
*
* @return 表名
*/
String targetTable() default "";
/**
* 目标实体类的关联属性。
*
* @return 属性名称
*/
String targetField();
/**
* 目标对象的关系实体类的属性绑定
*
* 当字段不为空串时,只进行某个字段赋值(使用对应字段类型接收)
* @return 属性名称
*/
String valueField() default "";
/**
* 当映射是一个 map 时，使用哪个内容来当做 map 的 Key
* @return 指定的列
*/
String mapKeyField() default "";
/**
* 中间表名称，一对一的关系是通过通过中间表维护时，需要添加此项配置。
*
* @return 中间表名称
*/
String joinTable() default "";
/**
* 中间表与当前表的关联字段，一对一的关系是通过通过中间表维护时，需要添加此项配置。
*
* @return 字段名称，列名
*/
String joinSelfColumn() default "";
/**
* 目标表的关联字段名称，一对一的关系是通过通过中间表维护时，需要添加此项配置。
*
* @return 字段名称和表
*/
String joinTargetColumn() default "";
/**
* 查询时，追加的额外条件。
*/
String extraCondition() default "";
/**
* 查询（加载）指定的列
*/
String[] selectColumns() default {};
/**
* 查询排序。
*
* @return 排序方式
*/
String orderBy() default "";
/**
* 现在查询的数据量。
*
* @return 数据量
*/
long limit() default 0;
/**
* 默认使用哪个数据源，若系统找不到该指定的数据源时，默认使用第一个数据源。
*
* @return 数据源
*/
String dataSource() default "";
}