com.landawn.abacus.util.Selection Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2022 HaiYang Li
 *
 * 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.landawn.abacus.util;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Set;
import java.util.function.Function;

import com.landawn.abacus.annotation.Beta;
import com.landawn.abacus.util.SQLBuilder.NSC;
import com.landawn.abacus.util.SQLBuilder.PSC;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

@Data
@Accessors(fluent = true)
@NoArgsConstructor
@AllArgsConstructor
public final class Selection {
    private Class entityClass;
    private String tableAlias;
    private String classAlias;
    private Collection selectPropNames;
    boolean includeSubEntityProperties;
    private Set excludedPropNames;

    public static MultiSelectionBuilder multiSelectionBuilder() {
        return new MultiSelectionBuilder();
    }

    public static final class MultiSelectionBuilder {
        private final List selections = new ArrayList<>();

        private MultiSelectionBuilder() {
            //
        }

        /**
         *
         *
         * @param entityClass
         * @return
         */
        public MultiSelectionBuilder add(final Class entityClass) {
            return add(entityClass, null, null, null);
        }

        /**
         *
         *
         * @param entityClass
         * @param selectPropNames
         * @return
         */
        public MultiSelectionBuilder add(final Class entityClass, final Collection selectPropNames) {
            return add(entityClass, null, null, selectPropNames);
        }

        /**
         *
         *
         * @param entityClass
         * @param tableAlias
         * @param classAlias
         * @return
         */
        public MultiSelectionBuilder add(final Class entityClass, final String tableAlias, final String classAlias) {
            return add(entityClass, tableAlias, classAlias, null);
        }

        /**
         *
         *
         * @param entityClass
         * @param tableAlias
         * @param classAlias
         * @param selectPropNames
         * @return
         */
        public MultiSelectionBuilder add(final Class entityClass, final String tableAlias, final String classAlias,
                final Collection selectPropNames) {
            selections.add(new Selection(entityClass, tableAlias, classAlias, selectPropNames, false, null));

            return this;
        }

        /**
         *
         *
         * @param entityClass
         * @param includeSubEntityProperties
         * @param excludedPropNames
         * @return
         */
        public MultiSelectionBuilder add(final Class entityClass, final boolean includeSubEntityProperties, final Set excludedPropNames) {
            return add(entityClass, null, null, includeSubEntityProperties, excludedPropNames);
        }

        /**
         *
         *
         * @param entityClass
         * @param tableAlias
         * @param classAlias
         * @param includeSubEntityProperties
         * @param excludedPropNames
         * @return
         */
        public MultiSelectionBuilder add(final Class entityClass, final String tableAlias, final String classAlias, final boolean includeSubEntityProperties,
                final Set excludedPropNames) {
            selections.add(new Selection(entityClass, tableAlias, classAlias, null, includeSubEntityProperties, excludedPropNames));

            return this;
        }

        /**
         *
         *
         * @return
         */
        public List build() {
            return selections;
        }

        /**
         *
         * @param func it can be: {@code PSC::select}, {@code PSC::selectFrom}, {@code NSC::select}, {@code NSC::selectFrom} or other methods.
         * @return
         * @see PSC#select(List)
         * @see PSC#selectFrom(List)
         * @see NSC#select(List)
         * @see NSC#selectFrom(List)
         */
        @Beta
        public SQLBuilder apply(final Function, SQLBuilder> func) {
            return func.apply(build());
        }
    }
}