Package org.jumpmind.db.model

Class Table

java.lang.Object
org.jumpmind.db.model.Table
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Table>
public class Table extends Object implements Serializable, Cloneable, Comparable<Table>
Represents a table in the database model.
See Also:

  • Constructor Details

  • Method Details

    • removeAllColumns

      public void removeAllColumns()

    • removeAllColumnDefaults

      public void removeAllColumnDefaults()

    • removeAllIndices

      public void removeAllIndices()

    • removeAllForeignKeys

      public void removeAllForeignKeys()

    • removeAllIndexes

      public void removeAllIndexes()

    • removeAllTriggers

      public void removeAllTriggers()

    • getCatalog

      public String getCatalog()
      Returns the catalog of this table as read from the database.
      Returns:
      The catalog

    • setCatalog

      public void setCatalog(String catalog)
      Sets the catalog of this table.
      Parameters:
      catalog - The catalog

    • getSchema

      public String getSchema()
      Returns the schema of this table as read from the database.
      Returns:
      The schema

    • setSchema

      public void setSchema(String schema)
      Sets the schema of this table.
      Parameters:
      schema - The schema

    • getType

      public String getType()
      Returns the type of this table as read from the database.
      Returns:
      The type

    • setType

      public void setType(String type)
      Sets the type of this table.
      Parameters:
      type - The type

    • getName

      public String getName()
      Returns the name of the table.
      Returns:
      The name

    • setName

      public void setName(String name)
      Sets the name of the table.
      Parameters:
      name - The name

    • getDescription

      public String getDescription()
      Returns the description of the table.
      Returns:
      The description

    • setDescription

      public void setDescription(String description)
      Sets the description of the table.
      Parameters:
      description - The description

    • getColumnCount

      public int getColumnCount()
      Returns the number of columns in this table.
      Returns:
      The number of columns

    • getPrimaryKeyColumnCount

      public int getPrimaryKeyColumnCount()

    • getColumn

      public Column getColumn(int idx)
      Returns the column at the specified position.
      Parameters:
      idx - The column index
      Returns:
      The column at this position

    • getColumns

      public Column[] getColumns()
      Returns the columns in this table.
      Returns:
      The columns

    • getColumnsAsList

      public List<Column> getColumnsAsList()
      Returns the columns in this table.
      Returns:
      The columns

    • addColumn

      public final void addColumn(Column column)
      Adds the given column.
      Parameters:
      column - The column

    • addColumn

      public void addColumn(int idx, Column column)
      Adds the given column at the specified position.
      Parameters:
      idx - The index where to add the column
      column - The column

    • addColumn

      public void addColumn(Column previousColumn, Column column)
      Adds the column after the given previous column.
      Parameters:
      previousColumn - The column to add the new column after; use null for adding at the begin
      column - The column

    • addColumns

      public void addColumns(Collection<Column> columns)
      Adds the given columns.
      Parameters:
      columns - The columns

    • setPrimaryKeys

      public void setPrimaryKeys(String[] primaryKeys)

    • addColumns

      public void addColumns(String[] columnNames)

    • removeColumn

      public void removeColumn(Column column)
      Removes the given column.
      Parameters:
      column - The column to remove

    • removeColumn

      public void removeColumn(int idx)
      Removes the indicated column.
      Parameters:
      idx - The index of the column to remove

    • getForeignKeyCount

      public int getForeignKeyCount()
      Returns the number of foreign keys.
      Returns:
      The number of foreign keys

    • getForeignKey

      public ForeignKey getForeignKey(int idx)
      Returns the foreign key at the given position.
      Parameters:
      idx - The foreign key index
      Returns:
      The foreign key

    • getForeignKeys

      public ForeignKey[] getForeignKeys()
      Returns the foreign keys of this table.
      Returns:
      The foreign keys

    • addForeignKey

      public void addForeignKey(ForeignKey foreignKey)
      Adds the given foreign key.
      Parameters:
      foreignKey - The foreign key

    • addForeignKey

      public void addForeignKey(int idx, ForeignKey foreignKey)
      Adds the given foreign key at the specified position.
      Parameters:
      idx - The index to add the foreign key at
      foreignKey - The foreign key

    • addForeignKeys

      public void addForeignKeys(Collection<ForeignKey> foreignKeys)
      Adds the given foreign keys.
      Parameters:
      foreignKeys - The foreign keys

    • removeForeignKey

      public void removeForeignKey(ForeignKey foreignKey)
      Removes the given foreign key.
      Parameters:
      foreignKey - The foreign key to remove

    • removeForeignKey

      public void removeForeignKey(int idx)
      Removes the indicated foreign key.
      Parameters:
      idx - The index of the foreign key to remove

    • getIndexCount

      public int getIndexCount()
      Returns the number of indices.
      Returns:
      The number of indices

    • getIndex

      public IIndex getIndex(int idx)
      Returns the index at the specified position.
      Parameters:
      idx - The position
      Returns:
      The index

    • addIndex

      public void addIndex(IIndex index)
      Adds the given index.
      Parameters:
      index - The index

    • addIndex

      public void addIndex(int idx, IIndex index)
      Adds the given index at the specified position.
      Parameters:
      idx - The position to add the index at
      index - The index

    • addIndices

      public void addIndices(Collection<IIndex> indices)
      Adds the given indices.
      Parameters:
      indices - The indices

    • getIndices

      public IIndex[] getIndices()
      Returns the indices of this table.
      Returns:
      The indices

    • getNonUniqueIndices

      public IIndex[] getNonUniqueIndices()
      Gets a list of non-unique indices on this table.
      Returns:
      The unique indices

    • getUniqueIndices

      public IIndex[] getUniqueIndices()
      Gets a list of unique indices on this table.
      Returns:
      The unique indices

    • removeIndex

      public void removeIndex(IIndex index)
      Removes the given index.
      Parameters:
      index - The index to remove

    • removeIndex

      public void removeIndex(int idx)
      Removes the indicated index.
      Parameters:
      idx - The position of the index to remove

    • hasPrimaryKey

      public boolean hasPrimaryKey()
      Determines whether there is at least one primary key column on this table.
      Returns:
      true if there are one or more primary key columns

    • hasNTypeColumns

      public boolean hasNTypeColumns()

    • hasGeneratedColumns

      public boolean hasGeneratedColumns()

    • findColumn

      public Column findColumn(String name)
      Finds the column with the specified name, using case insensitive matching. Note that this method is not called getColumn(String) to avoid introspection problems.
      Parameters:
      name - The name of the column
      Returns:
      The column or null if there is no such column

    • findColumn

      public Column findColumn(String name, boolean caseSensitive)
      Finds the column with the specified name, using case insensitive matching. Note that this method is not called getColumn(String) to avoid introspection problems.
      Parameters:
      name - The name of the column
      caseSensitive - Whether case matters for the names
      Returns:
      The column or null if there is no such column

    • getColumnIndex

      public int getColumnIndex(Column column)
      Determines the index of the given column.
      Parameters:
      column - The column
      Returns:
      The index or -1 if it is no column of this table

    • getColumnIndex

      public int getColumnIndex(String columnName)

    • getPrimaryKeyColumnIndex

      public int getPrimaryKeyColumnIndex(String columnName)

    • findIndex

      public IIndex findIndex(String name)
      Finds the index with the specified name, using case insensitive matching. Note that this method is not called getIndex to avoid introspection problems.
      Parameters:
      name - The name of the index
      Returns:
      The index or null if there is no such index

    • findIndex

      public IIndex findIndex(String name, boolean caseSensitive)
      Finds the index with the specified name, using case insensitive matching. Note that this method is not called getIndex to avoid introspection problems.
      Parameters:
      name - The name of the index
      caseSensitive - Whether case matters for the names
      Returns:
      The index or null if there is no such index

    • findForeignKey

      public ForeignKey findForeignKey(ForeignKey key)
      Finds the foreign key in this table that is equal to the supplied foreign key.
      Parameters:
      key - The foreign key to search for
      Returns:
      The found foreign key

    • findForeignKey

      public ForeignKey findForeignKey(ForeignKey key, boolean caseSensitive)
      Finds the foreign key in this table that is equal to the supplied foreign key.
      Parameters:
      key - The foreign key to search for
      caseSensitive - Whether case matters for the names
      Returns:
      The found foreign key

    • getSelfReferencingForeignKey

      public ForeignKey getSelfReferencingForeignKey()
      Returns the foreign key referencing this table if it exists.
      Returns:
      The self-referencing foreign key if any

    • getPrimaryKeyColumnsAsList

      public List<Column> getPrimaryKeyColumnsAsList()
      Returns the primary key columns of this table.
      Returns:
      The primary key columns

    • getPrimaryKeyColumns

      public Column[] getPrimaryKeyColumns()
      Returns the primary key columns of this table.
      Returns:
      The primary key columns

    • getPrimaryKeyColumnsInIndexOrder

      public Column[] getPrimaryKeyColumnsInIndexOrder()

    • getNonPrimaryKeyColumns

      public Column[] getNonPrimaryKeyColumns()
      Returns the columns in this table that are not a PK.

    • getAutoIncrementColumns

      public Column[] getAutoIncrementColumns()
      Returns the auto increment columns in this table. If no incrementcolumns are found, it will return an empty array.
      Returns:
      The columns

    • sortForeignKeys

      public void sortForeignKeys(boolean caseSensitive)
      Sorts the foreign keys alphabetically.
      Parameters:
      caseSensitive - Whether case matters

    • clone

      public Object clone() throws CloneNotSupportedException
      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsByName

      public boolean equalsByName(Table other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toVerboseString

      public String toVerboseString()
      Returns a verbose string representation of this table.
      Returns:
      The string representation

    • getTableKey

      public String getTableKey()

    • containsLobColumns

      public boolean containsLobColumns(IDatabasePlatform platform)

    • getLobColumns

      public List<Column> getLobColumns(IDatabasePlatform platform)

    • getFullyQualifiedTableName

      public String getFullyQualifiedTableName()

    • getFullyQualifiedTableNameLowerCase

      public String getFullyQualifiedTableNameLowerCase()

    • getFullyQualifiedTableName

      public String getFullyQualifiedTableName(String quote)

    • getNameLowerCase

      public String getNameLowerCase()

    • getFullyQualifiedTableName

      public static String getFullyQualifiedTableName(String catalogName, String schemaName, String tableName)

    • getQualifiedColumnName

      public String getQualifiedColumnName(Column column)

    • getFullyQualifiedTablePrefix

      public static String getFullyQualifiedTablePrefix(String catalogName, String schemaName)

    • getQualifiedTableName

      public String getQualifiedTableName(String quoteString, String catalogSeparator, String schemaSeparator)

    • getQualifiedTableName

      public String getQualifiedTableName()

    • getFullyQualifiedTableName

      public static String getFullyQualifiedTableName(String catalogName, String schemaName, String tableName, String quoteString, String catalogSeparator, String schemaSeparator)

    • getFullyQualifiedTablePrefix

      public static String getFullyQualifiedTablePrefix(String catalogName, String schemaName, String quoteString, String catalogSeparator, String schemaSeparator)

    • getFullyQualifiedTablePrefix

      public static String getFullyQualifiedTablePrefix(StringBuilder sb, String catalogName, String schemaName, String quoteString, String catalogSeparator, String schemaSeparator)

    • getQualifiedTablePrefix

      public String getQualifiedTablePrefix(String quoteString, String catalogSeparator, String schemaSeparator)

    • getColumnWithName

      public final Column getColumnWithName(String name)

    • getColumnsWithName

      public Column[] getColumnsWithName(String[] columnNames)

    • doesIndexContainOnlyPrimaryKeyColumns

      public boolean doesIndexContainOnlyPrimaryKeyColumns(IIndex index)

    • hasAutoIncrementColumn

      public boolean hasAutoIncrementColumn()

    • getDistributionKeyColumns

      public Column[] getDistributionKeyColumns()

    • orderColumns

      public void orderColumns(String[] columnNames)

    • orderColumns

      public void orderColumns(String[] columnNames, boolean addMissingColumns)

    • orderColumns

      public static Column[] orderColumns(String[] columnNames, Table table, boolean addMissingColumns)

    • getOldCatalog

      public String getOldCatalog()

    • setOldCatalog

      public void setOldCatalog(String oldCatalog)

    • getOldSchema

      public String getOldSchema()

    • setOldSchema

      public void setOldSchema(String oldSchema)

    • isAccessControlled

      public boolean isAccessControlled()
      Returns:
      the isAccessControlled

    • setAccessControlled

      public void setAccessControlled(boolean isAccessControlled)
      Parameters:
      isAccessControlled - the isAccessControlled to set

    • copy

      public Table copy()

    • copyAndFilterColumns

      public Table copyAndFilterColumns(String[] orderedColumnNames, String[] pkColumnNames, boolean setPrimaryKeys, boolean addMissingColumns)
      Creates a copy of this table and orders the columns according to the supplied array of column names.
      Parameters:
      orderedColumnNames - An array of column names whose order determines the order of the returned table's columns
      pkColumnNames - An array of the names of the columns that make up the table's primary key
      setPrimaryKeys - Whether to change the returned table's primary key columns based on the supplied array of primary key column names
      addMissingColumns - Whether to add columns to the returned table if they are present in the supplied array of column names but not in the existing table's list of columns
      Returns:
      A copy of this table

    • getColumnNames

      public String[] getColumnNames()

    • getPrimaryKeyColumnNames

      public String[] getPrimaryKeyColumnNames()

    • calculateTableHashcode

      public int calculateTableHashcode()

    • calculateTableLiteHashcode

      public int calculateTableLiteHashcode()

    • calculateTableHashcode

      protected int calculateTableHashcode(boolean includeTypes)

    • areAllColumnsPrimaryKeys

      public static boolean areAllColumnsPrimaryKeys(Column[] columns)

    • buildTable

      public static Table buildTable(String tableName, String[] keyNames, String[] columnNames)

    • getCommaDeliminatedColumns

      public static String getCommaDeliminatedColumns(Column[] cols)

    • getArrayColumns

      public static String[] getArrayColumns(Column[] cols)

    • setPrimaryKeyConstraintName

      public void setPrimaryKeyConstraintName(String primaryKeyConstraintName)

    • getPrimaryKeyConstraintName

      public String getPrimaryKeyConstraintName()

    • containsJdbcTypes

      public boolean containsJdbcTypes()

    • copyColumnTypesFrom

      public void copyColumnTypesFrom(Table table)

    • compareTo

      public int compareTo(Table o)
      Specified by:
      compareTo in interface Comparable<Table>

    • escapeColumnNameForCsv

      public static String escapeColumnNameForCsv(String columnName)

    • getCompressionType

      public CompressionTypes getCompressionType()

    • setCompressionType

      public void setCompressionType(CompressionTypes compressionType)

    • isMadeAllColumnsPrimaryKey

      public boolean isMadeAllColumnsPrimaryKey()

    • setMadeAllColumnsPrimaryKey

      public void setMadeAllColumnsPrimaryKey(boolean madeAllColumnsPrimaryKey)

    • getTriggerCount

      public int getTriggerCount()

    • getTrigger

      public Trigger getTrigger(int i)

    • getTriggers

      public Trigger[] getTriggers()

    • getTriggersAsList

      public List<Trigger> getTriggersAsList()

    • addTrigger

      public final void addTrigger(Trigger trigger)

    • addTrigger

      public void addTrigger(int idx, Trigger trigger)

    • addTrigger

      public void addTrigger(Trigger previousTrigger, Trigger trigger)

    • addTriggers

      public void addTriggers(Collection<Trigger> triggers)

    • findTrigger

      public Trigger findTrigger(String name, boolean caseSensitive)

    • removeTrigger

      public void removeTrigger(Trigger trigger)

    • getLogging

      public boolean getLogging()
      Reports table's mode for write-ahead (transaction) log.
      Returns:
      true, if table is being logged

    • setLogging

      public void setLogging(boolean value)