Top Fields Constructors Methods
org.hibernate.boot.model.source.internal.hbm

pack-priv Class ColumnSourceImpl

extends AbstractHbmSourceNode
implements ColumnSource
Class Inheritance
All Implemented Interfaces
org.hibernate.boot.model.source.spi.ColumnSource, org.hibernate.boot.model.source.spi.RelationalValueSource
Imports
java.util.Set, org.hibernate.boot.jaxb.hbm.spi.JaxbHbmColumnType, org.hibernate.boot.model.TruthValue, org.hibernate.boot.model.source.spi.ColumnSource, .JdbcDataType, .SizeSource
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final JaxbHbmColumnType
columnElement

private final Set<String>
indexConstraintNames

private final TruthValue
nullable

private final String
tableName

private final Set<String>
ukConstraintNames

Constructor Summary

AccessConstructor and Description
pack-priv
ColumnSourceImpl(MappingDocument mappingDocument, String tableName, JaxbHbmColumnType columnElement, Set<String> indexConstraintNames, Set<String> ukConstraintNames)

pack-priv
ColumnSourceImpl(MappingDocument mappingDocument, String tableName, JaxbHbmColumnType columnElement, TruthValue nullable, Set<String> indexConstraintNames, Set<String> ukConstraintNames)

Method Summary

Modifier and TypeMethod and Description
public String
getCheckCondition()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getCheckCondition.

Obtain the specified check constraint condition
public String
getComment()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getComment.

Obtain the specified SQL comment
public String
getContainingTableName()

Implements org.hibernate.boot.model.source.spi.RelationalValueSource.getContainingTableName.

public JdbcDataType
getDatatype()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getDatatype.

The deduced (and dialect convertible) type for this column
public String
getDefaultValue()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getDefaultValue.

Obtain a specified default value for the column
public Set<String>
getIndexConstraintNames()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getIndexConstraintNames.

public String
getName()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getName.

Obtain the name of the column.
public RelationalValueSource.Nature
getNature()

Implements org.hibernate.boot.model.source.spi.RelationalValueSource.getNature.

Retrieve the nature of this relational value.
public String
getReadFragment()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getReadFragment.

A SQL fragment to apply to the column value on read.
public SizeSource
getSizeSource()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getSizeSource.

Obtain the source for the specified column size.
public String
getSqlType()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getSqlType.

Obtain the free-hand definition of the column's type.
public Set<String>
getUniqueKeyConstraintNames()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getUniqueKeyConstraintNames.

public String
getWriteFragment()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getWriteFragment.

A SQL fragment to apply to the column value on write.
private static TruthValue
interpretNotNullToNullability(Boolean notNull)

public TruthValue
isNullable()

Implements org.hibernate.boot.model.source.spi.ColumnSource.isNullable.

Is this column nullable?
public boolean
isUnique()

Implements org.hibernate.boot.model.source.spi.ColumnSource.isUnique.

Is this column unique?
Inherited from org.hibernate.boot.model.source.internal.hbm.AbstractHbmSourceNode:
mappingRootmetadataBuildingContextoriginsourceMappingDocument

Field Detail

columnElementback to summary
private final JaxbHbmColumnType columnElement
indexConstraintNamesback to summary
private final Set<String> indexConstraintNames
nullableback to summary
private final TruthValue nullable
tableNameback to summary
private final String tableName
ukConstraintNamesback to summary
private final Set<String> ukConstraintNames

Constructor Detail

ColumnSourceImplback to summary
pack-priv ColumnSourceImpl(MappingDocument mappingDocument, String tableName, JaxbHbmColumnType columnElement, Set<String> indexConstraintNames, Set<String> ukConstraintNames)
ColumnSourceImplback to summary
pack-priv ColumnSourceImpl(MappingDocument mappingDocument, String tableName, JaxbHbmColumnType columnElement, TruthValue nullable, Set<String> indexConstraintNames, Set<String> ukConstraintNames)

Method Detail

getCheckConditionback to summary
public String getCheckCondition()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getCheckCondition.

