com.wavemaker.runtime.data.dao.WMGenericTemporalDaoImpl Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wavemaker-app-runtime-db Show documentation
wavemaker-app-runtime-db
There is a newer version: 11.8.3.ee
Show newest version
/*******************************************************************************
 * Copyright (C) 2022-2023 WaveMaker, Inc.
 *
 * 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.wavemaker.runtime.data.dao;

import java.beans.PropertyDescriptor;
import java.io.Serializable;
import java.lang.reflect.InvocationTargetException;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;

import javax.annotation.PostConstruct;
import javax.persistence.Column;
import javax.persistence.Id;
import javax.persistence.Transient;

import org.hibernate.query.Query;
import org.springframework.beans.BeanUtils;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.orm.hibernate5.HibernateTemplate;

import com.wavemaker.commons.MessageResource;
import com.wavemaker.commons.WMRuntimeException;
import com.wavemaker.runtime.data.annotations.TableTemporal;
import com.wavemaker.runtime.data.dao.generators.TemporalQueryGenerator;
import com.wavemaker.runtime.data.dao.query.types.RuntimeParameterTypeResolver;
import com.wavemaker.runtime.data.dao.util.PageUtils;
import com.wavemaker.runtime.data.dao.util.ParametersConfigurator;
import com.wavemaker.runtime.data.filter.WMQueryInfo;
import com.wavemaker.runtime.data.hql.DeleteQueryBuilder;
import com.wavemaker.runtime.data.hql.SelectQueryBuilder;
import com.wavemaker.runtime.data.hql.UpdateQueryBuilder;
import com.wavemaker.runtime.data.model.TemporalHistoryEntity;
import com.wavemaker.runtime.data.periods.PeriodClause;
import com.wavemaker.runtime.data.util.AnnotationUtils;
import com.wavemaker.runtime.data.util.HqlQueryHelper;
import com.wavemaker.runtime.data.util.PropertyDescription;

/**
 * @author Dilip Kumar
 * @since 3/1/18
 */
public abstract class WMGenericTemporalDaoImpl
    extends WMGenericDaoImpl implements WMGenericTemporalDao {

    private Class> historyClass;

    private List updatableProperties;

    @SuppressWarnings("unchecked")
    @PostConstruct
    @Override
    public void init() {
        super.init();

        if (entityClass.isAnnotationPresent(TableTemporal.class)) {
            final TableTemporal temporal = entityClass.getAnnotation(TableTemporal.class);
            // decorating with given temporal types
            final boolean applicationTemporalExists = Arrays.stream(temporal.value())
                .anyMatch(temporalType -> temporalType == TableTemporal.TemporalType.APPLICATION);

            if (applicationTemporalExists) {
                queryGenerator = new TemporalQueryGenerator<>(queryGenerator, TableTemporal.TemporalType.APPLICATION);
            }

            historyClass = (Class>) temporal.historyClass();

            updatableProperties = AnnotationUtils.findProperties(historyClass).stream()
                .filter(description -> description.isAnnotationNotPresent(Id.class))
                .filter(description -> description.isAnnotationNotPresent(Transient.class))
                .filter(description -> {
                    final Optional optionalColumn = description.findAnnotation(Column.class);
                    return optionalColumn.isPresent() && optionalColumn.get().updatable();
                })
                .map(PropertyDescription::getDescriptor)
                .map(PropertyDescriptor::getName)
                .map(name -> BeanUtils.getPropertyDescriptor(entityClass, name))
                .collect(Collectors.toList());
        } else {
            throw new WMRuntimeException(MessageResource.create("com.wavemaker.runtime.tableTemporal.annotation.error"), entityClass.getName());
        }
    }

    protected abstract HibernateTemplate getHistoryTemplate();

    @Override
    public Page findByPeriod(
        final List periodClauses, final String query, final Pageable pageable) {
        Pageable validPageable = PageUtils.defaultIfNull(pageable);

        sortValidator.validate(validPageable, historyClass);

        final SelectQueryBuilder builder = new SelectQueryBuilder(historyClass)
            .withFilter(query);
        periodClauses.forEach(builder::withPeriodClause);

        final Page> responsePage = HqlQueryHelper
            .execute(getHistoryTemplate(), historyClass, builder, validPageable, getWMQLTypeHelper());

        return responsePage.map(TemporalHistoryEntity::asParent);
    }

    @Override
    public Page findByIdAndPeriod(
        final Map identifier, final List periodClauses, final Pageable pageable) {
        Pageable validPageable = PageUtils.defaultIfNull(pageable);

        sortValidator.validate(validPageable, historyClass);

        final SelectQueryBuilder builder = new SelectQueryBuilder(historyClass)
            .withFilterConditions(identifier);
        periodClauses.forEach(builder::withPeriodClause);

        final Page> responsePage = HqlQueryHelper
            .execute(getHistoryTemplate(), historyClass, builder, validPageable, getWMQLTypeHelper());

        return responsePage.map(TemporalHistoryEntity::asParent);
    }

    @Override
    public int update(
        final Map identifier, final PeriodClause periodClause, final E entity) {
        UpdateQueryBuilder builder = new UpdateQueryBuilder(historyClass);

        builder.withFilterConditions(identifier);
        builder.withPeriodClause(periodClause);

        updatableProperties.forEach(property -> {
            try {
                builder.withSetter(property.getName(),
                    property.getReadMethod().invoke(entity));
            } catch (IllegalAccessException | InvocationTargetException e) {
                throw new WMRuntimeException(MessageResource.create("com.wavemaker.runtime.property.read.error"), e, property.getName());
            }
        });

        return executeUpdateDeleteQuery(builder.build());
    }

    @Override
    public int update(
        final PeriodClause periodClause, final String filter, final E entity) {
        UpdateQueryBuilder builder = new UpdateQueryBuilder(historyClass);

        builder.withFilter(filter);
        builder.withPeriodClause(periodClause);

        updatableProperties.forEach(property -> {
            try {
                builder.withSetter(property.getName(),
                    property.getReadMethod().invoke(entity));
            } catch (IllegalAccessException | InvocationTargetException e) {
                throw new WMRuntimeException("Error while reading property: " + property.getName() + " value", e);
            }
        });

        return executeUpdateDeleteQuery(builder.build());
    }

    @Override
    public int delete(final Map identifier, final PeriodClause periodClause) {
        DeleteQueryBuilder builder = new DeleteQueryBuilder(historyClass);

        builder.withFilterConditions(identifier);
        builder.withPeriodClause(periodClause);

        return executeUpdateDeleteQuery(builder.build());
    }

    @Override
    public int delete(final PeriodClause periodClause, final String filter) {
        DeleteQueryBuilder builder = new DeleteQueryBuilder(historyClass);

        builder.withFilter(filter);
        builder.withPeriodClause(periodClause);

        return executeUpdateDeleteQuery(builder.build());
    }

    private int executeUpdateDeleteQuery(final WMQueryInfo queryInfo) {
        return getHistoryTemplate().execute(session -> {
            final Query query = session.createQuery(queryInfo.getQuery());
            ParametersConfigurator.configure(query, queryInfo.getParameterValueMap(getWMQLTypeHelper()),
                new RuntimeParameterTypeResolver(queryInfo.getParameters(), session.getTypeHelper(), getWMQLTypeHelper()));
            return query.executeUpdate();
        });
    }
}