Top Description Fields Constructors Methods
org.hibernate.cfg

public Class Ejb3Column

extends Object
Class Inheritance
Known Direct Subclasses
org.hibernate.cfg.Ejb3DiscriminatorColumn, org.hibernate.cfg.Ejb3JoinColumn, org.hibernate.cfg.IndexColumn
Imports
java.util.Map, org.hibernate.AnnotationException, .AssertionFailure, org.hibernate.annotations.ColumnDefault, .ColumnTransformer, .ColumnTransformers, .Comment, .Index, org.hibernate.annotations.common.reflection.XProperty, org.hibernate.boot.model.naming.Identifier, .ImplicitBasicColumnNameSource, .ImplicitNamingStrategy, .ObjectNameNormalizer, .PhysicalNamingStrategy, org.hibernate.boot.model.relational.Database, org.hibernate.boot.model.source.spi.AttributePath, org.hibernate.boot.spi.MetadataBuildingContext, org.hibernate.cfg.annotations.Nullability, org.hibernate.internal.CoreMessageLogger, org.hibernate.internal.util.StringHelper, org.hibernate.mapping.Column, .Formula, .Join, .SimpleValue, .Table, org.jboss.logging.Logger

Wrap state of an EJB3 @Column annotation and build the Hibernate column mapping element
Author
Emmanuel Bernard

Field Summary

Modifier and TypeField and Description
private String
private MetadataBuildingContext
public static final int
private String
private String
private Formula
private String
private boolean
private boolean
protected Map<String, Join>
private int
private static final CoreMessageLogger
private String
private Column
private boolean
private int
protected PropertyHolder
private String
private String
private int
public String
private Table
table

Deprecated as a consequence of Table being deprecated.
private boolean
private boolean
private String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected void
public void
addIndex(Index index, boolean inSecondPass)

Deprecated as a consequence of Index being deprecated.
pack-priv void
addIndex(String indexName, boolean inSecondPass)

pack-priv void
addUniqueKey(String uniqueKeyName, boolean inSecondPass)

private static void
public void
bind()

public static Ejb3Column[]
buildColumnFromAnnotation(Column[] anns, Formula formulaAnn, Comment commentAnn, Nullability nullability, PropertyHolder propertyHolder, PropertyData inferredData, Map<String, Join> secondaryTables, MetadataBuildingContext context)

public static Ejb3Column[]
buildColumnFromAnnotation(Column[] anns, Formula formulaAnn, Comment commentAnn, Nullability nullability, PropertyHolder propertyHolder, PropertyData inferredData, String suffixForDefaultColumnName, Map<String, Join> secondaryTables, MetadataBuildingContext context)

private static Ejb3Column[]
buildImplicitColumn(PropertyData inferredData, String suffixForDefaultColumnName, Map<String, Join> secondaryTables, PropertyHolder propertyHolder, Comment comment, Nullability nullability, MetadataBuildingContext context)

public static void
checkPropertyConsistency(Ejb3Column[] columns, String propertyName)

private void
public void
protected MetadataBuildingContext
public String
public String
public String
public String
public Join
public int
public String
public Column
public String
public int
public PropertyHolder
public String
public int
public String
public Table

Returns:

appropriate table
getTable
()

Deprecated as a consequence of Table being deprecated.
Find appropriate table of the column.
protected void
initMappingColumn(String columnName, String propertyName, int length, int precision, int scale, boolean nullable, String sqlType, boolean unique, boolean applyNamingStrategy)

public boolean
public boolean
public boolean
public boolean
public boolean
public boolean
public boolean
public boolean
public void
private void
public void
redefineColumnName(String columnName, String propertyName, boolean applyNamingStrategy)

public void
public void
setComment(String comment)

public void
setDefaultValue(String defaultValue)

public void
setExplicitTableName(String explicitTableName)

public void
setFormula(String formula)

public void
setImplicit(boolean implicit)

public void
setInsertable(boolean insertable)

public void
public void
setLength(int length)

public void
setLogicalColumnName(String logicalColumnName)

protected void
setMappingColumn(Column mappingColumn)

public void
setNullable(boolean nullable)

public void
setPrecision(int precision)

public void
public void
setPropertyName(String propertyName)

public void
setScale(int scale)

public void
setSqlType(String sqlType)

public void
setTable(Table table)

Deprecated as a consequence of Table being deprecated.
public void
setUnique(boolean unique)

public void
setUpdatable(boolean updatable)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

commentback to summary
private String comment
contextback to summary
private MetadataBuildingContext context
DEFAULT_COLUMN_LENGTHback to summary
public static final int DEFAULT_COLUMN_LENGTH
defaultValueback to summary
private String defaultValue
explicitTableNameback to summary
private String explicitTableName
formulaback to summary
private Formula formula
formulaStringback to summary
private String formulaString
insertableback to summary
private boolean insertable
isImplicitback to summary
private boolean isImplicit
joinsback to summary
protected Map<String, Join> joins
lengthback to summary
private int length
LOGback to summary
private static final CoreMessageLogger LOG
logicalColumnNameback to summary
private String logicalColumnName
mappingColumnback to summary
private Column mappingColumn
nullableback to summary
private boolean nullable
precisionback to summary
private int precision
propertyHolderback to summary
protected PropertyHolder propertyHolder
propertyNameback to summary
private String propertyName
readExpressionback to summary
private String readExpression
scaleback to summary
private int scale
sqlTypeback to summary
public String sqlType
tableback to summary
private Table table

Deprecated

as a consequence of Table being deprecated. See corresponding docs for further information.

