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

Go to download
package ca.gc.aafc.dina.service;

import java.util.List;
import java.util.UUID;

import org.apache.commons.lang3.tuple.Pair;

import ca.gc.aafc.dina.config.ResourceNameIdentifierConfig;
import ca.gc.aafc.dina.entity.DinaEntity;
import ca.gc.aafc.dina.jpa.BaseDAO;

/**
 * Service that get an identifier (UUID) by name (text given to an entity). The name is assigned by the user.
 * This class assumes the DinaEntity has unique name per group.
 *
 * Conditional bean created by ResourceNameIdentifierAutoConfiguration
 */
public class ResourceNameIdentifierService {

  private static final int DEFAULT_PAGE_SIZE = 20;
  private static final int MAX_PAGE_SIZE = 1000;

  private final BaseDAO baseDAO;
  private final ResourceNameIdentifierConfig config;

  public ResourceNameIdentifierService(BaseDAO baseDAO, ResourceNameIdentifierConfig config) {
    this.baseDAO = baseDAO;
    this.config = config;
  }

  /**
   * Find the UUID identifier by name (textual name given by the user).
   * Uniqueness of the name within the group is assumed.
   * @param entityClass
   * @param name textual name given by the user to the entity
   * @param group group where the uniqueness of the name is assumed
   * @return uuid or null if not found
   */
  public  UUID findByName(Class entityClass, String name, String group) {

    ResourceNameIdentifierConfig.ResourceNameConfig
      resourceNameConfig = config.getResourceNameConfig(entityClass).orElse(ResourceNameIdentifierConfig.DEFAULT_CONFIG);

    StringBuilder sb = new StringBuilder("SELECT t.uuid FROM " );
    sb.append(entityClass.getName());
    sb.append(" t WHERE ");
    sb.append(resourceNameConfig.groupColumn());
    sb.append("=:group");
    sb.append(" AND ");
    sb.append(resourceNameConfig.nameColumn());
    sb.append("=:name");

    return baseDAO.findOneByQuery(UUID.class, sb.toString(), List.of(Pair.of("name", name),
      Pair.of("group", group)));
  }

  public  List findAllByNames(Class entityClass, List names, String group) {

    ResourceNameIdentifierConfig.ResourceNameConfig
      resourceNameConfig = config.getResourceNameConfig(entityClass).orElse(ResourceNameIdentifierConfig.DEFAULT_CONFIG);

    StringBuilder sb = new StringBuilder("SELECT new ");
    sb.append(NameUUIDPair.class.getCanonicalName());
    sb.append(" (t.");
    sb.append(resourceNameConfig.nameColumn());
    sb.append(", t.uuid) FROM " );
    sb.append(entityClass.getName());
    sb.append(" t WHERE ");
    sb.append(resourceNameConfig.groupColumn());
    sb.append("=:group");
    sb.append(" AND ");
    sb.append(resourceNameConfig.nameColumn());
    sb.append(" IN (:names)");

    return baseDAO.findAllByQuery(NameUUIDPair.class, sb.toString(), List.of(Pair.of("names", names),
      Pair.of("group", group)));
  }

  /**
   * List all nameUUIDPair for a specific type and group.
   *
   * @param entityClass
   * @param group
   * @param pageNumber
   * @param pageSize
   * @return
   */
  public  List listNameUUIDPair(Class entityClass, String group, int pageNumber, int pageSize) {

    ResourceNameIdentifierConfig.ResourceNameConfig
      resourceNameConfig = config.getResourceNameConfig(entityClass).orElse(ResourceNameIdentifierConfig.DEFAULT_CONFIG);

    int limit = pageSize > 0 ? Math.min(pageSize, MAX_PAGE_SIZE) : DEFAULT_PAGE_SIZE;
    int offset = Math.max(pageNumber, 0);

    StringBuilder sb = new StringBuilder("SELECT new ");
    sb.append(NameUUIDPair.class.getCanonicalName());
    sb.append(" (t.");
    sb.append(resourceNameConfig.nameColumn());
    sb.append(", t.uuid) FROM " );
    sb.append(entityClass.getName());
    sb.append(" t WHERE ");
    sb.append(resourceNameConfig.groupColumn());
    sb.append("=:group");
    // since it's a DinaEntity we assume createdOne is a valid column
    sb.append(" ORDER BY createdOn");

    return baseDAO.findAllByQuery(NameUUIDPair.class, sb.toString(),
      List.of(Pair.of("group", group)), limit, offset);
  }
}