io.ebeaninternal.server.deploy.meta.DeployTableJoinColumn Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation
composite of common runtime dependencies for all platforms
There is a newer version: 15.8.1
package io.ebeaninternal.server.deploy.meta;

import io.ebeaninternal.server.deploy.BeanProperty;
import io.ebeaninternal.server.deploy.BeanTable;

import javax.persistence.JoinColumn;

/**
 * A join pair of local and foreign properties.
 */
public class DeployTableJoinColumn {

  /**
   * The local database column name.
   */
  String localDbColumn;

  /**
   * SQL formula used for local column
   */
  String localSqlFormula;

  /**
   * The foreign database column name.
   */
  String foreignDbColumn;

  /**
   * SQL formula used for foreign column
   */
  String foreignSqlFormula;

  boolean insertable;

  boolean updateable;


  /**
   * Construct when automatically determining the join.
   * 
   * Assume that we want the foreign key to be insertable and updateable.
   * 
   */
  public DeployTableJoinColumn(String localDbColumn, String foreignDbColumn) {
    this(localDbColumn, foreignDbColumn, true, true);
  }

  /**
   * Construct with explicit insertable and updateable flags.
   */
  public DeployTableJoinColumn(String localDbColumn, String foreignDbColumn, boolean insertable, boolean updateable) {
    this.localDbColumn = nullEmptyString(localDbColumn);
    this.foreignDbColumn = nullEmptyString(foreignDbColumn);
    this.insertable = insertable;
    this.updateable = updateable;
  }

  public void setLocalSqlFormula(String localSqlFormula) {
    if (localSqlFormula != null) {
      this.localSqlFormula = localSqlFormula;
      this.localDbColumn = null;
      this.insertable = false;
      this.updateable = false;
    }
  }

  public String getLocalSqlFormula() {
    return localSqlFormula;
  }

  public void setForeignSqlFormula(String foreignSqlFormula) {
    if (foreignSqlFormula != null) {
      this.foreignSqlFormula = foreignSqlFormula;
      this.foreignDbColumn = null;
      this.insertable = false;
      this.updateable = false;
    }
  }

  public String getForeignSqlFormula() {
    return foreignSqlFormula;
  }


  public DeployTableJoinColumn(boolean order, JoinColumn jc, BeanTable beanTable) {
    this(jc.referencedColumnName(), jc.name(), jc.insertable(), jc.updatable());
    setReferencedColumn(beanTable);
    if (!order) {
      reverse();
    }
  }

  private void setReferencedColumn(BeanTable beanTable) {
    if (localDbColumn == null) {
      BeanProperty idProperty = beanTable.getIdProperty();
      if (idProperty != null) {
        localDbColumn = idProperty.getDbColumn();
      }
    }
  }

  /**
   * Reverse the direction of the join.
   */
  public DeployTableJoinColumn reverse() {
    String temp = localDbColumn;
    localDbColumn = foreignDbColumn;
    foreignDbColumn = temp;

    temp = localSqlFormula;
    localSqlFormula = foreignSqlFormula;
    foreignSqlFormula = temp;
    return this;
  }

  /**
   * Helper method to null out empty strings.
   */
  private String nullEmptyString(String s) {
    if ("".equals(s)) {
      return null;
    }
    return s;
  }


  public DeployTableJoinColumn copy(boolean reverse) {
    // Note that the insertable and updateable are just copied
    // which may not always be the correct thing to do
    // but will leave it like this for now
    DeployTableJoinColumn ret;
    if (reverse) {
      ret = new DeployTableJoinColumn(foreignDbColumn, localDbColumn, insertable, updateable);
      ret.setLocalSqlFormula(foreignSqlFormula);
      ret.setForeignSqlFormula(localSqlFormula);

    } else {
      ret = new DeployTableJoinColumn(localDbColumn, foreignDbColumn, insertable, updateable);
      ret.setLocalSqlFormula(localSqlFormula);
      ret.setForeignSqlFormula(foreignSqlFormula);
    }
    return ret;
  }

  @Override
  public String toString() {
    return localDbColumn + " = " + foreignDbColumn;
  }

  /**
   * Return true if this column should be insertable.
   */
  public boolean isInsertable() {
    return insertable;
  }

  /**
   * Return true if this column should be updateable.
   */
  public boolean isUpdateable() {
    return updateable;
  }

  /**
   * Return the foreign database column name.
   */
  public String getForeignDbColumn() {
    return foreignDbColumn;
  }

  /**
   * Return the local database column name.
   */
  public String getLocalDbColumn() {
    return localDbColumn;
  }

  /**
   * Set the local database column name.
   */
  public void setLocalDbColumn(String localDbColumn) {
    this.localDbColumn = localDbColumn;
  }

}