ru.sergkorot.dynamic.operation.SpecificationOperationService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-boot-operation-starter Show documentation
Library for dynamic searching into the databases
The newest version!
package ru.sergkorot.dynamic.operation;

import org.springframework.data.jpa.domain.Specification;
import org.springframework.stereotype.Service;
import org.springframework.util.CollectionUtils;
import ru.sergkorot.dynamic.model.BaseSearchParam;
import ru.sergkorot.dynamic.model.ComplexSearchParam;
import ru.sergkorot.dynamic.model.PageAttribute;
import ru.sergkorot.dynamic.model.paging.PageRequestWithOffset;
import ru.sergkorot.dynamic.model.enums.GlueOperation;
import ru.sergkorot.dynamic.glue.GlueOperationProvider;
import ru.sergkorot.dynamic.util.SortUtils;
import ru.sergkorot.dynamic.util.SpecificationUtils;

import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;

/**
 * @param  - entity for which building condition
 * @author Sergey Korotaev
 * Service for building specification for base and complex requests.
 * Also for building page request settings
 */
@Service
@SuppressWarnings("unused")
public class SpecificationOperationService implements OperationService> {

    private final OperationProvider> operationProvider;
    private final GlueOperationProvider> glueOperationProvider;
    private final Map>> manualOperationProviderMap;

    public SpecificationOperationService(OperationProvider> operationProvider,
                                         GlueOperationProvider> glueOperationProvider,
                                         List>> manualOperationProviders) {
        this.operationProvider = operationProvider;
        this.glueOperationProvider = glueOperationProvider;
        this.manualOperationProviderMap = CollectionUtils.isEmpty(manualOperationProviders)
                ? null
                : manualOperationProviders.stream().collect(Collectors.toMap(ManualOperationProvider::fieldName, Function.identity()));
    }

    /**
     * Create specification for base search request
     *
     * @param baseSearchParams - model for base search request
     * @param glue             - condition for gluing specifications
     * @return - specification for data request
     * @see BaseSearchParam
     * @see GlueOperation
     */
    public Specification buildBaseByParams(List baseSearchParams, GlueOperation glue) {
        if (CollectionUtils.isEmpty(baseSearchParams)) {
            return SpecificationUtils.findAll();
        }

        List> specifications = baseSearchParams
                .stream()
                .map(this::constructSpecification)
                .toList();

        return buildGlue(glueOperationProvider, specifications, glue);
    }

    /**
     * Create specification for complex search request
     *
     * @param complexSearchParams - model for complex search request
     * @param externalGlue        - condition for gluing complex specification between each other
     * @return - specification for data request
     * @see ComplexSearchParam
     * @see GlueOperation
     */
    public Specification buildComplexByParams(List complexSearchParams, GlueOperation externalGlue) {

        List> specifications = complexSearchParams.stream()
                .map(complexSearchParam ->
                        buildBaseByParams(
                                complexSearchParam.getBaseSearchParams(),
                                complexSearchParam.getInternalGlue()
                        )
                )
                .toList();

        return buildGlue(glueOperationProvider, specifications, externalGlue);
    }

    /**
     * Create PageRequest extension for paging and sorting settings
     *
     * @param pageAttribute    - attribute class for pagination and sorting
     * @param searchSortFields - fields by which sorting is possible in the database
     * @return - PageRequestWithOffset
     * @see PageRequestWithOffset
     * @see PageAttribute
     */
    public PageRequestWithOffset buildPageSettings(PageAttribute pageAttribute, List searchSortFields) {
        if (Objects.isNull(pageAttribute)) {
            return PageRequestWithOffset.of(SortUtils.DEFAULT_OFFSET, SortUtils.DEFAULT_LIMIT, List.of());
        }
        return PageRequestWithOffset.of(
                pageAttribute.getOffset(),
                pageAttribute.getLimit(),
                SortUtils.makeSortOrders(searchSortFields, pageAttribute.getSortBy())
        );
    }

    private Specification constructSpecification(BaseSearchParam param) {
        if (!CollectionUtils.isEmpty(manualOperationProviderMap) && manualOperationProviderMap.containsKey(param.getName())) {
            return manualOperationProviderMap.get(param.getName()).buildOperation(param);
        }
        return buildOperation(param, operationProvider);
    }
}