com.rapiddweller.jdbacl.identity.IdentityModel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rd-lib-jdbacl Show documentation
'jdbacl' stands for 'Java DataBase ACcess Layer' and provides utilities for accessing JDBC databases from Java programs, retrieving meta information in an object model and querying database data. 'rapiddweller jdbacl' is forked from Databene jdbacl by Volker Bergmann.
The newest version!
/*
 * (c) Copyright 2010-2011 by Volker Bergmann. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, is permitted under the terms of the
 * GNU General Public License (GPL).
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS,
 * REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
 * HEREBY EXCLUDED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package com.rapiddweller.jdbacl.identity;

import com.rapiddweller.common.ArrayFormat;
import com.rapiddweller.common.Assert;
import com.rapiddweller.common.ErrorHandler;
import com.rapiddweller.common.Level;
import com.rapiddweller.common.Named;
import com.rapiddweller.common.bean.HashCodeBuilder;
import com.rapiddweller.common.exception.ExceptionFactory;
import com.rapiddweller.common.iterator.TabularIterator;
import com.rapiddweller.jdbacl.ArrayResultSetIterator;
import com.rapiddweller.jdbacl.model.DBRow;
import com.rapiddweller.jdbacl.model.Database;
import org.slf4j.LoggerFactory;
import org.slf4j.Logger;

import java.sql.Connection;
import java.util.HashSet;
import java.util.Set;

/**
 * Abstract parent for classes which provide information about tables
 * and features for processing the tables.


 * Created: 01.09.2010 08:53:02
 * @author Volker Bergmann
 * @since 0.6.4
 */
public abstract class IdentityModel implements Named {

  protected final Logger logger = LoggerFactory.getLogger(this.getClass());

  final ErrorHandler errorHandler = new ErrorHandler("DBMerger", Level.warn);

  final String tableName;
  private final Set unimportantColumns;

  protected IdentityModel(String tableName) {
    Assert.notNull(tableName, "tableName");
    this.tableName = tableName;
    this.unimportantColumns = new HashSet<>();
  }

  // properties ------------------------------------------------------------------------------------------------------

  public String getTableName() {
    return tableName;
  }

  @Override
  public String getName() {
    return tableName;
  }

  public void addIrrelevantColumn(String unimportantColumn) {
    this.unimportantColumns.add(unimportantColumn);
  }

  // functional interface --------------------------------------------------------------------------------------------

  public abstract TabularIterator createNkPkIterator(
      Connection connection, String dbId, KeyMapper mapper, Database database);

  public String extractNK(Object[] nkPkTuple) {
    return String.valueOf(nkPkTuple[0]);
  }

  public Object extractPK(Object[] nkPkTuple) {
    if (nkPkTuple.length == 2) {
      return nkPkTuple[1];
    } else if (nkPkTuple.length > 2) {
      Object[] pk = new Object[nkPkTuple.length - 1];
      System.arraycopy(nkPkTuple, 1, pk, 0, nkPkTuple.length - 1);
      return pk;
    } else {
      throw ExceptionFactory.getInstance().illegalOperation("Table " + tableName + " does not have a primary key");
    }
  }

  public abstract String getDescription();

  // non-public helpers ----------------------------------------------------------------------------------------------

  protected TabularIterator query(String query, Connection connection) {
    Assert.notEmpty(query, "query");
    return new ArrayResultSetIterator(connection, query);
  }

  protected void handleNKNotFound(String naturalKey, String tableName, String sourceDbId, String targetDbId) {
    String message = "Missing entry: " + sourceDbId + '.' + tableName + "[" + naturalKey + "]" +
        " does not appear in " + targetDbId;
    errorHandler.handleError(message);
  }

  protected void handleNonEquivalence(String message, Object pk, DBRow entity) {
    errorHandler.handleError(message);
  }

  protected void handleMissingOwner(String ownedTableName, DBRow ownedEntity, String ownerTableName, Object ownerId,
                                    String sourceDbId) {
    String message = "Owner of " + sourceDbId + '.' + ownedTableName +
        '[' + ArrayFormat.format(ownedEntity.getPKValues()) + "] was dropped. " +
        "Missing: " + sourceDbId + '.' + ownerTableName + '[' + ownerId + "]. " +
        "Possibly it was rejected or it was missing in the NK query";
    errorHandler.handleError(message);
  }

  // java.lang.Object overrides --------------------------------------------------------------------------------------

  @Override
  public int hashCode() {
    return HashCodeBuilder.hashCode(tableName);
  }

  @Override
  public boolean equals(Object obj) {
    if (obj == this) {
      return true;
    }
    if (obj == null || this.getClass() != obj.getClass()) {
      return false;
    }
    IdentityModel that = (IdentityModel) obj;
    return this.tableName.equals(that.tableName);
  }

  @Override
  public String toString() {
    return getClass().getSimpleName() + "(" + tableName + ")";
  }

}