Top Description Methods
org.hibernate.boot.model.source.spi

public Interface ColumnSource

extends RelationalValueSource
Known Direct Implementers
org.hibernate.boot.model.source.internal.hbm.ColumnAttributeSourceImpl, org.hibernate.boot.model.source.internal.hbm.ColumnSourceImpl
Imports
java.util.Set, org.hibernate.boot.model.TruthValue
Contract for source information pertaining to a physical column definition specific to a particular attribute context.

Conceptual note: this really describes a column from the perspective of its binding to an attribute, not necessarily the column itself.

Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

Check constraint condition
getCheckCondition()

Obtain the specified check constraint condition

public String

Returns:

SQL comment
getComment()

Obtain the specified SQL comment

public JdbcDataType

Returns:

The column's SQL data type.
getDatatype()

The deduced (and dialect convertible) type for this column

public String

Returns:

THe column default
getDefaultValue()

Obtain a specified default value for the column

public Set<String>
getIndexConstraintNames()

public String

Returns:

The name of the column. Can be null, in which case a naming strategy is applied.
getName()

Obtain the name of the column.

public String

Returns:

The SQL read fragment
getReadFragment()

A SQL fragment to apply to the column value on read.

public SizeSource

Returns:

The source for the column size.
getSizeSource()

Obtain the source for the specified column size.

public String

Returns:

The free-hand column type
getSqlType()

Obtain the free-hand definition of the column's type.

public Set<String>
getUniqueKeyConstraintNames()

public String

Returns:

The SQL write fragment
getWriteFragment()

A SQL fragment to apply to the column value on write.

public TruthValue

Returns:

true indicates it is nullable; false non-nullable.
isNullable()

Is this column nullable?

public boolean

Returns:

true indicates it is unique; false non-unique.
isUnique()

Is this column unique?

Inherited from org.hibernate.boot.model.source.spi.RelationalValueSource:
getContainingTableNamegetNature

Method Detail

getCheckConditionback to summary
public String getCheckCondition()

Obtain the specified check constraint condition

Returns:String

Check constraint condition

getCommentback to summary
public String getComment()

Obtain the specified SQL comment

Returns:String

SQL comment

getDatatypeback to summary
public JdbcDataType getDatatype()

The deduced (and dialect convertible) type for this column

Returns:JdbcDataType

The column's SQL data type.

getDefaultValueback to summary
public String getDefaultValue()

Obtain a specified default value for the column

Returns:String

THe column default

getIndexConstraintNamesback to summary
public Set<String> getIndexConstraintNames()
getNameback to summary
public String getName()

Obtain the name of the column.

Returns:String

The name of the column. Can be null, in which case a naming strategy is applied.

getReadFragmentback to summary
public String getReadFragment()

A SQL fragment to apply to the column value on read.

Returns:String

The SQL read fragment

getSizeSourceback to summary
public SizeSource getSizeSource()

Obtain the source for the specified column size.

Returns:SizeSource

The source for the column size.

getSqlTypeback to summary
public String getSqlType()

Obtain the free-hand definition of the column's type.

Returns:String

The free-hand column type

getUniqueKeyConstraintNamesback to summary
public Set<String> getUniqueKeyConstraintNames()
getWriteFragmentback to summary
public String getWriteFragment()

A SQL fragment to apply to the column value on write.

Returns:String

The SQL write fragment

isNullableback to summary
public TruthValue isNullable()

Is this column nullable?

Returns:TruthValue

true indicates it is nullable; false non-nullable.

isUniqueback to summary
public boolean isUnique()

Is this column unique?

Returns:boolean

true indicates it is unique; false non-unique.