com.rapiddweller.jdbacl.model.DBIndex 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 2006-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.
 *
 * For redistributing this software or a derivative work under a license other
 * than the GPL-compatible Free Software License as defined by the Free
 * Software Foundation or approved by OSI, you must first obtain a commercial
 * license to this software product from Volker Bergmann.
 *
 * 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.model;

import com.rapiddweller.common.ArrayFormat;
import com.rapiddweller.common.NullSafeComparator;
import com.rapiddweller.common.bean.HashCodeBuilder;

import java.util.Arrays;

/**
 * Represents a database index.


 * Created: 06.01.2007 08:58:49
 *
 * @author Volker Bergmann
 */
public abstract class DBIndex extends AbstractDBTableComponent implements MultiColumnObject {

  private static final long serialVersionUID = -1656761838194962745L;

  private final boolean nameDeterministic;

  /**
   * Instantiates a new Db index.
   */
  public DBIndex() {
    this(null, false, null);
  }

  /**
   * Instantiates a new Db index.
   *
   * @param name              the name
   * @param nameDeterministic the name deterministic
   * @param table             the table
   */
  public DBIndex(String name, boolean nameDeterministic, DBTable table) {
    super(name, "index", table);
    this.nameDeterministic = nameDeterministic;
    table.addIndex(this);
  }

  /**
   * Is unique boolean.
   *
   * @return the boolean
   */
  public abstract boolean isUnique();

  @Override
  public abstract String[] getColumnNames();

  /**
   * Add column name.
   *
   * @param columnName the column name
   */
  public abstract void addColumnName(String columnName);


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

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

  /**
   * Is name deterministic boolean.
   *
   * @return the boolean
   */
  public boolean isNameDeterministic() {
    return nameDeterministic;
  }


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

  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null || obj.getClass() != this.getClass()) {
      return false;
    }
    DBIndex that = (DBIndex) obj;
    return NullSafeComparator.equals(this.getName(), that.getName())
        && NullSafeComparator.equals(this.getTable(), that.getTable())
        && NullSafeComparator.equals(this.isUnique(), that.isUnique())
        && Arrays.equals(this.getColumnNames(), that.getColumnNames());
  }

  @Override
  public int hashCode() {
    return HashCodeBuilder.hashCode(getOwner(), getColumnNames());
  }

  @Override
  public String toString() {
    StringBuilder builder = new StringBuilder(name);
    builder.append(" (");
    builder.append(ArrayFormat.format(getColumnNames()));
    builder.append(')');
    builder.append(isUnique() ? " unique" : "");
    return builder.toString();
  }

}