com.feedzai.commons.sql.abstraction.ddl

Class DbEntity

java.lang.Object

com.feedzai.commons.sql.abstraction.ddl.DbEntity

All Implemented Interfaces:

Serializable

public class DbEntity
extends Object
implements Serializable

Builds a new database entity abstraction.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DbEntity() Creates a new instance of DbEntity.

Method Summary

Methods

Modifier and Type	Method and Description
DbEntity	addColumn(Collection<DbColumn> dbColumn) Adds the columns to the entity.
DbEntity	addColumn(DbColumn dbColumn) Adds a column to the entity.
DbEntity	addColumn(String name, DbColumnType type, boolean autoInc, DbColumnConstraint... constraints) Adds a column to the entity.
DbEntity	addColumn(String name, DbColumnType type, DbColumnConstraint... constraints) Adds a column to the entity.
DbEntity	addColumn(String name, DbColumnType type, Integer size, boolean autoInc, DbColumnConstraint... constraints) Adds a column to the entity.
DbEntity	addColumn(String name, DbColumnType type, Integer size, DbColumnConstraint... constraints) Adds a column to the entity.
DbEntity	addColumn(String name, DbColumnType type, K defaultValue, DbColumnConstraint... constraints) Adds a column to the entity.
DbEntity	addFk(DbFk... fks) Adds the FKs.
DbEntity	addFks(Collection<DbFk> fks) Adds the FKs.
DbEntity	addIndex(boolean unique, String... columns) Adds an index.
DbEntity	addIndex(Collection<String> columns) Adds an index.
DbEntity	addIndex(DbIndex index) Adds an index.
DbEntity	addIndex(String... columns) Adds an index.
boolean	containsColumn(String columnName) Checks if the entity has a column defined with the specified name.
List<DbColumn>	getColumns()
List<DbFk>	getFks()
List<DbIndex>	getIndexes()
String	getName()
String[]	getPkFields()
void	removeColumn(String name) Removes the column form the list of columns.
DbEntity	setName(String name) Sets the entity name.
DbEntity	setPkFields(String... pkFields) Sets the PK fields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DbEntity

public DbEntity()

Creates a new instance of DbEntity.

Method Detail

setName

public DbEntity setName(String name)

Sets the entity name.

Parameters:

name - The name.

Returns:

This object.

addColumn

public DbEntity addColumn(DbColumn dbColumn)

Adds a column to the entity.

Parameters:

dbColumn - The column.

Returns:

This object.

addColumn

public DbEntity addColumn(Collection<DbColumn> dbColumn)

Adds the columns to the entity.

Parameters:

dbColumn - The columns.

Returns:

This object.

addColumn

public DbEntity addColumn(String name,
                 DbColumnType type,
                 DbColumnConstraint... constraints)

Adds a column to the entity.

Parameters:

name - The entity name.

type - The entity type.

constraints - The list of constraints.

Returns:

This object.

addColumn

public DbEntity addColumn(String name,
                 DbColumnType type,
                 Integer size,
                 DbColumnConstraint... constraints)

Adds a column to the entity.

Parameters:

name - The entity name.

type - The entity type.

size - The type size.

constraints - The list of constraints.

Returns:

This object.

addColumn

public DbEntity addColumn(String name,
                 DbColumnType type,
                 boolean autoInc,
                 DbColumnConstraint... constraints)

Adds a column to the entity.

Parameters:

name - The entity name.

type - The entity type.

autoInc - True if the column is to autoincrement, false otherwise.

constraints - The list of constraints.

Returns:

This object.

addColumn

public DbEntity addColumn(String name,
                 DbColumnType type,
                 K defaultValue,
                 DbColumnConstraint... constraints)

Adds a column to the entity.

Parameters:

name - The entity name.

type - The entity type.

defaultValue - The defaultValue for the column.

constraints - The list of constraints.

Returns:

This object.

addColumn

public DbEntity addColumn(String name,
                 DbColumnType type,
                 Integer size,
                 boolean autoInc,
                 DbColumnConstraint... constraints)

Adds a column to the entity.

Parameters:

name - The entity name.

type - The entity type.

size - The type size.

autoInc - True if the column is to autoincrement, false otherwise.

constraints - The list of constraints.

Returns:

This object.

removeColumn

public void removeColumn(String name)

Removes the column form the list of columns.

Parameters:

name - The column name.

Since:

12.1.0

setPkFields

public DbEntity setPkFields(String... pkFields)

Sets the PK fields.

Parameters:

pkFields - The PK fields.

Returns:

This object.

addIndex

public DbEntity addIndex(DbIndex index)

Adds an index.

Parameters:

index - The index.

Returns:

This object.

addIndex

public DbEntity addIndex(boolean unique,
                String... columns)

Adds an index.

Parameters:

unique - True if the index is unique, false otherwise.

columns - The columns that are part of the index.

Returns:

This object.

addIndex

public DbEntity addIndex(String... columns)

Adds an index.

Parameters:

columns - The columns that are part of the index.

Returns:

This object.

addIndex

public DbEntity addIndex(Collection<String> columns)

Adds an index.

Parameters:

columns - The columns that are part of the index.

Returns:

This object.

addFk

public DbEntity addFk(DbFk... fks)

Adds the FKs.

Parameters:

fks - The list of FKs.

Returns:

This object.

addFks

public DbEntity addFks(Collection<DbFk> fks)

Adds the FKs.

Parameters:

fks - The list of FKs.

Returns:

This object.

getColumns

public List<DbColumn> getColumns()

Returns:

The entity columns.

containsColumn

public boolean containsColumn(String columnName)

Checks if the entity has a column defined with the specified name.

Parameters:

columnName - The column name.

Returns:

True if contains the column.

Since:

12.1.0

getName

public String getName()

Returns:

The entity name.

getPkFields

public String[] getPkFields()

Returns:

The PK fields.

getIndexes

public List<DbIndex> getIndexes()

Returns:

The indexes to this entity.

getFks

public List<DbFk> getFks()

Returns:

The FKs to this entity.