io.ebeaninternal.dbmigration.model.MCompoundForeignKey Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebean-ddl-generator Show documentation
DDL and DB Migration generation
There is a newer version: 15.8.0
package io.ebeaninternal.dbmigration.model;

import io.ebean.annotation.ConstraintMode;
import io.ebeaninternal.dbmigration.ddlgeneration.platform.DdlHelp;
import io.ebeaninternal.dbmigration.migration.AlterForeignKey;
import io.ebeaninternal.dbmigration.migration.ForeignKey;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

/**
 * A unique constraint for multiple columns.
 * 
 * Note that unique constraint on a single column is instead
 * a boolean flag on the associated MColumn.
 * 
 */
public class MCompoundForeignKey {

  private String name;
  private final String referenceTable;
  private final List columns = new ArrayList<>();
  private final List referenceColumns = new ArrayList<>();
  private String indexName;
  private ConstraintMode fkeyOnDelete;
  private ConstraintMode fkeyOnUpdate;

  public MCompoundForeignKey(String name, String referenceTable, String indexName) {
    this.name = name;
    this.referenceTable = referenceTable;
    this.indexName = indexName;
  }

  /**
   * Add a column pair of local and referenced column.
   */
  public void addColumnPair(String dbCol, String refColumn) {
    columns.add(dbCol);
    referenceColumns.add(refColumn);
  }

  /**
   * Create and return an ForeignKey migration element.
   */
  public ForeignKey createForeignKey() {
    ForeignKey fk = new ForeignKey();
    fk.setName(name);
    fk.setIndexName(indexName);
    fk.setColumnNames(toColumnNames(columns));
    fk.setRefColumnNames(toColumnNames(referenceColumns));
    fk.setRefTableName(referenceTable);
    fk.setOnDelete(fkeyModeOf(fkeyOnDelete));
    fk.setOnUpdate(fkeyModeOf(fkeyOnUpdate));
    return fk;
  }

  private String fkeyModeOf(ConstraintMode mode) {
    return (mode == null) ? null : mode.name();
  }

  /**
   * Create and return an AlterForeignKey migration element.
   */
  public AlterForeignKey addForeignKey(String tableName) {
    AlterForeignKey fk = new AlterForeignKey();
    fk.setName(name);
    fk.setIndexName(indexName);
    fk.setColumnNames(toColumnNames(columns));
    fk.setRefColumnNames(toColumnNames(referenceColumns));
    fk.setRefTableName(referenceTable);
    fk.setTableName(tableName);
    return fk;
  }

  /**
   * Create and return an AlterForeignKey migration element.
   */
  public AlterForeignKey dropForeignKey(String tableName) {
    AlterForeignKey fk = new AlterForeignKey();
    fk.setName(name);
    fk.setIndexName(indexName);
    fk.setColumnNames(DdlHelp.DROP_FOREIGN_KEY);
    fk.setTableName(tableName);
    return fk;
  }

  /**
   * Add a counter to the foreign key and index names to avoid duplication.
   */
  public void addNameSuffix(int counter) {
    this.name = name + "_" + counter;
    this.indexName = indexName + "_" + counter;
  }

  /**
   * Return the foreign key name.
   */
  public String getName() {
    return name;
  }

  /**
   * Return the index name.
   */
  public String getIndexName() {
    return indexName;
  }

  /**
   * Return the columns making up the foreign key in order.
   */
  public List getColumns() {
    return columns;
  }

  /**
   * Set the associated index name. Note that setting to null has the effect
   * of indicating an associated index should not be created for this foreign key.
   */
  public void setIndexName(String indexName) {
    this.indexName = indexName;
  }

  /**
   * Return as an array of string column names.
   */
  private String toColumnNames(List columns) {
    StringBuilder sb = new StringBuilder(40);
    for (int i = 0; i < columns.size(); i++) {
      if (i > 0) {
        sb.append(',');
      }
      sb.append(columns.get(i));
    }
    return sb.toString();
  }

  @Override
  public int hashCode() {
    return Objects.hash(columns, indexName, name, referenceColumns, referenceTable);
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj)
      return true;
    if (!(obj instanceof MCompoundForeignKey))
      return false;

    MCompoundForeignKey other = (MCompoundForeignKey) obj;
    return Objects.equals(columns, other.columns)
        && Objects.equals(indexName, other.indexName)
        && Objects.equals(name, other.name)
        && Objects.equals(referenceColumns, other.referenceColumns)
        && Objects.equals(referenceTable, other.referenceTable);
  }

  public void setForeignKeyModes(ConstraintMode onDelete, ConstraintMode onUpdate) {
    this.fkeyOnDelete = onDelete;
    this.fkeyOnUpdate = onUpdate;
  }
}