AbstractTable (Batoo Persistence Core 2.0.1.2 API)

java.lang.Object
- org.batoo.jpa.jdbc.AbstractTable

Direct Known Subclasses:

CollectionTable, EntityTable, JoinTable
```
public abstract class AbstractTable
extends Object
```
Abstract implementation for Entity, Secondary and Join tables.

Since:

2.0.0

Author:

hceylan

Constructor Summary

Constructors
Constructor and Description

AbstractTable(String defaultName, TableMetadata metadata)

AbstractTable(TableMetadata metadata)

Constructors
Constructor and Description
`AbstractTable(String defaultName, TableMetadata metadata)`
`AbstractTable(TableMetadata metadata)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addColumn(AbstractColumn column)` Adds the column to the table
`void`	`addForeignKey(ForeignKey foreignKey)` Adds a foreign key to the table.
`String`	`getCatalog()` Returns the catalog.
`protected Map<String,AbstractColumn>`	`getColumnMap()` Returns the columnMap of the AbstractTable.
`Collection<String>`	`getColumnNames()` Returns the set of column names.
`AbstractColumn[]`	`getColumns()` Returns the array of columns the table has
`List<ForeignKey>`	`getForeignKeys()` Returns the foreign keys of the table.
`protected AbstractColumn[]`	`getInsertColumns(EntityTypeDescriptor entity, int size)` Returns the columns for the insert.
`protected String`	`getInsertSql(EntityTypeDescriptor entity, int size)` Returns the insert statement for the table specifically.
`AbstractLocator`	`getLocator()` Returns the locator.
`String`	`getName()` Returns the name.
`Set<String>`	`getPkColumnNames()` Returns the set of primary key column names.
`String`	`getQName()` Returns the qualified name of the table.
`AbstractColumn[]`	`getRestrictionColumns()` Returns the restriction columns of the table.
`protected String`	`getRestrictionSql(Map<String,AbstractColumn> pkColumns)` Returns the restriction SQL fragment.
`String`	`getSchema()` Returns the schema.
`AbstractColumn[]`	`getSelectVersionColumns()` Returns the select version columns.
`protected String`	`getSelectVersionSql(Map<String,AbstractColumn> pkColumns)` Returns the version select statement for the table specifically.
`Map<String,String[]>`	`getUniqueConstraints()` Returns the unique constraints.
`protected AbstractColumn[]`	`getUpdateColumns(EntityTypeDescriptor entity)` Returns the columns for the update.
`protected String`	`getUpdateSql(EntityTypeDescriptor entity, Map<String,AbstractColumn> pkColumns)` Returns the update statement for the table specifically.
`protected String`	`getVersionUpdateSql(Map<String,AbstractColumn> pkColumns)` Returns the version update statement for the table specifically.
`protected void`	`setName(String name)` Updates the name of the table.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractTable
```
public AbstractTable(String defaultName,
             TableMetadata metadata)
```
    Parameters:
    defaultName - the default name for the table
    metadata - the metadata
    Since:
    
    2.0.0
  - AbstractTable
```
public AbstractTable(TableMetadata metadata)
```
    Parameters:
    metadata - the metadata
    Since:
    
    2.0.0
- Method Detail
  - addColumn
```
public void addColumn(AbstractColumn column)
```
    Adds the column to the table
    
    Parameters:
    column - the column to add
    Since:
    
    2.0.0
  - addForeignKey
```
public void addForeignKey(ForeignKey foreignKey)
```
    Adds a foreign key to the table.
    
    Parameters:
    foreignKey - the foreign key to add
    Since:
    
    2.0.0
  - getCatalog
```
public String getCatalog()
```
    Returns the catalog.
    
    Returns:
    the catalog
    Since:
    
    2.0.0
  - getColumnMap
```
protected Map<String,AbstractColumn> getColumnMap()
```
    Returns the columnMap of the AbstractTable.
    
    Returns:
    the columnMap of the AbstractTable
    Since:
    
    2.0.0
  - getColumnNames
```
public Collection<String> getColumnNames()
```
    Returns the set of column names.
    
    Returns:
    the set of column names
    Since:
    
    2.0.0
  - getColumns
```
public AbstractColumn[] getColumns()
```
    Returns the array of columns the table has
    
    Returns:
    the array of columns the table has
    Since:
    
    2.0.0
  - getForeignKeys
