org.molgenis.data.postgresql.PostgreSqlNameGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of molgenis-data-postgresql Show documentation
Data layer persistence in PostgreSQL.
There is a newer version: 8.4.5
Show newest version
package org.molgenis.data.postgresql;

import org.molgenis.data.meta.model.Attribute;
import org.molgenis.data.meta.model.EntityType;

public class PostgreSqlNameGenerator {
  static final String JUNCTION_TABLE_ORDER_ATTR_NAME = "order";

  /**
   * Maximum identifier length in bytes.
   *
   * https://www.postgresql.org/docs/current/static/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS
   */
  private static final int MAX_IDENTIFIER_BYTE_LENGTH = 63;

  private PostgreSqlNameGenerator() {}

  /**
   * Returns the double-quoted table name based on entity name
   *
   * @param entityType entity meta data
   * @return table name for this entity
   */
  static String getTableName(EntityType entityType) {
    return getTableName(entityType, true);
  }

  /**
   * Returns the table name based on entity name
   *
   * @param entityType entity meta data
   * @return PostgreSQL table name
   */
  public static String getTableName(EntityType entityType, boolean quotedIdentifier) {
    return getTableName(entityType, quotedIdentifier, MAX_IDENTIFIER_BYTE_LENGTH);
  }

  private static String getTableName(
      EntityType entityType, boolean quotedIdentifier, int maxLength) {
    String identifier = new PostgreSqlIdGenerator(maxLength).generateId(entityType);
    return quotedIdentifier ? getQuotedIdentifier(identifier) : identifier;
  }

  static String getJunctionTableName(EntityType entityType, Attribute attr) {
    return getJunctionTableName(entityType, attr, true);
  }

  /**
   * Returns the junction table name for the given attribute of the given entity
   *
   * @param entityType entity meta data that owns the attribute
   * @param attr attribute
   * @return PostgreSQL junction table name
   */
  public static String getJunctionTableName(
      EntityType entityType, Attribute attr, boolean quotedIdentifier) {
    int nrAdditionalChars = 1;
    String entityPart =
        generateId(entityType, (MAX_IDENTIFIER_BYTE_LENGTH - nrAdditionalChars) / 2);
    String attrPart = generateId(attr, (MAX_IDENTIFIER_BYTE_LENGTH - nrAdditionalChars) / 2);
    return quotedIdentifier
        ? getQuotedIdentifier(entityPart + '_' + attrPart)
        : entityPart + '_' + attrPart;
  }

  /**
   * Returns the junction table index name for the given indexed attribute in a junction table
   *
   * @param entityType entity meta data
   * @param attr attribute
   * @param idxAttr indexed attribute
   * @return PostgreSQL junction table index name
   */
  static String getJunctionTableIndexName(
      EntityType entityType, Attribute attr, Attribute idxAttr) {
    String indexNamePostfix = "_idx";
    int nrAdditionalChars = 1 + indexNamePostfix.length();
    String entityPart =
        generateId(entityType, (MAX_IDENTIFIER_BYTE_LENGTH - nrAdditionalChars) / 3);
    String attrPart = generateId(attr, (MAX_IDENTIFIER_BYTE_LENGTH - nrAdditionalChars) / 3);
    String idxAttrPart = generateId(idxAttr, (MAX_IDENTIFIER_BYTE_LENGTH - nrAdditionalChars) / 3);
    return getQuotedIdentifier(entityPart + '_' + attrPart + '_' + idxAttrPart + indexNamePostfix);
  }

  static String getColumnName(Attribute attr) {
    return getColumnName(attr, true);
  }

  public static String getColumnName(Attribute attr, boolean quotedIdentifier) {
    String identifier = generateId(attr, MAX_IDENTIFIER_BYTE_LENGTH);
    return quotedIdentifier ? getQuotedIdentifier(identifier) : identifier;
  }

  static String getJunctionTableOrderColumnName() {
    return getQuotedIdentifier(JUNCTION_TABLE_ORDER_ATTR_NAME);
  }

  static String getFilterColumnName(Attribute attr, int filterIndex) {
    String filterPostfix = "filter" + filterIndex;
    int nrAdditionalChars = 1 + filterPostfix.length();
    String attrId = generateId(attr, MAX_IDENTIFIER_BYTE_LENGTH - nrAdditionalChars);
    return getQuotedIdentifier(attrId + '_' + filterPostfix);
  }

  static String getPrimaryKeyName(EntityType entityType, Attribute attr) {
    return getConstraintName(entityType, attr, "pkey");
  }

  static String getForeignKeyName(EntityType entityType, Attribute attr) {
    return getConstraintName(entityType, attr, "fkey");
  }

  static String getUniqueKeyName(EntityType entityType, Attribute attr) {
    return getConstraintName(entityType, attr, "key");
  }

  static String getCheckConstraintName(EntityType entityType, Attribute attr) {
    return getConstraintName(entityType, attr, "chk");
  }

  private static String getConstraintName(
      EntityType entityType, Attribute attr, String constraintPostfix) {
    int nrAdditionalChars = 2 + constraintPostfix.length();
    String entityPart =
        generateId(entityType, (MAX_IDENTIFIER_BYTE_LENGTH - nrAdditionalChars) / 2);
    String attrPart = generateId(attr, (MAX_IDENTIFIER_BYTE_LENGTH - nrAdditionalChars) / 2);
    return getQuotedIdentifier(entityPart + '_' + attrPart + '_' + constraintPostfix);
  }

  static String getFunctionValidateUpdateName(EntityType entityType) {
    String prefix = "validate_update";
    int maxLength = MAX_IDENTIFIER_BYTE_LENGTH - prefix.length() - 1;
    return getQuotedIdentifier(prefix + '_' + getTableName(entityType, false, maxLength));
  }

  static String getUpdateTriggerName(EntityType entityType) {
    String prefix = "update_trigger";
    int maxLength = MAX_IDENTIFIER_BYTE_LENGTH - prefix.length() - 1;
    String identifier = prefix + '_' + getTableName(entityType, false, maxLength);
    return getQuotedIdentifier(identifier);
  }

  private static String getQuotedIdentifier(String identifier) {
    return '"' + identifier + '"';
  }

  private static String generateId(EntityType entityType, int maxByteLength) {
    return new PostgreSqlIdGenerator(maxByteLength).generateId(entityType);
  }

  private static String generateId(Attribute attr, int maxByteLength) {
    return new PostgreSqlIdGenerator(maxByteLength).generateId(attr);
  }
}