com.healthmarketscience.sqlbuilder.dbspec.basic

Class DbColumn

java.lang.Object

com.healthmarketscience.sqlbuilder.dbspec.basic.DbObject<DbTable>

com.healthmarketscience.sqlbuilder.dbspec.basic.DbColumn

All Implemented Interfaces:

Column

public class DbColumn
extends DbObject<DbTable>
implements Column

Representation of a column in a database schema.

Author:

James Ahlborn

Constructor Summary

Constructors

Constructor and Description
DbColumn(DbTable parent, String name, String typeName, Integer typeLength)
DbColumn(DbTable parent, String name, String typeName, Object... typeQualifiers)

Method Summary

Modifier and Type	Method and Description
<T extends DbConstraint> T	addConstraint(T constraint) Adds the given constraint to this column.
DbCheckConstraint	checkCondition(String name, Condition condition) Creates and adds check constraint with the given parameters to this table.
String	getColumnNameSQL()
List<DbConstraint>	getConstraints()
Object	getDefaultValue()
DbTable	getTable()
Integer	getTypeLength()
static String	getTypeName(int type) Returns the standard jdbc type name for the give type value (one of Types).
String	getTypeNameSQL()
List<Object>	getTypeQualifiers()
DbConstraint	notNull() Creates and adds not null constraint with the given parameters to this column.
DbConstraint	notNull(String name) Creates and adds not null constraint with the given parameters to this column.
DbConstraint	primaryKey() Creates and adds primary key constraint with the given parameters to this column.
DbConstraint	primaryKey(String name) Creates and adds primary key constraint with the given parameters to this column.
DbForeignKeyConstraint	references(String referencedTableName) Creates and adds foreign key constraint with the given parameters to this column.
DbForeignKeyConstraint	references(String name, DbTable referencedTable, DbColumn referencedColumn) Creates and adds foreign key constraint with the given parameters to this column.
DbForeignKeyConstraint	references(String name, String referencedTableName) Creates and adds foreign key constraint with the given parameters to this column.
DbForeignKeyConstraint	references(String name, String referencedTableName, String referencedColName) Creates and adds foreign key constraint with the given parameters to this column.
DbForeignKeyConstraint	references(String name, String referencedSchemaName, String referencedTableName, String referencedColName) Creates and adds foreign key constraint with the given parameters to this column.
DbColumn	setDefaultValue(Object defaultValue) Sets the default value for this column.
DbConstraint	unique() Creates and adds unique constraint with the given parameters to this column.
DbConstraint	unique(String name) Creates and adds unique constraint with the given parameters to this column.

Methods inherited from class com.healthmarketscience.sqlbuilder.dbspec.basic.DbObject

addObjects, checkOwnership, checkOwnership, findObject, getAbsoluteName, getName, getParent, getSpec, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DbColumn

public DbColumn(DbTable parent,
                String name,
                String typeName,
                Integer typeLength)

DbColumn

public DbColumn(DbTable parent,
                String name,
                String typeName,
                Object... typeQualifiers)

Method Detail

getTable

public DbTable getTable()

Specified by:

getTable in interface Column

Returns:

the parent database table of this column

getColumnNameSQL

public String getColumnNameSQL()

Specified by:

getColumnNameSQL in interface Column

Returns:

the simple name of this column

getTypeNameSQL

public String getTypeNameSQL()

Specified by:

getTypeNameSQL in interface Column

Returns:

the type of this column

getTypeLength

public Integer getTypeLength()

Specified by:

getTypeLength in interface Column

Returns:

the length of the type of this column, may be null

getTypeQualifiers

public List<Object> getTypeQualifiers()

Specified by:

getTypeQualifiers in interface Column

Returns:

the various type qualifiers for this column (e.g. length or scale/precision) in declaration order. May be null or empty if none.

getConstraints

public List<DbConstraint> getConstraints()

Specified by:

