schemacrawler.crawl.AbstractColumn Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of schemacrawler Show documentation

SchemaCrawler is an open-source Java API that makes working with database metadata as easy as working with plain old Java objects. SchemaCrawler is also a database schema discovery and comprehension, and schema documentation tool. You can search for database schema objects using regular expressions, and output the schema and data in a readable text format. The output is designed to be diff-ed against other database schemas.

There is a newer version: 16.24.2

Show newest version

/*
========================================================================
SchemaCrawler
http://www.schemacrawler.com
Copyright (c) 2000-2024, Sualeh Fatehi .
All rights reserved.
------------------------------------------------------------------------

SchemaCrawler is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

SchemaCrawler and the accompanying materials are made available under
the terms of the Eclipse Public License v1.0, GNU General Public License
v3 or GNU Lesser General Public License v3.

You may elect to redistribute this code under any of these licenses.

The Eclipse Public License is available at:
http://www.eclipse.org/legal/epl-v10.html

The GNU General Public License v3 and the GNU Lesser General Public
License v3 are available at:
http://www.gnu.org/licenses/

========================================================================
 */

package schemacrawler.crawl;

import schemacrawler.schema.BaseColumn;
import schemacrawler.schema.ColumnDataType;
import schemacrawler.schema.DatabaseObject;
import schemacrawler.schema.JavaSqlTypeGroup;
import schemacrawler.schema.NamedObject;

/**
 * Represents a column in a database for tables and routines. Created from metadata returned by a
 * JDBC call.
 */
abstract class AbstractColumn extends AbstractDependantObject

    implements BaseColumn
 {

  private static final long serialVersionUID = -8492662324895309485L;

  private ColumnDataType columnDataType;
  private int decimalDigits;
  private boolean nullable;
  private int ordinalPosition;
  private int size;

  /**
   * Effective Java - Item 17 - Minimize Mutability - Package-private constructors make a class
   * effectively final
   *
   * @param parent Parent of this object
   * @param name Name of the named object
   */
  AbstractColumn(final DatabaseObjectReference
 parent, final String name) {
    super(parent, name);
  }

  /**
   * {@inheritDoc}
   *
   * 
NOTE: compareTo is not compatible with equals. equals compares the full name of a database
   * object, but compareTo uses more fields to define a "natural" sorting order. compareTo may
   * return incorrect results until the object is fully built by SchemaCrawler.
   */
  @Override
  public final int compareTo(final NamedObject obj) {
    if (obj == null) {
      return -1;
    }

    final BaseColumn
 other = (BaseColumn) obj;
    int comparison = 0;

    if (comparison == 0) {
      comparison = ordinalPosition - other.getOrdinalPosition();
    }
    if (comparison == 0) {
      comparison = super.compareTo(other);
    }

    return comparison;
  }

  /** {@inheritDoc} */
  @Override
  public final ColumnDataType getColumnDataType() {
    return columnDataType;
  }

  /** {@inheritDoc} */
  @Override
  public final int getDecimalDigits() {
    return decimalDigits;
  }

  /** {@inheritDoc} */
  @Override
  public final int getOrdinalPosition() {
    return ordinalPosition;
  }

  /** {@inheritDoc} */
  @Override
  public final int getSize() {
    return size;
  }

  /** {@inheritDoc} */
  @Override
  public final ColumnDataType getType() {
    return getColumnDataType();
  }

  /** {@inheritDoc} */
  @Override
  public final String getWidth() {

    if (!isColumnDataTypeKnown()) {
      return "";
    }

    final ColumnDataType columnDataType = getColumnDataType();

    if (size <= 0 || size >= 2_000_000_000) {
      return "";
    }

    final JavaSqlTypeGroup sqlDataTypeGroup = columnDataType.getJavaSqlType().getJavaSqlTypeGroup();
    final boolean needWidth =
        sqlDataTypeGroup == JavaSqlTypeGroup.character || sqlDataTypeGroup == JavaSqlTypeGroup.real;

    final StringBuilder columnWidthBuffer = new StringBuilder(64);
    if (needWidth) {
      columnWidthBuffer.append('(');
      columnWidthBuffer.append(size);
      if (sqlDataTypeGroup == JavaSqlTypeGroup.real) {
        columnWidthBuffer.append(", ").append(getDecimalDigits());
      }
      columnWidthBuffer.append(')');
    }

    return columnWidthBuffer.toString();
  }

  /** {@inheritDoc} */
  @Override
  public final boolean isColumnDataTypeKnown() {
    return columnDataType != null;
  }

  /** {@inheritDoc} */
  @Override
  public final boolean isNullable() {
    return nullable;
  }

  final void setColumnDataType(final ColumnDataType columnDataType) {
    this.columnDataType = columnDataType;
  }

  final void setDecimalDigits(final int decimalDigits) {
    this.decimalDigits = decimalDigits;
  }

  final void setNullable(final boolean nullable) {
    this.nullable = nullable;
  }

  final void setOrdinalPosition(final int ordinalPosition) {
    this.ordinalPosition = ordinalPosition;
  }

  /**
   * Sets the column size.
   *
   * @param size Size of the column
   */
  final void setSize(final int size) {
    this.size = size;
  }
}