org.dbflute.bhv.referrer.NestedReferrerLoaderGateway Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dbflute-runtime Show documentation
The runtime library of DBFlute
There is a newer version: 1.2.8
/*
 * Copyright 2014-2021 the original author or authors.
 *
 * 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 org.dbflute.bhv.referrer;

/**
 * The gateway of loader handling for nested referrer.
 *  * MemberCB cb = new MemberCB();
 * cb.query().set...
 * List<Member> memberList = memberBhv.selectList(cb);
 * memberBhv.load(memberList, new ReferrerLoaderHandler<LoaderOfMember>() {
 *     public void handle(LoaderOfMember loader) {
 *         memberBhv.load(memberList, new ReferrerConditionSetupper<PurchaseCB>() {
 *             public void setup(PurchaseCB refCB) {
 *                 cb.query().addOrderBy_PurchaseDatetime_Asc();
 *             }
 *         }).withNestedReferrer(new ReferrerLoaderHandler<LoaderOfPurchase>() {
 *             public void handle(List<LoaderOfPurchase> loader) {
 *                 // you can call LoadReferrer here for nested referrer as you like it
 *                 loader.loadPurchasePaymentList(new ReferrerConditionSetupper<PurchasePaymentCB>() {
 *                     public void setup(PurchaseDetailCB refCB) {
 *                         ...
 *                     }
 *                 });
 *                 ...
 *             }
 *         }
 *     }
 * }
 * 
 * @param  The type of referrer loader.
 * @author jflute
 * @since 1.0.5F (2014/05/06 Tuesday)
 */
@FunctionalInterface
public interface NestedReferrerLoaderGateway {

    /**
     * Set up nested referrer by the loader.
     *      * MemberCB cb = new MemberCB();
     * cb.query().set...
     * List<Member> memberList = memberBhv.selectList(cb);
     * memberBhv.load(memberList, new ReferrerLoaderHandler<LoaderOfMember>() {
     *     public void handle(LoaderOfMember loader) {
     *         memberBhv.load(memberList, new ReferrerConditionSetupper<PurchaseCB>() {
     *             public void setup(PurchaseCB cb) {
     *                 cb.query().addOrderBy_PurchaseDatetime_Asc();
     *             }
     *         }).withNestedReferrer(new ReferrerLoaderHandler<LoaderOfPurchase>() {
     *             public void handle(List<LoaderOfPurchase> loader) {
     *                 // you can call LoadReferrer here for nested referrer as you like it
     *                 loader.loadPurchasePaymentList(new ReferrerConditionSetupper<PurchasePaymentCB>() {
     *                     public void setup(PurchaseDetailCB cb) {
     *                         ...
     *                     }
     *                 });
     *                 ...
     *             }
     *         }
     *     }
     * }
     * 
     * @param loaderLambda The callback for handler of referrer loader to load nested referrer. (NotNull)
     */
    void withNestedReferrer(ReferrerLoaderHandler loaderLambda);
}