Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.mapping.Column

Modifier and Type	Field and Description
private Integer	arrayLength
private String	assignmentExpression
private List<CheckConstraint>	checkConstraints
private String	collation
private Size	columnSize
private String	comment
private String	customRead
private String	customWrite
private String	defaultValue
private boolean	explicit
private String	generatedAs
private Long	length
private String	name
private boolean	nullable
private Integer	precision
private boolean	quoted
private Integer	scale
private Integer	sqlTypeCode
private Boolean	sqlTypeLob
private String	sqlTypeName
private int	typeIndex
private boolean	unique
pack-priv int	uniqueInteger
private Value	value

Access	Constructor and Description
public	Column()
public	Column(String columnName)

Method Summary

Modifier and Type	Method and Description
public void	addCheckConstraint(CheckConstraint checkConstraint)
pack-priv Size	calculateColumnSize(Dialect dialect, Mapping mapping) Deprecated as a consequence of `Mapping` being deprecated.
public String	checkConstraint() Deprecated since 6.2.
public Column	clone() Overrides java.lang.Object.clone. Shallow copy, the value is not copied
public boolean	equals(Object the reference object with which to compare. object) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public boolean	equals(Column column)
public String	getAlias(Dialect dialect) Implements org.hibernate.mapping.Selectable.getAlias.
public String	getAlias(Dialect dialect, Table table) Implements org.hibernate.mapping.Selectable.getAlias. Generate a column alias that is unique across multiple tables
public Integer	getArrayLength()
public String	getAssignmentExpression()
public String	getCanonicalName()
public String	getCheckConstraint() Deprecated since 6.2.
public List<CheckConstraint>	getCheckConstraints()
public String	getCollation()
public int	getColumnSize() Implements org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getColumnSize. The column size (length).
public Size	getColumnSize(Dialect dialect, Mapping mapping) Deprecated as a consequence of `Mapping` being deprecated.
public String	getComment()
public String	getCustomRead()
public String	getCustomReadExpression() Implements org.hibernate.mapping.Selectable.getCustomReadExpression. Any custom read expression for this selectable.
public String	getCustomWrite()
public String	getCustomWriteExpression() Implements org.hibernate.mapping.Selectable.getCustomWriteExpression. Any custom write expression for this selectable.
public int	getDecimalDigits() Implements org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getDecimalDigits. The precision, for numeric types
public String	getDefaultValue()
public String	getGeneratedAs()
public Long	getLength()
public String	getName()
public TruthValue	getNullable() Implements org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getNullable. Is the column nullable.
public Integer	getPrecision()
public String	Returns: the quoted name as it would occur in the mapping file getQuotedName()
public String	Returns: the quoted name using the quoting syntax of the given dialect getQuotedName(Dialect dialect)
public String	getReadExpr(Dialect dialect)
public Integer	getScale()
public String	getSqlType(Metadata mapping) Deprecated as a consequence of `Metadata` being deprecated.
public String	getSqlType(TypeConfiguration typeConfiguration, Dialect dialect, Mapping mapping) Deprecated since 6.2. use `getSqlType(Metadata)`
public String	getSqlType()
public int	getSqlTypeCode(Mapping mapping) Deprecated as a consequence of `Mapping` being deprecated.
public Integer	Returns: the type code, if it is set, otherwise null. getSqlTypeCode() Returns SQL type code for this column, or `null` if the type code is unknown.
private String	getSqlTypeName(DdlTypeRegistry ddlTypeRegistry, Dialect dialect, Mapping mapping) Deprecated as a consequence of `Mapping` being deprecated.
public String	getTemplate(Dialect dialect, TypeConfiguration typeConfiguration, SqmFunctionRegistry registry) Implements org.hibernate.mapping.Selectable.getTemplate.
public String	getText(Dialect dialect) Implements org.hibernate.mapping.Selectable.getText. The selectable's text representation accounting for the Dialect's quoting, if quoted
public String	getText() Implements org.hibernate.mapping.Selectable.getText. The selectable's "canonical" text representation
public int	getTypeCode() Implements org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getTypeCode. The JDBC type-code.
private Type	getTypeForComponentValue(Mapping mapping, Type type, int typeIndex) Deprecated as a consequence of `Mapping` being deprecated.
private Type	getTypeForEntityValue(Mapping mapping, Type type, int typeIndex) Deprecated as a consequence of `Mapping` being deprecated.
public int	getTypeIndex()
public String	getTypeName() Implements org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getTypeName. The database specific type name.
private static Type	getUnderlyingType(Mapping mapping, Type type, int typeIndex) Deprecated as a consequence of `Mapping` being deprecated.
public Value	getValue()
public String	getWriteExpr() Overrides default org.hibernate.mapping.Selectable.getWriteExpr.
public boolean	hasCheckConstraint()
public boolean	hasCustomRead()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
private static boolean	isCloseQuote(char ch)
public boolean	isExplicit()
public boolean	isFormula() Implements org.hibernate.mapping.Selectable.isFormula. Does this selectable represent a formula?
public boolean	isNullable()
private static boolean	isOpenQuote(char ch)
private static boolean	isQuoted(String name)
public boolean	isQuoted()
public boolean	isSqlTypeLob()
public boolean	isSqlTypeLob(Metadata mapping) Deprecated as a consequence of `Metadata` being deprecated.
public boolean	isUnique()
public void	setArrayLength(Integer arrayLength)
public void	setAssignmentExpression(String assignmentExpression)
public void	setCheckConstraint(String constraint) Deprecated since 6.2.
public void	setCollation(String collation)
public void	setComment(String comment)
public void	setCustomRead(String customRead)
public void	setCustomWrite(String customWrite)
public void	setDefaultValue(String defaultValue)
public void	setExplicit(boolean explicit)
public void	setGeneratedAs(String generatedAs)
public void	setLength(Long length)
public void	setLength(Integer length)
public void	setName(String name)
public void	setNullable(boolean nullable)
public void	setPrecision(Integer precision)
public void	setResolvedCustomRead(String customRead)
public void	setScale(Integer scale)
public void	setSqlType(String typeName)
public void	setSqlTypeCode(Integer typeCode)
public void	setTypeIndex(int typeIndex)
public void	setUnique(boolean unique)
public void	setValue(Value value)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