uniqueback to summary
private boolean unique
updatableback to summary
private boolean updatable
writeExpressionback to summary
private String writeExpression

Constructor Detail

Ejb3Columnback to summary
public Ejb3Column()

Method Detail

addColumnBindingback to summary
protected void addColumnBinding(SimpleValue value)
addIndexback to summary
public void addIndex(Index index, boolean inSecondPass)

Deprecated

as a consequence of Index being deprecated. See corresponding docs for further information.

addIndexback to summary
pack-priv void addIndex(String indexName, boolean inSecondPass)
addUniqueKeyback to summary
pack-priv void addUniqueKey(String uniqueKeyName, boolean inSecondPass)
applyColumnDefaultback to summary
private static void applyColumnDefault(Ejb3Column column, PropertyData inferredData)
bindback to summary
public void bind()
buildColumnFromAnnotationback to summary
public static Ejb3Column[] buildColumnFromAnnotation(Column[] anns, Formula formulaAnn, Comment commentAnn, Nullability nullability, PropertyHolder propertyHolder, PropertyData inferredData, Map<String, Join> secondaryTables, MetadataBuildingContext context)
buildColumnFromAnnotationback to summary
public static Ejb3Column[] buildColumnFromAnnotation(Column[] anns, Formula formulaAnn, Comment commentAnn, Nullability nullability, PropertyHolder propertyHolder, PropertyData inferredData, String suffixForDefaultColumnName, Map<String, Join> secondaryTables, MetadataBuildingContext context)
buildImplicitColumnback to summary
private static Ejb3Column[] buildImplicitColumn(PropertyData inferredData, String suffixForDefaultColumnName, Map<String, Join> secondaryTables, PropertyHolder propertyHolder, Comment comment, Nullability nullability, MetadataBuildingContext context)
checkPropertyConsistencyback to summary
public static void checkPropertyConsistency(Ejb3Column[] columns, String propertyName)
extractDataFromPropertyDataback to summary
private void extractDataFromPropertyData(PropertyData inferredData)
forceNotNullback to summary
public void forceNotNull()
getBuildingContextback to summary
protected MetadataBuildingContext getBuildingContext()
getCommentback to summary
public String getComment()
getDefaultValueback to summary
public String getDefaultValue()
getExplicitTableNameback to summary
public String getExplicitTableName()
Annotations
@SuppressWarnings:UnusedDeclaration
getFormulaStringback to summary
public String getFormulaString()
Annotations
@SuppressWarnings:UnusedDeclaration
getJoinback to summary
public Join getJoin()
getLengthback to summary
public int getLength()
getLogicalColumnNameback to summary
public String getLogicalColumnName()
getMappingColumnback to summary
public Column getMappingColumn()
getNameback to summary
public String getName()
getPrecisionback to summary
public int getPrecision()
getPropertyHolderback to summary
public PropertyHolder getPropertyHolder()
getPropertyNameback to summary
public String getPropertyName()
getScaleback to summary
public int getScale()
getSqlTypeback to summary
public String getSqlType()
getTableback to summary
public Table getTable()

Deprecated

as a consequence of Table being deprecated. See corresponding docs for further information.

Find appropriate table of the column. It can come from a secondary table or from the main table of the persistent class

Returns:Table

appropriate table

Exceptions
AnnotationException:
missing secondary table
initMappingColumnback to summary
protected void initMappingColumn(String columnName, String propertyName, int length, int precision, int scale, boolean nullable, String sqlType, boolean unique, boolean applyNamingStrategy)
isFormulaback to summary
public boolean isFormula()
isImplicitback to summary
public boolean isImplicit()
isInsertableback to summary
public boolean isInsertable()
isNameDeferredback to summary
public boolean isNameDeferred()
isNullableback to summary
public boolean isNullable()
isSecondaryback to summary
public boolean isSecondary()
isUniqueback to summary
public boolean isUnique()
isUpdatableback to summary
public boolean isUpdatable()
linkWithValueback to summary
public void linkWithValue(SimpleValue value)
processExpressionback to summary
private void processExpression(ColumnTransformer annotation)
redefineColumnNameback to summary
public void redefineColumnName(String columnName, String propertyName, boolean applyNamingStrategy)
setBuildingContextback to summary
public void setBuildingContext(MetadataBuildingContext context)
setCommentback to summary
public void setComment(String comment)
setDefaultValueback to summary
public void setDefaultValue(String defaultValue)
setExplicitTableNameback to summary
public void setExplicitTableName(String explicitTableName)
setFormulaback to summary
public void setFormula(String formula)
setImplicitback to summary
public void setImplicit(boolean implicit)
setInsertableback to summary
public void setInsertable(boolean insertable)
setJoinsback to summary
public void setJoins(Map<String, Join> joins)
setLengthback to summary
public void setLength(int length)
setLogicalColumnNameback to summary
public void setLogicalColumnName(String logicalColumnName)
setMappingColumnback to summary
protected void setMappingColumn(Column mappingColumn)
setNullableback to summary
public void setNullable(boolean nullable)
setPrecisionback to summary
public void setPrecision(int precision)
setPropertyHolderback to summary
public void setPropertyHolder(PropertyHolder propertyHolder)
setPropertyNameback to summary
public void setPropertyName(String propertyName)
setScaleback to summary
public void setScale(int scale)
setSqlTypeback to summary
public void setSqlType(String sqlType)
setTableback to summary
public void setTable(Table table)

Deprecated

as a consequence of Table being deprecated. See corresponding docs for further information.

setUniqueback to summary
public void setUnique(boolean unique)
setUpdatableback to summary
public void setUpdatable(boolean updatable)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override