```
public List<ForeignKey> getForeignKeys()
```
    Returns the foreign keys of the table.
    
    Returns:
    the foreign keys of the table
    Since:
    
    2.0.0
  - getInsertColumns
```
protected AbstractColumn[] getInsertColumns(EntityTypeDescriptor entity,
                                int size)
```
    Returns the columns for the insert.
    
    Parameters:
    entity - the entity to returns columns for or null for generic columns
    size - the batch size
    
    Returns:
    the insert columns
    Since:
    
    2.0.0
  - getInsertSql
```
protected String getInsertSql(EntityTypeDescriptor entity,
                  int size)
```
    Returns the insert statement for the table specifically.
    
    Parameters:
    entity - the entity to return insert statement for or null for generic SQL
    size - the batch size
    
    Returns:
    the insert statement
    Since:
    
    2.0.0
  - getLocator
```
public AbstractLocator getLocator()
```
    Returns the locator.
    
    Returns:
    the locator
    Since:
    
    2.0.0
  - getName
```
public String getName()
```
    Returns the name.
    
    Returns:
    the name
    Since:
    
    2.0.0
  - getPkColumnNames
```
public Set<String> getPkColumnNames()
```
    Returns the set of primary key column names.
    
    Returns:
    the set of primary column names
    Since:
    
    2.0.0
  - getQName
```
public String getQName()
```
    Returns the qualified name of the table.
    
    Returns:
    the qualified name of the table
    Since:
    
    2.0.0
  - getRestrictionColumns
```
public AbstractColumn[] getRestrictionColumns()
```
    Returns the restriction columns of the table.
    
    Returns:
    the restriction columns of the table
    Since:
    
    2.0.1
  - getRestrictionSql
```
protected String getRestrictionSql(Map<String,AbstractColumn> pkColumns)
```
    Returns the restriction SQL fragment.
    
    Parameters:
    pkColumns - the primary key column
    
    Returns:
    the restriction SQL fragment
    Since:
    
    2.0.1
  - getSchema
```
public String getSchema()
```
    Returns the schema.
    
    Returns:
    the schema
    Since:
    
    2.0.0
  - getSelectVersionColumns
```
public AbstractColumn[] getSelectVersionColumns()
```
    Returns the select version columns.
    
    Returns:
    the select version columns
    Since:
    
    2.0.0
  - getSelectVersionSql
```
protected String getSelectVersionSql(Map<String,AbstractColumn> pkColumns)
```
    Returns the version select statement for the table specifically.
    
    Parameters:
    pkColumns - the primary key columns
    
    Returns:
    the select statement
    Since:
    
    2.0.0
  - getUniqueConstraints
```
public Map<String,String[]> getUniqueConstraints()
```
    Returns the unique constraints.
    
    Returns:
    the unique constraints
    Since:
    
    2.0.0
  - getUpdateColumns
```
protected AbstractColumn[] getUpdateColumns(EntityTypeDescriptor entity)
```
    Returns the columns for the update.
    
    Parameters:
    entity - the entity to returns columns for or null for generic columns
    
    Returns:
    the insert columns
    Since:
    
    2.0.0
  - getUpdateSql
```
protected String getUpdateSql(EntityTypeDescriptor entity,
                  Map<String,AbstractColumn> pkColumns)
```
    Returns the update statement for the table specifically.
    
    Parameters:
    entity - the entity to return update statement for or null for generic SQL
    pkColumns - the primary key columns
    
    Returns:
    the insert statement
    Since:
    
    2.0.0
  - getVersionUpdateSql
```
protected String getVersionUpdateSql(Map<String,AbstractColumn> pkColumns)
```
    Returns the version update statement for the table specifically.
    
    Parameters:
    pkColumns - the primary key columns
    
    Returns:
    the update statement
    Since:
    
    2.0.0
  - setName
```
protected void setName(String name)
```
    Updates the name of the table.
    
    Parameters:
    name - the name of the table
    Since:
    
    2.0.0

Class AbstractTable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractTable

AbstractTable

Method Detail

addColumn

addForeignKey

getCatalog

getColumnMap

getColumnNames

getColumns

getForeignKeys

getInsertColumns

getInsertSql

getLocator

getName

getPkColumnNames

getQName

getRestrictionColumns

getRestrictionSql

getSchema

getSelectVersionColumns

getSelectVersionSql

getUniqueConstraints

getUpdateColumns

getUpdateSql

getVersionUpdateSql

setName