arrayLength	back to summary
private Integer arrayLength

assignmentExpression	back to summary
private String assignmentExpression

checkConstraints	back to summary
private List<CheckConstraint> checkConstraints

collation	back to summary
private String collation

columnSize	back to summary
private Size columnSize

comment	back to summary
private String comment

customRead	back to summary
private String customRead

customWrite	back to summary
private String customWrite

defaultValue	back to summary
private String defaultValue

explicit	back to summary
private boolean explicit

generatedAs	back to summary
private String generatedAs

length	back to summary
private Long length

name	back to summary
private String name

nullable	back to summary
private boolean nullable

precision	back to summary
private Integer precision

quoted	back to summary
private boolean quoted

scale	back to summary
private Integer scale

sqlTypeCode	back to summary
private Integer sqlTypeCode

sqlTypeLob	back to summary
private Boolean sqlTypeLob

sqlTypeName	back to summary
private String sqlTypeName

typeIndex	back to summary
private int typeIndex

unique	back to summary
private boolean unique

uniqueInteger	back to summary
pack-priv int uniqueInteger

value	back to summary
private Value value

Column	back to summary
public Column()

Column	back to summary
public Column(String columnName)

Method Detail

addCheckConstraint	back to summary
public void addCheckConstraint(CheckConstraint checkConstraint)

calculateColumnSize	back to summary
pack-priv Size calculateColumnSize(Dialect dialect, Mapping mapping) Deprecated as a consequence of `Mapping` being deprecated. See corresponding docs for further information.

checkConstraint	back to summary
public String checkConstraint() Deprecated since 6.2. Annotations @Deprecated since:6.2

clone	back to summary
public Column clone() Overrides java.lang.Object.clone. Shallow copy, the value is not copied Returns:Column Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

clone

back to summary

public Column clone()

Overrides java.lang.Object.clone.

Shallow copy, the value is not copied

Returns:Column

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters object:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object object)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

object:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

equals	back to summary
public boolean equals(Column column)

getAlias	back to summary
public String getAlias(Dialect dialect) Implements org.hibernate.mapping.Selectable.getAlias. Annotations @Override

getAlias

back to summary

public String getAlias(Dialect dialect)

Implements org.hibernate.mapping.Selectable.getAlias.

Annotations

@Override

getAlias	back to summary
public String getAlias(Dialect dialect, Table table) Implements org.hibernate.mapping.Selectable.getAlias. Generate a column alias that is unique across multiple tables Annotations @Override

getAlias

back to summary

public String getAlias(Dialect dialect, Table table)

Implements org.hibernate.mapping.Selectable.getAlias.

Generate a column alias that is unique across multiple tables

Annotations

@Override

getArrayLength	back to summary
public Integer getArrayLength()

getAssignmentExpression	back to summary
public String getAssignmentExpression()

getCanonicalName	back to summary
public String getCanonicalName()