getConstraints in interface Column

Returns:

any constraints for this column

setDefaultValue

public DbColumn setDefaultValue(Object defaultValue)

Sets the default value for this column. A value of null will be treated as no default value.

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface Column

Returns:

the default value for this column, if any

notNull

public DbConstraint notNull()

Creates and adds not null constraint with the given parameters to this column.

Note, no effort is made to make sure the given name is unique.

Returns:

the freshly created constraint

notNull

public DbConstraint notNull(String name)

Creates and adds not null constraint with the given parameters to this column.

Note, no effort is made to make sure the given name is unique.

Parameters:

name - the name of the new constraint

Returns:

the freshly created constraint

unique

public DbConstraint unique()

Creates and adds unique constraint with the given parameters to this column.

Note, no effort is made to make sure the given name is unique.

Returns:

the freshly created constraint

unique

public DbConstraint unique(String name)

Creates and adds unique constraint with the given parameters to this column.

Note, no effort is made to make sure the given name is unique.

Parameters:

name - the name of the new constraint

Returns:

the freshly created constraint

primaryKey

public DbConstraint primaryKey()

Creates and adds primary key constraint with the given parameters to this column.

Note, no effort is made to make sure the given name is unique.

Returns:

the freshly created constraint

primaryKey

public DbConstraint primaryKey(String name)

Creates and adds primary key constraint with the given parameters to this column.

Note, no effort is made to make sure the given name is unique.

Parameters:

name - the name of the new constraint

Returns:

the freshly created constraint

references

public DbForeignKeyConstraint references(String referencedTableName)

Creates and adds foreign key constraint with the given parameters to this column.

Note, no effort is made to make sure the given name is unique.

Parameters:

referencedTableName - the name of the referenced table

Returns:

the freshly created constraint

references

public DbForeignKeyConstraint references(String name,
                                         String referencedTableName)

Creates and adds foreign key constraint with the given parameters to this column.

Note, no effort is made to make sure the given name is unique.

Parameters:

name - the name of the new constraint

referencedTableName - the name of the referenced table

Returns:

the freshly created constraint

references

public DbForeignKeyConstraint references(String name,
                                         String referencedTableName,
                                         String referencedColName)

Creates and adds foreign key constraint with the given parameters to this column.

Note, no effort is made to make sure the given name is unique.

Parameters:

name - the name of the new constraint

referencedTableName - the name of the referenced table

referencedColName - the names of the referenced column

Returns:

the freshly created constraint

references

public DbForeignKeyConstraint references(String name,
                                         String referencedSchemaName,
                                         String referencedTableName,
                                         String referencedColName)

Creates and adds foreign key constraint with the given parameters to this column.

Note, no effort is made to make sure the given name is unique.

Parameters:

name - the name of the new constraint

referencedSchemaName - the name of the referenced schema

referencedTableName - the name of the referenced table

referencedColName - the names of the referenced column

Returns:

the freshly created constraint

references

public DbForeignKeyConstraint references(String name,
                                         DbTable referencedTable,
                                         DbColumn referencedColumn)

Creates and adds foreign key constraint with the given parameters to this column.

Note, no effort is made to make sure the given name is unique.

Parameters:

name - the name of the new constraint

referencedTable - the referenced table

referencedColumn - the referenced column

Returns:

the freshly created constraint

checkCondition

public DbCheckConstraint checkCondition(String name,
                                        Condition condition)

Creates and adds check constraint with the given parameters to this table.

Note, no effort is made to make sure the given name is unique.

Parameters:

condition - the check condition

addConstraint

public <T extends DbConstraint> T addConstraint(T constraint)

Adds the given constraint to this column.

Note, no effort is made to make sure the given constraint is unique.

Parameters:

constraint - the constraint to be added

Returns:

the given constraint

getTypeName

public static String getTypeName(int type)

Returns the standard jdbc type name for the give type value (one of Types).