space.lingu.light.Junction Maven / Gradle / Ivy
/*
* Copyright (C) 2022 Lingu Light Project
*
* 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 space.lingu.light;
import java.lang.annotation.*;
/**
* Not available yet.
*
* @author RollW
*/
@Documented
@Target({})// TODO
@Retention(RetentionPolicy.RUNTIME)
@LightExperimentalApi
public @interface Junction {
/**
* An entity or database view to be used as a junction table when fetching the
* relating entities.
*
* @return The entity or database view to be used as a junction table.
*/
Class value();
/**
* The junction column that will be used to match against the {@link Relation#parentColumn()}.
*
* If not specified it defaults to {@link Relation#parentColumn()}.
*/
String parentColumn() default "";
/**
* The junction column that will be used to match against the {@link Relation#entityColumn()}.
*
* If not specified it defaults to {@link Relation#entityColumn()}.
*/
String entityColumn() default "";
}