sirius.db.jdbc.schema

Class TableColumn

java.lang.Object

sirius.db.jdbc.schema.TableColumn

public class TableColumn
extends Object

Represents a column of a database table.

Constructor Summary

Constructors

Constructor and Description
TableColumn() Creates a new table column.
TableColumn(Property property, int sqlType) Creates a new table column which is pre-initialized with the given property and type.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDefaultValue() Returns the default value as string.
int	getLength() Returns the overall max. length of the column.
String	getName() Returns the name of the column.
String	getOldName() Returns the old name of the column.
int	getPrecision() Returns the precision of the column.
int	getScale() Returns the number decimal places after the comma.
Property	getSource() Returns the underlying property if available
int	getType() Returns the JDBC type of the column.
int	hashCode()
boolean	isAutoIncrement() Determines whether auto inctement is enabled for this column.
boolean	isNullable() Determines the nullability of the column.
void	setAutoIncrement(boolean autoIncrement) Sets the auto increment flag of this column
void	setDefaultValue(String defaultValue) Specifies the default value.
void	setLength(int length) Specifies the max. length of the column.
void	setName(String name) Sets the name of the column.
void	setNullable(boolean nullable) Specifies the nullability of the column.
void	setOldName(String oldName) Set the old name of a column.
void	setPrecision(int precision) Specifies a precision of the column.
void	setScale(int scale) Specifies the number of decimal places.
void	setType(int type) Sets the JDBC type of the column.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TableColumn

public TableColumn()

Creates a new table column.

TableColumn

public TableColumn(Property property,
                   int sqlType)

Creates a new table column which is pre-initialized with the given property and type.

Parameters:

property - the property used to determine common parameters (nullability, length, default value ..)

sqlType - the type of the column based on Types

Method Detail

getSource

@Nullable
public Property getSource()

Returns the underlying property if available

Returns:

the underlying property

isAutoIncrement

public boolean isAutoIncrement()

Determines whether auto inctement is enabled for this column.

Returns:

true if this is an auto increment column, false otherwise.

setAutoIncrement

public void setAutoIncrement(boolean autoIncrement)

Sets the auto increment flag of this column

Parameters:

autoIncrement - true if this is an auto increment column, false otherwise.

getOldName

public String getOldName()

Returns the old name of the column.

Returns:

the old name of the column or null if the column was not renamed

setOldName

public void setOldName(String oldName)

Set the old name of a column. This can be used to rename insted of DROP/ADD columns.

Parameters:

oldName - the previous name of the column

getName

public String getName()

Returns the name of the column.

Returns:

the name of the column

setName

public void setName(String name)

Sets the name of the column.

Parameters:

name - the name of the column

getType

public int getType()

Returns the JDBC type of the column.

Returns:

the JDBC type of the column

See Also:

Types

setType

public void setType(int type)

Sets the JDBC type of the column.

Parameters:

type - the type to set

See Also:

Types

isNullable

public boolean isNullable()

Determines the nullability of the column.

Returns:

true if the column may be null, false otherwise

setNullable

public void setNullable(boolean nullable)

Specifies the nullability of the column.

Parameters:

nullable - true if the column may be null, false otherwise

getLength

public int getLength()

Returns the overall max. length of the column.

Returns:

the max length of the column

setLength

public void setLength(int length)

Specifies the max. length of the column.

Parameters:

length - the max length of this column

getPrecision

public int getPrecision()

Returns the precision of the column.

Returns:

the total number of digits that can be stored without a rounding errors.

setPrecision

public void setPrecision(int precision)

Specifies a precision of the column.

Parameters:

precision - the total number of digits which can be stored withozt rounding errors.

getScale

public int getScale()

Returns the number decimal places after the comma.

Returns:

the number of decimal places

setScale

public void setScale(int scale)

Specifies the number of decimal places.

Parameters:

scale - the number of decimal places after the comma

getDefaultValue

public String getDefaultValue()

Returns the default value as string.

Returns:

the default value of this column

setDefaultValue

public void setDefaultValue(String defaultValue)

Specifies the default value.

Parameters:

defaultValue - the default value as string

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object