getCheckConstraint	back to summary
public String getCheckConstraint() Deprecated since 6.2. Annotations @Deprecated since:6.2

getCheckConstraints	back to summary
public List<CheckConstraint> getCheckConstraints()

getCollation	back to summary
public String getCollation()

getColumnSize	back to summary
public int getColumnSize() Implements org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getColumnSize. Doc from org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getColumnSize. The column size (length). Returns:int The column length Annotations @Override

getColumnSize

back to summary

public int getColumnSize()

Implements org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getColumnSize.

Doc from org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getColumnSize.

The column size (length).

Returns:int

The column length

Annotations

@Override

getColumnSize	back to summary
public Size getColumnSize(Dialect dialect, Mapping mapping) Deprecated as a consequence of `Mapping` being deprecated. See corresponding docs for further information.

getComment	back to summary
public String getComment()

getCustomRead	back to summary
public String getCustomRead()

getCustomReadExpression	back to summary
public String getCustomReadExpression() Implements org.hibernate.mapping.Selectable.getCustomReadExpression. Doc from org.hibernate.mapping.Selectable.getCustomReadExpression. Any custom read expression for this selectable. Only pertinent for physical columns (not formulas) Annotations @Override

getCustomReadExpression

back to summary

public String getCustomReadExpression()

Implements org.hibernate.mapping.Selectable.getCustomReadExpression.

Doc from org.hibernate.mapping.Selectable.getCustomReadExpression.

Any custom read expression for this selectable. Only pertinent for physical columns (not formulas)

Annotations

@Override

getCustomWrite	back to summary
public String getCustomWrite()

getCustomWriteExpression	back to summary
public String getCustomWriteExpression() Implements org.hibernate.mapping.Selectable.getCustomWriteExpression. Doc from org.hibernate.mapping.Selectable.getCustomWriteExpression. Any custom write expression for this selectable. Only pertinent for physical columns (not formulas) Annotations @Override

getCustomWriteExpression

back to summary

public String getCustomWriteExpression()

Implements org.hibernate.mapping.Selectable.getCustomWriteExpression.

Doc from org.hibernate.mapping.Selectable.getCustomWriteExpression.

Any custom write expression for this selectable. Only pertinent for physical columns (not formulas)

Annotations

@Override

getDecimalDigits

back to summary

public int getDecimalDigits()

Implements org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getDecimalDigits.

Doc from org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getDecimalDigits.

The precision, for numeric types

Returns:int

The numeric precision

Annotations

@Override

getDefaultValue	back to summary
public String getDefaultValue()

getGeneratedAs	back to summary
public String getGeneratedAs()

getLength	back to summary
public Long getLength()

getName	back to summary
public String getName()

getNullable

back to summary

public TruthValue getNullable()

Implements org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getNullable.

Doc from org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getNullable.

Is the column nullable. The database is allowed to report unknown, hence the use of TruthValue

Returns:TruthValue

nullability.

Annotations

@Override

getPrecision	back to summary
public Integer getPrecision()

getQuotedName	back to summary
public String getQuotedName() Returns:String the quoted name as it would occur in the mapping file

getQuotedName	back to summary
public String getQuotedName(Dialect dialect) Returns:String the quoted name using the quoting syntax of the given dialect

getReadExpr	back to summary
public String getReadExpr(Dialect dialect)

getScale	back to summary
public Integer getScale()

getSqlType	back to summary
public String getSqlType(Metadata mapping) Deprecated as a consequence of `Metadata` being deprecated. See corresponding docs for further information.

getSqlType	back to summary
public String getSqlType(TypeConfiguration typeConfiguration, Dialect dialect, Mapping mapping) Deprecated since 6.2. use `getSqlType(Metadata)` Annotations @Deprecated since:6.2

getSqlType	back to summary
public String getSqlType()

getSqlTypeCode	back to summary
public int getSqlTypeCode(Mapping mapping) throws MappingException Deprecated as a consequence of `Mapping` being deprecated. See corresponding docs for further information.

getSqlTypeCode back to summary

public Integer getSqlTypeCode()

Returns SQL type code for this column, or null if the type code is unknown.

Use getSqlTypeCode(Mapping) to retrieve the type code using Value associated with the column.

Returns:Integer: the type code, if it is set, otherwise null.

getSqlTypeName	back to summary
private String getSqlTypeName(DdlTypeRegistry ddlTypeRegistry, Dialect dialect, Mapping mapping) Deprecated as a consequence of `Mapping` being deprecated. See corresponding docs for further information.

getTemplate

back to summary

public String getTemplate(Dialect dialect, TypeConfiguration typeConfiguration, SqmFunctionRegistry registry)