Doc from org.hibernate.boot.model.source.spi.ColumnSource.getCheckCondition.

Obtain the specified check constraint condition

Returns:String

Check constraint condition

Annotations
@Override
getCommentback to summary
public String getComment()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getComment.

Doc from org.hibernate.boot.model.source.spi.ColumnSource.getComment.

Obtain the specified SQL comment

Returns:String

SQL comment

Annotations
@Override
getContainingTableNameback to summary
public String getContainingTableName()

Implements org.hibernate.boot.model.source.spi.RelationalValueSource.getContainingTableName.

Returns:String

Doc from org.hibernate.boot.model.source.spi.RelationalValueSource.getContainingTableName.

returns the name of the table that contains this value.

Annotations
@Override
getDatatypeback to summary
public JdbcDataType getDatatype()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getDatatype.

Doc from org.hibernate.boot.model.source.spi.ColumnSource.getDatatype.

The deduced (and dialect convertible) type for this column

Returns:JdbcDataType

The column's SQL data type.

Annotations
@Override
getDefaultValueback to summary
public String getDefaultValue()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getDefaultValue.

Doc from org.hibernate.boot.model.source.spi.ColumnSource.getDefaultValue.

Obtain a specified default value for the column

Returns:String

THe column default

Annotations
@Override
getIndexConstraintNamesback to summary
public Set<String> getIndexConstraintNames()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getIndexConstraintNames.

Annotations
@Override
getNameback to summary
public String getName()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getName.

Doc from org.hibernate.boot.model.source.spi.ColumnSource.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.

Annotations
@Override
getNatureback to summary
public RelationalValueSource.Nature getNature()

Implements org.hibernate.boot.model.source.spi.RelationalValueSource.getNature.

Doc from org.hibernate.boot.model.source.spi.RelationalValueSource.getNature.

Retrieve the nature of this relational value. Is it a column? Or is it a derived value (formula)?

Returns:RelationalValueSource.Nature

The nature.

Annotations
@Override
getReadFragmentback to summary
public String getReadFragment()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getReadFragment.

Doc from org.hibernate.boot.model.source.spi.ColumnSource.getReadFragment.

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

Returns:String

The SQL read fragment

Annotations
@Override
getSizeSourceback to summary
public SizeSource getSizeSource()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getSizeSource.

Doc from org.hibernate.boot.model.source.spi.ColumnSource.getSizeSource.

Obtain the source for the specified column size.

Returns:SizeSource

The source for the column size.

Annotations
@Override
getSqlTypeback to summary
public String getSqlType()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getSqlType.

Doc from org.hibernate.boot.model.source.spi.ColumnSource.getSqlType.

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

Returns:String

The free-hand column type

Annotations
@Override
getUniqueKeyConstraintNamesback to summary
public Set<String> getUniqueKeyConstraintNames()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getUniqueKeyConstraintNames.

Annotations
@Override
getWriteFragmentback to summary
public String getWriteFragment()

Implements org.hibernate.boot.model.source.spi.ColumnSource.getWriteFragment.

Doc from org.hibernate.boot.model.source.spi.ColumnSource.getWriteFragment.

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

Returns:String

The SQL write fragment

Annotations
@Override
interpretNotNullToNullabilityback to summary
private static TruthValue interpretNotNullToNullability(Boolean notNull)
isNullableback to summary
public TruthValue isNullable()

Implements org.hibernate.boot.model.source.spi.ColumnSource.isNullable.

Doc from org.hibernate.boot.model.source.spi.ColumnSource.isNullable.

Is this column nullable?

Returns:TruthValue

true indicates it is nullable; false non-nullable.

Annotations
@Override
isUniqueback to summary
public boolean isUnique()

Implements org.hibernate.boot.model.source.spi.ColumnSource.isUnique.

Doc from org.hibernate.boot.model.source.spi.ColumnSource.isUnique.

Is this column unique?

Returns:boolean

true indicates it is unique; false non-unique.

Annotations
@Override