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

Modifier and Type	Field and Description
private String	checkConstraint
private String	comment
private String	customRead
private String	customWrite
public static final int	DEFAULT_LENGTH
public static final int	DEFAULT_PRECISION
public static final int	DEFAULT_SCALE
private String	defaultValue
private int	length
private String	name
private boolean	nullable
private int	precision
private boolean	quoted
private int	scale
private String	sqlType
private Integer	sqlTypeCode
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 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. Deprecated as a consequence of `Table` being deprecated. Generate a column alias that is unique across multiple tables
public String	getCanonicalName()
public String	getCheckConstraint()
public String	getComment()
public String	getCustomRead()
public String	getCustomWrite()
public String	getDefaultValue()
public int	getLength()
public String	getName()
public int	getPrecision()
public String	getQuotedName() returns quoted name as it would be in the mapping file.
public String	getQuotedName(Dialect d)
public String	getReadExpr(Dialect dialect)
public int	getScale()
public String	getSqlType(Dialect dialect, Mapping mapping)
public String	getSqlType()
public int	getSqlTypeCode(Mapping mapping)
public Integer	Returns: sqlTypeCode if it is set, otherwise null. getSqlTypeCode() Returns the underlying columns SqlTypeCode.
public String	getTemplate(Dialect dialect, SQLFunctionRegistry functionRegistry) Implements org.hibernate.mapping.Selectable.getTemplate.
public String	getText(Dialect d) Implements org.hibernate.mapping.Selectable.getText.
public String	getText() Implements org.hibernate.mapping.Selectable.getText.
public int	getTypeIndex()
public Value	getValue()
public String	getWriteExpr()
public boolean	hasCheckConstraint()
public boolean	hasCustomRead()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	isFormula() Implements org.hibernate.mapping.Selectable.isFormula.
public boolean	isNullable()
public boolean	isQuoted()
public boolean	isUnique()
public void	setCheckConstraint(String checkConstraint)
public void	setComment(String comment)
public void	setCustomRead(String customRead)
public void	setCustomWrite(String customWrite)
public void	setDefaultValue(String defaultValue)
public void	setLength(int length)
public void	setName(String name)
public void	setNullable(boolean nullable)
public void	setPrecision(int scale)
public void	setScale(int scale)
public void	setSqlType(String sqlType)
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

checkConstraint	back to summary
private String checkConstraint

comment	back to summary
private String comment

customRead	back to summary
private String customRead

customWrite	back to summary
private String customWrite

DEFAULT_LENGTH	back to summary
public static final int DEFAULT_LENGTH

DEFAULT_PRECISION	back to summary
public static final int DEFAULT_PRECISION

DEFAULT_SCALE	back to summary
public static final int DEFAULT_SCALE

defaultValue	back to summary
private String defaultValue

length	back to summary
private int length

name	back to summary
private String name

nullable	back to summary
private boolean nullable

precision	back to summary
private int precision

quoted	back to summary
private boolean quoted

scale	back to summary
private int scale

sqlType	back to summary
private String sqlType

sqlTypeCode	back to summary
private Integer sqlTypeCode

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

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) Annotations @SuppressWarnings:SimplifiableIfStatement

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

getAlias	back to summary
public String getAlias(Dialect dialect, Table table) Implements org.hibernate.mapping.Selectable.getAlias. Deprecated as a consequence of `Table` being deprecated. See corresponding docs for further information. Generate a column alias that is unique across multiple tables Annotations @Override

public String getAlias(Dialect dialect, Table table)

Implements org.hibernate.mapping.Selectable.getAlias.

Deprecated

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

Generate a column alias that is unique across multiple tables

Annotations

@Override

getCanonicalName	back to summary
public String getCanonicalName()

getCheckConstraint	back to summary
public String getCheckConstraint()

getComment	back to summary
public String getComment()

getCustomRead	back to summary
public String getCustomRead()

getCustomWrite	back to summary
public String getCustomWrite()

getDefaultValue	back to summary
public String getDefaultValue()

getLength	back to summary
public int getLength()

getName	back to summary
public String getName()

getPrecision	back to summary
public int getPrecision()

getQuotedName	back to summary
public String getQuotedName() returns quoted name as it would be in the mapping file.

getQuotedName	back to summary
public String getQuotedName(Dialect d)

getReadExpr	back to summary
public String getReadExpr(Dialect dialect)

getScale	back to summary
public int getScale()

getSqlType	back to summary
public String getSqlType(Dialect dialect, Mapping mapping) throws HibernateException

getSqlType	back to summary
public String getSqlType()

getSqlTypeCode	back to summary
public int getSqlTypeCode(Mapping mapping) throws MappingException

getSqlTypeCode	back to summary
public Integer getSqlTypeCode() Returns the underlying columns SqlTypeCode. If null, it is because the SqlTypeCode is unknown. Use #getSqlTypeCode(Mapping) to retrieve the SqlTypeCode used for the columns associated Value/Type. Returns:Integer sqlTypeCode if it is set, otherwise null.

getSqlTypeCode

back to summary

public Integer getSqlTypeCode()

Returns the underlying columns SqlTypeCode. If null, it is because the SqlTypeCode is unknown.

Use #getSqlTypeCode(Mapping) to retrieve the SqlTypeCode used for the columns associated Value/Type.

Returns:Integer: sqlTypeCode if it is set, otherwise null.

getTemplate	back to summary
public String getTemplate(Dialect dialect, SQLFunctionRegistry functionRegistry) Implements org.hibernate.mapping.Selectable.getTemplate. Annotations @Override

getTemplate

back to summary

public String getTemplate(Dialect dialect, SQLFunctionRegistry functionRegistry)

Implements org.hibernate.mapping.Selectable.getTemplate.

Annotations

@Override

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

getText

back to summary

public String getText(Dialect d)

Implements org.hibernate.mapping.Selectable.getText.

Annotations

@Override

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

getText

back to summary

public String getText()

Implements org.hibernate.mapping.Selectable.getText.

Annotations

@Override

getTypeIndex	back to summary
public int getTypeIndex()

getValue	back to summary
public Value getValue()

getWriteExpr	back to summary
public String getWriteExpr()

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

isFormula

back to summary

public boolean isFormula()

Implements org.hibernate.mapping.Selectable.isFormula.

Annotations

@Override

isNullable	back to summary
public boolean isNullable()

isQuoted	back to summary
public boolean isQuoted()

isUnique	back to summary
public boolean isUnique()

setCheckConstraint	back to summary
public void setCheckConstraint(String checkConstraint)

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)

setLength	back to summary
public void setLength(int 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(int scale)

setScale	back to summary
public void setScale(int scale)

setSqlType	back to summary
public void setSqlType(String sqlType)

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