Implements org.hibernate.mapping.Selectable.getTemplate.

Annotations

@Override

getText

back to summary

public String getText(Dialect dialect)

Implements org.hibernate.mapping.Selectable.getText.

Doc from org.hibernate.mapping.Selectable.getText.

The selectable's text representation accounting for the Dialect's quoting, if quoted

Annotations

@Override

getText

back to summary

public String getText()

Implements org.hibernate.mapping.Selectable.getText.

Doc from org.hibernate.mapping.Selectable.getText.

The selectable's "canonical" text representation

Annotations

@Override

getTypeCode

back to summary

public int getTypeCode()

Implements org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getTypeCode.

Doc from org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getTypeCode.

The JDBC type-code.

Returns:int

JDBC type-code

Annotations

@Override

getTypeForComponentValue	back to summary
private Type getTypeForComponentValue(Mapping mapping, Type type, int typeIndex) Deprecated as a consequence of `Mapping` being deprecated. See corresponding docs for further information.

getTypeForEntityValue	back to summary
private Type getTypeForEntityValue(Mapping mapping, Type type, int typeIndex) Deprecated as a consequence of `Mapping` being deprecated. See corresponding docs for further information.

getTypeIndex	back to summary
public int getTypeIndex()

getTypeName

back to summary

public String getTypeName()

Implements org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getTypeName.

Doc from org.hibernate.tool.schema.extract.spi.ColumnTypeInformation.getTypeName.

The database specific type name.

Returns:String

Type name

Annotations

@Override

getUnderlyingType	back to summary
private static Type getUnderlyingType(Mapping mapping, Type type, int typeIndex) Deprecated as a consequence of `Mapping` being deprecated. See corresponding docs for further information.

getValue	back to summary
public Value getValue()

getWriteExpr

back to summary

public String getWriteExpr()

Overrides default org.hibernate.mapping.Selectable.getWriteExpr.

Annotations

@Override

hasCheckConstraint	back to summary
public boolean hasCheckConstraint()

hasCustomRead	back to summary
public boolean hasCustomRead()

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isCloseQuote	back to summary
private static boolean isCloseQuote(char ch)

isExplicit	back to summary
public boolean isExplicit()

isFormula back to summary

public boolean isFormula()

Implements org.hibernate.mapping.Selectable.isFormula.

Doc from org.hibernate.mapping.Selectable.isFormula.

Does this selectable represent a formula? true indicates it is a formula; false indicates it is a physical column

Annotations

@Override

isNullable	back to summary
public boolean isNullable()

isOpenQuote	back to summary
private static boolean isOpenQuote(char ch)

isQuoted	back to summary
private static boolean isQuoted(String name)

isQuoted	back to summary
public boolean isQuoted()

isSqlTypeLob	back to summary
public boolean isSqlTypeLob()

isSqlTypeLob	back to summary
public boolean isSqlTypeLob(Metadata mapping) Deprecated as a consequence of `Metadata` being deprecated. See corresponding docs for further information.

isUnique	back to summary
public boolean isUnique()

setArrayLength	back to summary
public void setArrayLength(Integer arrayLength)

setAssignmentExpression	back to summary
public void setAssignmentExpression(String assignmentExpression)

setCheckConstraint	back to summary
public void setCheckConstraint(String constraint) Deprecated since 6.2. Annotations @Deprecated since:6.2

setCollation	back to summary
public void setCollation(String collation)

setComment	back to summary
public void setComment(String comment)

setCustomRead	back to summary
public void setCustomRead(String customRead)

setCustomWrite	back to summary
public void setCustomWrite(String customWrite)

setDefaultValue	back to summary
public void setDefaultValue(String defaultValue)

setExplicit	back to summary
public void setExplicit(boolean explicit)

setGeneratedAs	back to summary
public void setGeneratedAs(String generatedAs)

setLength	back to summary
public void setLength(Long length)

setLength	back to summary
public void setLength(Integer length)

setName	back to summary
public void setName(String name)

setNullable	back to summary
public void setNullable(boolean nullable)

setPrecision	back to summary
public void setPrecision(Integer precision)

setResolvedCustomRead	back to summary
public void setResolvedCustomRead(String customRead)

setScale	back to summary
public void setScale(Integer scale)

setSqlType	back to summary
public void setSqlType(String typeName)

setSqlTypeCode	back to summary
public void setSqlTypeCode(Integer typeCode)

setTypeIndex	back to summary
public void setTypeIndex(int typeIndex)

setUnique	back to summary
public void setUnique(boolean unique)

setValue	back to summary
public void setValue(Value value)

toString

back 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

public Class Column

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail