ca.gc.aafc.dina.service.ManagedAttributeService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dina-base-api Show documentation
Base DINA API package for Java built on SpringBoot and Crnk
The newest version!
package ca.gc.aafc.dina.service;

import ca.gc.aafc.dina.entity.ManagedAttribute;
import ca.gc.aafc.dina.jpa.BaseDAO;
import ca.gc.aafc.dina.jpa.PredicateHelper;
import lombok.NonNull;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang3.RegExUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.tuple.Pair;
import org.springframework.validation.SmartValidator;

import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.Predicate;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.function.Function;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

/**
 * Base Managed Attribute Service that takes care of the generation of the key.
 *
 * @param 
 */
public abstract class ManagedAttributeService
  extends DefaultDinaService {
  private static final String KEY = "key";
  private static final Pattern NON_ALPHANUMERICAL = Pattern.compile("[^a-z0-9]");
  private final Class maClass;

  public ManagedAttributeService(BaseDAO baseDAO, SmartValidator smartValidator, @NonNull Class managedAttributeClass) {
    super(baseDAO, smartValidator);
    this.maClass = managedAttributeClass;
  }

  @Override
  protected void preCreate(T entity) {
    if (StringUtils.isNotBlank(entity.getName())) {
      entity.setKey(generateKeyFromName(entity.getName()));
    }
  }

  @Override
  protected void preDelete(T entity) {
    throw new UnsupportedOperationException("DELETE");
  }

  public Map findAttributesForKeys(Set keySet) {
    return findAttributesForKeys(keySet, null);
  }

  public Map findAttributesForKeys(Set keySet, Pair andClause) {
    if (CollectionUtils.isEmpty(keySet)) {
      return Map.of();
    }
    return this.findAll(
        maClass, (criteriaBuilder, eRoot) -> {
          CriteriaBuilder.In in = criteriaBuilder.in(eRoot.get(KEY));
          keySet.forEach(in::value);

          if (andClause == null) {
            return new Predicate[]{in};
          }

          return new Predicate[]{PredicateHelper.appendPropertiesEqual(in, criteriaBuilder, eRoot, List.of(andClause))};
        },
        null, 0, Integer.MAX_VALUE
    ).stream().collect(Collectors.toMap(ManagedAttribute::getKey, Function.identity()));
  }

  public T findOneByKey(String key) {
    return findOneByProperty(maClass, KEY, key);
  }

  /**
   * Find a managed attribute by key and another property that is part of the unique constraint.
   * @param key
   * @param andClause clause that should be added to
   * @return
   */
  public T findOneByKeyAnd(String key, Pair andClause) {
    return findOneByProperties(maClass,
        List.of(Pair.of(KEY, key), andClause));
  }

  /**
   * Transforms a name into a key. camelCase is supported.
   * "Aa bb !! mySuperAttribute # 11" will become aa_bb_my_super_attribute_11
   * @param name
   * @return
   */
  private static String generateKeyFromName(String name) {
    Objects.requireNonNull(name);

    return Arrays.stream(StringUtils.
        splitByCharacterTypeCamelCase(StringUtils.normalizeSpace(name)))
        .filter(StringUtils::isNotBlank)
        .map(ManagedAttributeService::processName)
        .filter(StringUtils::isNotBlank)
        .collect(Collectors.joining("_"));
  }

  private static String processName(String name) {
    return RegExUtils.removeAll(name.toLowerCase(), NON_ALPHANUMERICAL);
  }

}